Python library to abstract social web federation protocols like ActivityPub, Diaspora and Matrix.
 
 
Go to file
Jason Robinson aeb1b37e2c Update some docs and add words about Matrix 2020-12-21 22:06:00 +02:00
.github Update FUNDING.yml 2019-05-31 20:47:59 +00:00
docs Update some docs and add words about Matrix 2020-12-21 22:06:00 +02:00
federation Update some docs and add words about Matrix 2020-12-21 22:06:00 +02:00
.coveragerc Add tox and gitlab CI 2018-07-23 19:15:34 +03:00
.gitignore
.gitlab-ci.yml Support and test on python 3.8 2020-12-20 02:51:00 +02:00
CHANGELOG.md Add Matrix utility function to register users on Dendrite 2020-12-21 22:05:43 +02:00
LICENSE.txt
MANIFEST.in
README.md Update some docs and add words about Matrix 2020-12-21 22:06:00 +02:00
dev-requirements.txt Add twine to dev requirements 2019-10-06 02:04:48 +03:00
pytest.ini Move test settings and utils for Django to tests root 2018-09-29 12:12:34 +03:00
setup.cfg
setup.py Remove the network utils `fetch_host_ip_and_country` and `fetch_country_by_ip` 2020-12-20 02:59:17 +02:00
tox.ini Fix python version in tox 2020-12-20 03:31:09 +02:00

README.md

pipeline status codecov.io issue tracker

PyPI version Documentation Status PyPI PyPI

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.

Status

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.

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.

Usage and API documentation

See usage documentation.

Support and help

See development and support documentation.

License

BSD 3-clause license

Author

Jason Robinson / https://jasonrobinson.me / https://git.feneas.org/jaywink / https://github.com/jaywink