Update the README

pull/1/head
Thomas Sileo 2018-06-13 21:54:46 +02:00
rodzic daa41e6d17
commit 0c880eac35
1 zmienionych plików z 24 dodań i 0 usunięć

Wyświetl plik

@ -3,11 +3,28 @@
<a href="https://travis-ci.org/tsileo/little-boxes"><img src="https://travis-ci.org/tsileo/little-boxes.svg?branch=master" alt="Build Status"></a>
<img src="https://img.shields.io/pypi/pyversions/little-boxes.svg" />
<a href="https://github.com/tsileo/little-boxes/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-ISC-red.svg?style=flat" alt="License"></a>
<a href="https://github.com/ambv/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
Tiny [ActivityPub](https://activitypub.rocks/) framework written in Python, both database and server agnostic.
**Still in early development, and not published on PyPI yet.**
## Features
- Database and server agnostic
- You need to implement a backend that respond to activiy side-effects
- This also need you're responsible for serving the activities/collections and receiving them
- ActivityStreams helper classes
- with Outbox/Inbox abstractions
- Content helper using Mardown
- with helpers for parsing hashtags and linkify content
- Key (RSA) helper
- HTTP signature helper
- JSON-LD signature helper
- Webfinger helper
## Getting Started
```python
@ -42,12 +59,19 @@ follow = ap.Follow(actor=me, object='http://iri-i-want-follow')
outbox.post(follow)
```
## Projects using Little Boxes
- [microblog.pub](http://github.com/tsileo/microblog.pub) (using MongoDB as a backend)
## Contributions
TODO: document Mypy, flake8 and black.
PRs are welcome, please open an issue to start a discussion before your start any work.
## License
ISC, see the LICENSE file.