Gencove Python API and CLI
pip install gencove
Main documentation can be found here: http://docs.gencove.com
Have some form of virtualization, for instance pyenv for 3.7.x and a virtualenv.
Install in editing mode:
pip install -e .
Install local requirements:
pip install -r requirements.txt
Install pre-commit hooks:
Use with local api service (need to have back_api2 running)
gencove <command> --host http://localhost:8200
or use with development version of deployed API service
gencove <command> --host https://api-dev.gencove-dev.com
Before pushing run:
This will run tests, black formatter and linters.
To run only a specific job from tox (i.e. only the tests for python 3.7 using API key):
tox -e py37-api_key
If you need to interact with the API (for instance to record new VCR cassettes) you need to set up environment variables, this way, the tests will have the credentials to have access.
In order to do that, just run
cp gencove/tests/.env.dist gencove/tests/.env and change the desired values from the
For more details, read internal
CLI testing document.
To create docs:
cd docs && make html
- Check for the current version by running
- Make a new branch titled version/X-Y-Z
version-01-upgrade.shin that branch with an argument
- Create a merge request to master
- Once it is merged, create a merge request of master to prod