cattle_grid
cattle_grid handles a few common tasks that plague Fediverse applications:
- Maintaining an actor document and associated endpoints like inbox
- Verifying HTTP signatures
- Determine if somebody is authorized to view something or not
- Manage follower collections
Furthermore with its muck_out extension it handles parsing ActivityPub objects.
cattle_grid relies on faststream and then RabbitMQ for message processing. If you want to use cattle_grid, you will be faced with using message queues.
cattle_grid has an internal account system.
Related links
Applications using cattle_grid
- comments allows one to add comments to a static site
- fedi-herds allows list management
- roboherd allows one to build automatic posting bots (these have no frontend)
Related projects / utilities
- almabtrieb implements one of the Client protocols used by cattle_grid
- console provides a light weight frontend.
Development
Testing
You can run the pytest tests via
uv run pytest
or in watch mode
uv run ptw .
Running behave tests
Build the container via
./update_docker.sh
This script uses the requirements from pyproject.toml via uv export to install
python dependencies in the container. This means this script needs to be rerun, if
you make changes to the dependencies. Startup the docker environment via
docker compose up
Open a runner container
docker compose run --rm --name runner cattle_grid_app /bin/sh
Inside this container, you now run
fediverse-features
behave
The first step downloads some features from fediverse-features and the second step runs the test suite.
Building end 2 end reports (as done by CI)
The process to build the end to end reports is described here. The reports should be published to this repository and then made available here.
Running as stand alone
Create a requirements.txt file and start a virgin docker container
uv export --no-editable --no-emit-project --no-hashes --no-dev > requirements.txt
docker run --rm -ti -p 8000:8000\
-v ./cattle_grid:/app/cattle_grid\
-v ./requirements.txt:/app/requirements.txt \
--workdir /app\
helgekr/bovine:python3.13 /bin/sh
Once inside the docker container install dependencies
pip intall -r requirements.txt
and run cattle_grid via
uvicorn cattle_grid:create_app --factory --host 0.0.0.0
This currently fails.
1 maintainer
Metadata
1 maintainer
Release files for cattle_grid 0.5.22
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cattle_grid-0.5.22.tar.gz | 472.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cattle_grid-0.5.22-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 727.6 kB
Release files / cattle_grid-0.5.22.tar.gz
| Download URL | cattle_grid-0.5.22.tar.gz |
|---|---|
| Size | 472.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
69e6cf3257b3d72ff98f7559f85f775d7e64532cdd36b3b470bc4af8b755a926
|
|
BLAKE2b-256 checksum How to use checksums |
725e3a79c60bb65818405aabc140c6ce3bea8eb3ea5001eeb4419624827c83de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Alpine Linux","version":"3.23.3","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / cattle_grid-0.5.22-py3-none-any.whl
| Download URL | cattle_grid-0.5.22-py3-none-any.whl |
|---|---|
| Size | 254.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cdda61bcfb644c09c7d4d1c1fd8637fd0167bf5730f37d730fe2e8c653c03232
|
|
BLAKE2b-256 checksum How to use checksums |
00603faad4d3789994745da95fb492abd819058b50908c802fe5970e24bf6797
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Alpine Linux","version":"3.23.3","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
