federation/README.md

[![PyPI version](https://badge.fury.io/py/social-federation.svg)](https://pypi.python.org/pypi/Social-Federation) [![Build Status](https://travis-ci.org/jaywink/social-federation.svg?branch=master)](https://travis-ci.org/jaywink/social-federation) [![codecov.io](https://codecov.io/github/jaywink/social-federation/coverage.svg?branch=master)](https://codecov.io/github/jaywink/social-federation?branch=master) [![Code Health](https://landscape.io/github/jaywink/social-federation/master/landscape.svg?style=flat)](https://landscape.io/github/jaywink/social-federation/master) [![Requirements Status](https://requires.io/github/jaywink/social-federation/requirements.svg?branch=master)](https://requires.io/github/jaywink/social-federation/requirements/?branch=master) [![PyPI downloads](https://img.shields.io/pypi/dm/Social-Federation.svg)](https://pypi.python.org/pypi/Social-Federation) [![Stories in Ready](https://badge.waffle.io/jaywink/social-federation.png?label=ready&title=Ready)](https://waffle.io/jaywink/social-federation)

# Social-Federation

Python library to abstract social federation protocols. Currently supports a subset of the Diaspora protocol with full support intended, and additional protocols after that.

## Requirements

* Python 3.x

## Development

Install requirements first:

    pip install -r dev-requirements.txt
    
### Running tests

    py.test

### Building local docs

    cd docs
    make html

## License

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