Skip to main content

Minimal inplementation of ActivityPub Interface

Project description

Minimal-ActivityPub

Repo CI Downloads uv_secure gitleaks pysentry complexipy Codestyle Version Wheel License: AGPL-3.0-or-later

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minimal_activitypub-2.1.0.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minimal_activitypub-2.1.0-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file minimal_activitypub-2.1.0.tar.gz.

File metadata

  • Download URL: minimal_activitypub-2.1.0.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for minimal_activitypub-2.1.0.tar.gz
Algorithm Hash digest
SHA256 c3225a4c9f25f0db9d6c0cfc2f6747c6ecc2f453a2c8822ea5504a94463d49da
MD5 9e4d2307f815f5d74ab364e74f271acc
BLAKE2b-256 5a05211bce7b9da46a1aaa0ef04074210c016fb4fd1ebeb4722380d56d396222

See more details on using hashes here.

File details

Details for the file minimal_activitypub-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: minimal_activitypub-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for minimal_activitypub-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2c9177eb14120a060d393d9f6c861c44038c829347f3274ff2c27d73d6e82461
MD5 e61e210e3afa31f9ea0c055e0e337b2c
BLAKE2b-256 7a42d3796fedac9ae4b437664147c1bb9935c0c218ba98c581f47e4829a6618a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page