Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jaywink/federation

Python library for abstracting social federation protocols
https://github.com/jaywink/federation

activitypub diaspora federation matrix protocol python-library social

Last synced: about 1 month ago
JSON representation

Python library for abstracting social federation protocols

Host: GitHub
URL: https://github.com/jaywink/federation
Owner: jaywink
License: bsd-3-clause
Created: 2015-07-01T13:01:20.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2024-02-29T00:58:05.000Z (7 months ago)
Last Synced: 2024-04-13T21:01:13.720Z (5 months ago)
Topics: activitypub, diaspora, federation, matrix, protocol, python-library, social
Language: Python
Homepage: https://gitlab.com/jaywink/federation
Size: 1.34 MB
Stars: 113
Watchers: 17
Forks: 10
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

README

        [![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