federation/README.md

[![pipeline status](https://gitlab.com/jaywink/federation/badges/master/pipeline.svg)](https://gitlab.com/jaywink/federation) [![issue tracker](https://img.shields.io/badge/issue%20tracker-gitlab-orange.svg)](https://gitlab.com/jaywink/federation/-/issues)

[![PyPI version](https://badge.fury.io/py/federation.svg)](https://pypi.python.org/pypi/federation)  [![Documentation Status](http://readthedocs.org/projects/federation/badge/?version=latest)](http://federation.readthedocs.io/en/latest/?badge=latest) [![PyPI](https://img.shields.io/pypi/pyversions/federation.svg?maxAge=2592000)](https://pypi.python.org/pypi/federation) [![PyPI](https://img.shields.io/pypi/l/federation.svg?maxAge=2592000)](https://pypi.python.org/pypi/federation)

# federation

Python library to abstract social web federation protocols like ActivityPub, Diaspora and Matrix.

## Introduction

The aim of `federation` is to provide and abstract multiple social web protocols like 
ActivityPub, Diaspora and Matrix in one package, over an easy to use and understand Python API. 
This way applications can be built to (almost) transparently support many protocols 
without the app builder having to know everything about those protocols.

![](./docs/_static/generic_diagram.png)

## Status

Currently, three protocols are being focused on.

* Diaspora is considered to be stable with most of the protocol implemented.
* ActivityPub is considered to be stable with working federation with most ActivityPub platforms.
* Matrix support is in early phase and not to be considered useful yet.

The code base is well tested and in use in several projects. Backward incompatible changes 
will be clearly documented in changelog entries.

## Additional information

### Installation and requirements

See [installation documentation](http://federation.readthedocs.io/en/latest/install.html).

### Usage and API documentation

See [usage documentation](http://federation.readthedocs.io/en/latest/usage.html).

### Support and help

See [development and support documentation](http://federation.readthedocs.io/en/latest/development.html).

### License

[BSD 3-clause license](https://www.tldrlegal.com/l/bsd3)

### Author

Jason Robinson / https://jasonrobinson.me / https://gitlab.com/jaywink / https://github.com/jaywink
Feneas GitLab -> GitLab.com updates 2022-06-04 23:50:09 +00:00			`[![pipeline status](https://gitlab.com/jaywink/federation/badges/master/pipeline.svg)](https://gitlab.com/jaywink/federation) [![issue tracker](https://img.shields.io/badge/issue%20tracker-gitlab-orange.svg)](https://gitlab.com/jaywink/federation/-/issues)`
Add docs link to readme (and some mooor badges <3) 2016-10-03 20:10:14 +00:00
Adjust badges Remove PyPi downloads which doesn't seem to track pip installs, so useless. Replace Requires.io with Gemnasium. 2016-10-09 11:53:45 +00:00			`[![PyPI version](https://badge.fury.io/py/federation.svg)](https://pypi.python.org/pypi/federation) [![Documentation Status](http://readthedocs.org/projects/federation/badge/?version=latest)](http://federation.readthedocs.io/en/latest/?badge=latest) [![PyPI](https://img.shields.io/pypi/pyversions/federation.svg?maxAge=2592000)](https://pypi.python.org/pypi/federation) [![PyPI](https://img.shields.io/pypi/l/federation.svg?maxAge=2592000)](https://pypi.python.org/pypi/federation)`
Initial commit Note, nothing working here, just WIP... 2015-07-01 13:00:39 +00:00
Add IRC chat badge 2017-05-14 13:00:59 +00:00			`# federation`
Add Gitter badge 2017-04-08 08:03:47 +00:00
Update some docs and add words about Matrix 2020-12-21 20:06:00 +00:00			`Python library to abstract social web federation protocols like ActivityPub, Diaspora and Matrix.`
Add travis config 2016-04-03 11:57:46 +00:00
Add docs link to readme (and some mooor badges <3) 2016-10-03 20:10:14 +00:00			`## Introduction`
Add travis config 2016-04-03 11:57:46 +00:00
Some clarifications for the docs and readme 2019-10-05 22:57:24 +00:00			The aim of `federation` is to provide and abstract multiple social web protocols like
Update some docs and add words about Matrix 2020-12-21 20:06:00 +00:00			`ActivityPub, Diaspora and Matrix in one package, over an easy to use and understand Python API.`
Some clarifications for the docs and readme 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.`
Initial commit Note, nothing working here, just WIP... 2015-07-01 13:00:39 +00:00
Update some docs and add words about Matrix 2020-12-21 20:06:00 +00:00			`![](./docs/_static/generic_diagram.png)`
Init documentation Closes #34 2016-10-02 10:08:37 +00:00
Improve docs and unify with readme 2016-10-04 18:31:51 +00:00			`## Status`
Initial commit Note, nothing working here, just WIP... 2015-07-01 13:00:39 +00:00
Update some docs and add words about Matrix 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.`
Update readme note on AP stabiity and setup.py Python versions 2023-02-08 10:24:49 +00:00			`* ActivityPub is considered to be stable with working federation with most ActivityPub platforms.`
			`* Matrix support is in early phase and not to be considered useful yet.`
Add docs link to readme (and some mooor badges <3) 2016-10-03 20:10:14 +00:00
Some clarifications for the docs and readme 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.`
Improve docs and unify with readme 2016-10-04 18:31:51 +00:00
			`## Additional information`

			`### Installation and requirements`

Rename library to federation Less typing saves lives. 2016-10-04 19:07:24 +00:00			`See [installation documentation](http://federation.readthedocs.io/en/latest/install.html).`
Improve docs and unify with readme 2016-10-04 18:31:51 +00:00
			`### Usage and API documentation`

Rename library to federation Less typing saves lives. 2016-10-04 19:07:24 +00:00			`See [usage documentation](http://federation.readthedocs.io/en/latest/usage.html).`
Improve docs and unify with readme 2016-10-04 18:31:51 +00:00
			`### Support and help`

Rename library to federation Less typing saves lives. 2016-10-04 19:07:24 +00:00			`See [development and support documentation](http://federation.readthedocs.io/en/latest/development.html).`
Improve docs and unify with readme 2016-10-04 18:31:51 +00:00
			`### License`

			`[BSD 3-clause license](https://www.tldrlegal.com/l/bsd3)`

			`### Author`
Add docs link to readme (and some mooor badges <3) 2016-10-03 20:10:14 +00:00
Feneas GitLab -> GitLab.com updates 2022-06-04 23:50:09 +00:00			`Jason Robinson / https://jasonrobinson.me / https://gitlab.com/jaywink / https://github.com/jaywink`