2019-05-18 21:32:28 +00:00
|
|
|
[](https://git.feneas.org/jaywink/federation/commits/master) [](https://codecov.io/github/jaywink/federation?branch=master) [](https://git.feneas.org/jaywink/federation/issues)
|
2016-10-03 20:10:14 +00:00
|
|
|
|
2016-10-09 11:53:45 +00:00
|
|
|
[](https://pypi.python.org/pypi/federation) [](http://federation.readthedocs.io/en/latest/?badge=latest) [](https://pypi.python.org/pypi/federation) [](https://pypi.python.org/pypi/federation)
|
2015-07-01 13:00:39 +00:00
|
|
|
|
2017-05-14 13:00:59 +00:00
|
|
|
# federation
|
2017-04-08 08:03:47 +00:00
|
|
|
|
2020-12-21 20:06:00 +00:00
|
|
|
Python library to abstract social web federation protocols like ActivityPub, Diaspora and Matrix.
|
2016-04-03 11:57:46 +00:00
|
|
|
|
2016-10-03 20:10:14 +00:00
|
|
|
## Introduction
|
2016-04-03 11:57:46 +00:00
|
|
|
|
2019-10-05 22:57:24 +00:00
|
|
|
The aim of `federation` is to provide and abstract multiple social web protocols like
|
2020-12-21 20:06:00 +00:00
|
|
|
ActivityPub, Diaspora and Matrix in one package, over an easy to use and understand Python API.
|
2019-10-05 22:57:24 +00:00
|
|
|
This way applications can be built to (almost) transparently support many protocols
|
|
|
|
|
without the app builder having to know everything about those protocols.
|
2015-07-01 13:00:39 +00:00
|
|
|
|
2020-12-21 20:06:00 +00:00
|
|
|
|
2016-10-02 10:08:37 +00:00
|
|
|
|
2016-10-04 18:31:51 +00:00
|
|
|
## Status
|
2015-07-01 13:00:39 +00:00
|
|
|
|
2020-12-21 20:06:00 +00:00
|
|
|
Currently, three protocols are being focused on.
|
|
|
|
|
|
|
|
|
|
* Diaspora is considered to be stable with most of the protocol implemented.
|
|
|
|
|
* ActivityPub support should be considered as alpha - all the basic
|
|
|
|
|
things work but there are likely to be a lot of compatibility issues with other ActivityPub
|
|
|
|
|
implementations.
|
|
|
|
|
* Matrix support cannot be considered usable yet.
|
2016-10-03 20:10:14 +00:00
|
|
|
|
2019-10-05 22:57:24 +00:00
|
|
|
The code base is well tested and in use in several projects. Backward incompatible changes
|
|
|
|
|
will be clearly documented in changelog entries.
|
2016-10-04 18:31:51 +00:00
|
|
|
|
|
|
|
|
## Additional information
|
|
|
|
|
|
|
|
|
|
### Installation and requirements
|
|
|
|
|
|
2016-10-04 19:07:24 +00:00
|
|
|
See [installation documentation](http://federation.readthedocs.io/en/latest/install.html).
|
2016-10-04 18:31:51 +00:00
|
|
|
|
|
|
|
|
### Usage and API documentation
|
|
|
|
|
|
2016-10-04 19:07:24 +00:00
|
|
|
See [usage documentation](http://federation.readthedocs.io/en/latest/usage.html).
|
2016-10-04 18:31:51 +00:00
|
|
|
|
|
|
|
|
### Support and help
|
|
|
|
|
|
2016-10-04 19:07:24 +00:00
|
|
|
See [development and support documentation](http://federation.readthedocs.io/en/latest/development.html).
|
2016-10-04 18:31:51 +00:00
|
|
|
|
|
|
|
|
### License
|
|
|
|
|
|
|
|
|
|
[BSD 3-clause license](https://www.tldrlegal.com/l/bsd3)
|
|
|
|
|
|
|
|
|
|
### Author
|
2016-10-03 20:10:14 +00:00
|
|
|
|
2018-09-30 17:47:52 +00:00
|
|
|
Jason Robinson / https://jasonrobinson.me / https://git.feneas.org/jaywink / https://github.com/jaywink
|
