Warning

This project is archived and no longer maintained.

Please migrate to longwei — the successor project. Documentation: https://marvinsmastodontools.codeberg.page/longwei/latest/

Minimal-ActivityPub

Minimal-ActivityPub is a minimal Python implementation of the ActivityPub REST API used by Mastodon, Pleroma, and Takahe. This implementation makes use of asyncio where appropriate. It is intended to be used as a library by other applications. No standalone functionality is provided.

Minimal refers to the fact that only API calls I need for my other projects Fedinesia, Lemmy2Fedi and Tootbot are implemented.

DO NOT expect a full or complete implementation of all ActivityPub API functionality.

Version 2.0.0 Notice

Version 2.0.0 should be backwards compatible with 1.x. The major version bump reflects a significant internal refactor: the single client_2_server.py file (~1,100 lines) has been split into focused mixin modules, and constants, exceptions, utilities, and types have been moved to their own modules. No public API changes were made. The major version was chosen out of caution — if you encounter any regressions, please open an issue.

For more details have a look at the Documentation.

Contributing

Issues and pull requests are welcome.

Minimal-ActivityPub is using pre-commit for code quality checks and uv for dependency management. Please install and use both pre-commit and uv if you'd like to contribute.

Documentation

The documentation is built using MkDocs with the Material theme.

Building Documentation Locally

# Install documentation dependencies (using the docs group from pyproject.toml)
uv sync --group docs

# Build documentation
mkdocs build

# Serve documentation locally
mkdocs serve

Documentation Structure

• docs/ - Markdown source files
• mkdocs.yml - MkDocs configuration

Development

This project uses uv for dependency management and virtual environments. To set up the development environment:

# Create and activate virtual environment
uv venv
source .venv/bin/activate

# Install all dependencies including development and documentation groups
uv sync --all-groups

# Run tests
uv run nox

For more details on the development workflow, check the noxfile.py and .woodpecker/ configuration files.

Licensing

Minimal-ActivityPub is licenced with the GNU Affero General Public License v3.0

Supporting Minimal-ActivityPub

There are a number of ways you can support Minimal-ActivityPub:

• Create an issue with problems or ideas you have with/for Minimal-ActivityPub
• You can buy me a coffee.
• You can send me small change in Monero to the address below:

Monero donation address

8ADQkCya3orL178dADn4bnKuF1JuVGEG97HPRgmXgmZ2cZFSkWU9M2v7BssEGeTRNN2V5p6bSyHa83nrdu1XffDX3cnjKVu