This guide assumes you have some knowledge of ActivityPub.
[TOC]
Microblog.pub is a “modern” Python application with “old-school” server-rendered templates.
The server has 3 components:
The project uses Invoke to manage tasks (a Python powered Makefile).
You can find the tasks definition in tasks.py and list the tasks using:
inv -l
The uploads are stored in the data/ directory, using a simple content-addressed storage system (file contents hash is BLOB filename).
Files metadata are stored in the database.
Running a local version requires:
You can follow the Python developer version of the install instructions.
The documention is managed as Markdown files in docs/ and the online documentation is built using a homegrown Python script (scripts/build_docs.py).
You can build the documentation locally by running:
inv build-docs
And check out the result by starting a static server using Python standard library:
cd docs/dist
python -m http.server 8001
Contributions/patches are welcome, but please start a discussion in a ticket or a thread in the mailing list before working on anything consequent.
Please ensure your code passes the code quality checks:
inv autoformat
inv lint
And that the tests suite is passing:
inv tests
Please also consider adding new test cases if needed.