Skip to main content

Python client library for ActivityPub-compatible servers

Project description

longwei

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

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

All targeted Mastodon v1/v2 API endpoints are now implemented, covering accounts, timelines, statuses, notifications, lists, filters, polls, reports, discovery, and instance management. Admin, push notification, and proof endpoints are intentionally out of scope. Longwei is used by Fedinesia, Feed2Fedi, and FenLiu and Zhongli.

Quick start

pip install longwei
import asyncio
from longwei import APClient

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

asyncio.run(main())

API References

Status

longwei is a fork of minimal_activitypub. It is not a drop-in replacement. See the Upgrading guide for full migration instructions.

longwei 2.0 introduced additional breaking changes: the client= parameter has been removed from APClient and all auth methods, and the underlying HTTP library has changed from httpx to httpx2. See the upgrade guide for details.

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

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

longwei-2.0.0.tar.gz (46.4 kB view details)

Uploaded Source

Built Distribution

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

longwei-2.0.0-py3-none-any.whl (59.3 kB view details)

Uploaded Python 3

File details

Details for the file longwei-2.0.0.tar.gz.

File metadata

  • Download URL: longwei-2.0.0.tar.gz
  • Upload date:
  • Size: 46.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","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 longwei-2.0.0.tar.gz
Algorithm Hash digest
SHA256 cf048745b5449ecb7c7ab890343eb14fb57b12a718bb48f6c235519f0834caec
MD5 57c975cc7579aef3757bcd41da5a2e19
BLAKE2b-256 95c8ea30637fda6d20dbf366602d320fd00d967ae538d9e4dcb2a2b443a9ec75

See more details on using hashes here.

File details

Details for the file longwei-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: longwei-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 59.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","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 longwei-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0e7e227549212a119e77609b4d73edff9768960c07e3cfa1ff709faa47e1f035
MD5 09832aab799acafa509a173b1ded9b6f
BLAKE2b-256 4344beed71a5ea9481560e86e21bfb521ae92d23d4f2ca68d4f9c2e055550f66

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