Skip to content

Contributing

Issues and pull requests are more than welcome: github.com/developmentseed/eoAPI/issues

You can also start Discussions in github.com/developmentseed/eoAPI/discussions

dev install

# Download the code
git clone https://github.com/developmentseed/eoAPI.git
cd eoAPI

# Create a virtual environment
python -m pip install --upgrade virtualenv
virtualenv .venv
source .venv/bin/activate

# Install the eoapi module
python -m pip install "psycopg[binary,pool]"
python -m pip install -e runtime/eoapi/raster["test"] # or -e runtime/eoapi/stac["test"]  | -e runtime/eoapi/vector["test"]

Danger

Python applications might have incompatible dependencies, which you can resolve by using a virtual environment per application

pre-commit

This repo is set to use pre-commit to run isort, ruff, pydocstring, black ("uncompromising Python code formatter") and mypy when committing new code.

$ pre-commit install

Open Source

You can also contribute indirectly to eoAPI by helping on the sub-modules: