federation/README.md

2.4 KiB

pipeline status codecov.io issue tracker

PyPI version Documentation Status PyPI PyPI

federation

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

Introduction

The aim of federation is to provide and abstract multiple social web protocols like ActivityPub and Diaspora 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 two 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.

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