Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 1.81 KB

DEVELOP.md

File metadata and controls

42 lines (33 loc) · 1.81 KB

Development notes

Getting started

Building package

# Run all tests on multiple Python versions (3.8 to 3.13)
hatch run test:all

# Run single test on specific Python version
hatch env run -e test -i py=310 pytest tests/test_datasets.py

# Build
hatch build

GitHub Actions

Tests and releases are automated using GitHub Actions.

  • test.yml: Test CI
    • This CI runs when new pushes and pull requests are made in main branch.
    • It runs tests in different Python versions using hatch.
  • release.yml: Release CI
    • To make a new release, manually trigger this GitHub Actions. Click on the "Run Workflow" button and enter the new version name.
    • This CI includes following steps:
      • Updates version in __about__.py and commits to the main branch.
      • Tags the commit and makes a release in GitHub
      • Builds and publishes to PyPI

conda-forge

  • Once a release is pubslihed to PyPI, a bot (@regro-cf-autotick-bot) will automatically detect the new version and publishes it to conda-forge. This could take some time (few hours).
  • Recipe is available at conda-forge/tailestim-feedstock.

Documentation

The documentation website is generated by Sphinx, and hosted on ReadTheDocs. To have a development preview locally, run:

cd docs
make html

The builds will be saved at docs/_build/html/.