README.md for Interoperability Data

This repository represents interoperability data and the tools to generate it for the Fediverse.

Website

The website is generated from the data using tools found in work. Getting a development version running can be achieved via

cd work
uv sync -U
./build_docs.sh
uv run mkdocs serve

All commands will take some time.

Data

Data is contained in data. The subsections describe how it is generated

Running tests

By executing

./run.sh $APPLICATION $VERSION

you can generate the support tables. The data file will be in data/. The available versions for the applications can be found here.

Log files are stored in the logs directory with the name $APPLICATION. If the directory fediverse-pasture does not exist, the fediverse-pasture is downloaded automatically.

Manually running

By executing

./run_manual.sh $APPLICATION $VERSION

you can drop into a shell in the work container. Usually, one then executes the run_for.sh script. To manually run tests, one needs to

• install the appropriate version of the python package fediverse-pasture-inputs.
• Run the command python -mrunner $APPLICATION.
• To leave the shell use CTRL+D (and not CTRL+C) to ensure the docker compose containers are shut down.

Further options of runner can be discovered by passing the --help flag.

New version of fediverse-pasture-inputs

On a new release of fediverse-pasture-inputs update INPUTS_VERSION in run.sh to the latest release. Then see the comment in run_update.sh and add the run_all flag. Following this, run

./run_update.sh