Dev Notes

This package uses a Skeleton.

It Utilizes:

• Sphinx documentation.

  • Local build docs with make html in docs folder. First make clean to regenerate toctrees.

  • ReadTheDocs should rebuild automatically on git push.

• versioningit version single-sourcing in pyproject.toml.

  • Versions are set by the git tags (or commit number if dirty).

  • On python -m build versioningit sets correct version in project metadata based on git data.

  • On import xhorizon a __version__ parameter is obtained using importlib.metadata.

• APIdoc to auto-generate API reference.

  • Must manually run sphinx-apidoc to generate sphinx autodoc files. Automated by apidoc-rebuild.bat.

  • Only need to regenerate when structure changes, not every update, because generates autodoc files.

To Develop:

• Clone from Github.

• Build and local install with python -m build then pip install -e . in root folder.

• Edit local source.

• Access local version from anywhere with import xhorizon in test scripts.

• (Only need to rebuild if you want to update version metadata.)

• Commit and push changes to remote as usual.

To Distribute:

• Set version with git tag, git push, git push --tags.

• Clear dist folder of old versions.

• Build with python -m build in root folder.

• Upload with python -m twine upload dist/* in root folder.

• To test, pip install xhorizon from appropriate repo inside a venv.