longwei 1.0.0

Python client library for ActivityPub-compatible servers

longwei

Longwei is a minimal Python implementation of the ActivityPub client REST API used by Mastodon, Pleroma, and GotoSocial. 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.

So far Longwei only implements the ActivityPub API calls I need for my other projects Fedinesia, Feed2Fedi, FenLiu and Zhongli.

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

Quick start

pip install longwei

import asyncio
import httpx
from longwei import APClient

async def main():
    async with httpx.AsyncClient() as client:
        ap = await APClient.create(
            instance="mastodon.social",
            client=client,
            access_token="your_token",
        )
        status = await ap.post_status("Hello, fediverse!")
        print(status.url)

asyncio.run(main())

API References

• Mastodon API
• Pleroma API
• GotoSocial API

Status

longwei is a fork of minimal_activitypub. The main breaking change from that package is the class rename: ActivityPub → APClient. See the Upgrading guide for migration instructions.

It is not a drop-in replacement. I advise not to use this until at least version 1.0.0 (non-dev).

Contributing

Issues and pull requests are welcome.

longwei 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 live documentation is at https://marvinsmastodontools.codeberg.page/longwei/latest/

Built with MkDocs and the Material theme. To build and serve locally:

uv sync --group docs
mkdocs serve

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

longwei is licenced with the GNU Affero General Public License v3.0

Supporting longwei

There are a number of ways you can support longwei:

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

Monero donation address

8ADQkCya3orL178dADn4bnKuF1JuVGEG97HPRgmXgmZ2cZFSkWU9M2v7BssEGeTRNN2V5p6bSyHa83nrdu1XffDX3cnjKVu