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, 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

Status

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

It is not a drop-in replacement. See the upgrading guide for migration instructions.

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-1.3.0.tar.gz (25.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-1.3.0-py3-none-any.whl (32.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: longwei-1.3.0.tar.gz
  • Upload date:
  • Size: 25.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","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-1.3.0.tar.gz
Algorithm Hash digest
SHA256 1507cbcfb921997eef359270f4b934b3c86932d30cb4ac5a77955c1dc1fe7b19
MD5 d6ce3383321e47be48314194a62d508e
BLAKE2b-256 91acbff824443bc9caa7818882fa51cea3983b6d69b59d8f7201d2e9b3476b0d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: longwei-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 32.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","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-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b7676da9a0e5423b6e62cd1ea110963295f52f8479523c074c36cd332a9ce33b
MD5 f8433ed2acd1d720a54d956e6a265800
BLAKE2b-256 7f2cb1c799b89e84fa6d63fb4d2ed10ebfc0d3391c182570c5d441b557f9821c

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