Contributions are always welcome! Bugs and feature requests can be opened in the Issues. Questions and comments can be posted in the Discussions. To contribute code, please open an issue to discuss implementation, then follow the guide below to get started!
eeprepr uses Hatch for package and environment management. To set up a development environment, first fork and clone eerepr, then install hatch in your environment.
pip install hatch
This will install all required dependencies for development. You can enter the environment using:
hatch shell
and exit by typing quit or CTRL + D.
Pre-commit hooks automatically run linting, formatting, and type-checking whenever a change is commited. This ensures that the codebase is always in good shape.
The command below registers the pre-commit hooks for the project so that they run before every commit.
hatch run pre-commit install
To run all the checks manually, you can use:
hatch run pre-commit run --all-files
You can run all tests with pytest using the command below:
hatch run test:all
To measure test coverage, run:
hatch run test:cov
Additional arguments can be passed to pytest after the script name, e.g.:
hatch run test:all -k feature
Rendered HTML is tested using pytest-regressions, which compares the current HTML output for each object to the previously recorded output. Tests will fail if the HTML output changes. If the change is correct (i.e. an update to the HTML formatting or a difference in object representations in Earth Engine), use the --force-regen argument to regenerate a new "reference" HTML output.
Tests that rely on server-side data via getInfo are slow, so eerepr uses a mocked getInfo method for all tests. When getInfo is run on a new object, the value is computed server-side and stored in the local cache file (tests/data/.cache.json). A warning is thrown to alert you. Subsequent calls to getInfo with the same object (based on its serialized form) will return data from the cache instead of Earth Engine servers. If the cache somehow becomes stale, i.e. the value returned by Earth Engine changes, you can manually delete the cache file and re-run tests to regenerate it. Caches are kept locally and are not version-controlled.
When a new object is added to regression testing, the first run will fail and generate a new reference file. Subsequent tests will pass. Output from regression testing is version controlled, so new outputs should be committed.
Running the command below renders an HTML repr with a variety of different EE objects and opens it in the default web browser. Use this to visually compare results with outputs from the Code Editor.
hatch run test:html