Forge Friends Format

Python implementation for the Friendly Forge Format, published here.

Setup

git clone --recursive https://lab.forgefriends.org/friendlyforgeformat/f3-documentation.git
cd f3-documentation
echo layout python3 > .envrc
direnv allow
pip install poetry
poetry install

Build the documentation

Head to the doc directory and use:

poetry run make livehtml
# or 
poetry run make html

Fetch schemas updates

git submodule foreach git pull origin main

Upgrade from f3wikidatabot

Change the version in pyproject.toml.

poetry update f3wikidatabot

Update from Wikidata

python bot.py
git add doc/src/forges.md
git commit -m 'Update from wikidata'

Publish a release

F3 complies with semantic versioning.

• Update doc/conf.py for a MINOR or MAJOR release, not for a PATCH release
• Push the tag vX.Y.Z on
  • JSON Schemas https://lab.forgefriends.org/friendlyforgeformat/f3-schemas
  • Go reference implementation https://lab.forgefriends.org/friendlyforgeformat/gof3
  • Specifications https://lab.forgefriends.org/friendlyforgeformat/f3-documentation

Sphinx json schema

https://sphinx-jsonschema.readthedocs.io/en/latest/schemakeywords.html

License

This project is licensed under the AGPLv3+ License.