0
Fork 0
mirror of https://github.com/uber/h3-py.git synced 2026-11-16 07:44:46 +00:00
h3-py/dev_notes.md
AJ Friend 9a7d6dfd6f
v4.5a (alpha version) (#483)
* bump h3lib to unreleased a9c0a2e (cellsToMultiPolygon)

* initial changes

* move around dependencies

* update CI

* ci separation

* h3.pc.in

* clean up .gitignore

* changelog

* better changelog

* add cellsToMultiPolygon to h3-py in separate release

* sdist exclude and coverage for version test

* warn that changing some justfile rules will affect CI

* try to silence some CI warnings

* one more warning
2026-02-26 14:12:54 -08:00

1.7 KiB

Development notes for h3-py

Install for development

This repo uses just for running common development commands.

To get started:

  • git clone git@github.com:uber/h3-py.git
  • cd h3-py
  • just lint
  • just test
  • just test-cython

To build and view docs:

  • just docs
  • just view

Docstrings

Updating the H3 submodule

cd src/h3lib
git checkout master
git pull
cd ..
git add h3lib
git commit ...

for a specific version tag:

cd src/h3lib
git checkout v3.7.1  # or whatever version tag you'd like
cd ..
git add h3lib
git commit ...

Resetting the submodule

For when moving between h3-py branches using different versions of the h3lib submodule.

git submodule deinit -f .
git submodule update --init

Releasing a new version

  • update CHANGELOG.md to reflect any changes since the last release
  • update the h3-py version in pyproject.toml
  • if updating the C h3lib version, update the version badge on the readme
  • create PR, get reviews, and merge with these changes
  • go to https://github.com/uber/h3-py/releases and "Draft a new release"
    • set the tag version and the release to the version. e.g., v3.7.2 (alternatively: git tag v3.7.2 && git push origin --tags)
    • add the updated CHANGELOG.md text to the release notes
    • publish release
  • GitHub actions should trigger on the release event and then go on to build and upload the wheels to PyPI