Supports Python 3.7 and later.

Install poetry per the instructions at https://python-poetry.org/docs/

poetry install

This will install dev and library dependencies.

Install pre-commit globally to get access to the pre-commit hooks:

pip install pre-commit
pre-commit install

After setting up the dev environment using the commands above, you can run the linter by executing

poetry run flake8 ./xrpl

poetry run nox -rs tests

Integration tests are expensive and often flaky. As a result, they don't run by default with the above command. You'll need to currently run integration tests manually for each package like so:

poetry run python -m unittest discover tests.integration.transactions

or

poetry run python -m unittest discover tests.integration.reliable_submission

From the docs folder,

poetry run sphinx-apidoc -o source/ ../xrpl
poetry run make html

Sphinx generated docs will be in docs/_build.