Installation

Regular install

pip install fwl-io

The distribution and the command are named fwl-io; the Python import is fwl_io, since Python does not allow hyphens in module names.

Requires Python 3.11 or newer. The runtime dependencies are pooch and requests.

Development install

git clone https://github.com/FormingWorlds/fwl-io.git
cd fwl-io
pip install -e ".[develop]"

Run the checks:

pytest -m "unit or smoke"       # fast tier, no network
pytest                          # full suite; uses a local test server only
ruff check src tests && ruff format --check src tests

The test suite never contacts external services; download logic is exercised against a local HTTP server.

Documentation build

pip install -e ".[docs]"
zensical serve        # local preview
zensical build --clean