Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rowanlupton/pylodon

Flask-based ActivityPub server
https://github.com/rowanlupton/pylodon

activipy activitypub activitystreams federated federation flask flask-login flask-pymongo flask-restful jinja2 mastodon-social-network mongodb python3 webfinger

Last synced: about 2 months ago
JSON representation

Flask-based ActivityPub server

Host: GitHub
URL: https://github.com/rowanlupton/pylodon
Owner: rowanlupton
License: mit
Created: 2017-04-17T21:42:33.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2018-08-28T23:51:57.000Z (about 6 years ago)
Last Synced: 2024-04-13T13:51:11.400Z (5 months ago)
Topics: activipy, activitypub, activitystreams, federated, federation, flask, flask-login, flask-pymongo, flask-restful, jinja2, mastodon-social-network, mongodb, python3, webfinger
Language: Python
Homepage:
Size: 31 MB
Stars: 97
Watchers: 17
Forks: 14
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-activitypub - pylodon - Flask-based ActivityPub server implementation. (Implementations)

README

        # pylodon

[![Join the chat at https://gitter.im/pylodon/Lobby](https://badges.gitter.im/pylodon/Lobby.svg)](https://gitter.im/pylodon/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

![pylodon](docs/pylodon.png)

*image courtesy of [@banjofox](https://dev.glitch.social/@banjofox)*

## Setup

Create a virtualenv (e.g. `virtualenv -p python3 venv`), activate it (e.g. `. venv/bin/activate`), and then `pip install -r requirements.txt`. *(Make sure it's a Python3 environment; some of our dependencies require it.)*

Create an account with [MongoDB's cloud service](https://www.mongodb.com/cloud/atlas); it's free for a very small cluster. Set up an admin user with a separate password, create an IP whitelist and connect to the database cluster to make sure it's working. I use a blanket whitelist, and Atlas complains at me every time. (Install `mongodb` to your machine, with Homebrew, for example.)

Docs:

* [MongoDB Atlas docs: Getting Started](https://docs.atlas.mongodb.com/getting-started/)

## Config

Update `config.py` wherever the information looks inadequate (e.g. anything that says .rowan.website should have your own domain).

Create a `.env` file (or otherwise configure environment variables), based off of the included `.env.example`. This is conveniently loaded in by python-dotenv.

For local development, you probably want to leave SSLify disabled (`STRICT_HTTPS` in `config.py`), to access the server over HTTP rather than HTTPS. The `STRICT_HEADERS` config variable is also disabled by default, so that you don't have to worry about content headers to debug the API server.

## Run it!

```

$ . venv/bin/activate

$ gunicorn run:app

```