The core for the Couchbase Agent Catalog project.
To enable debug mode, execute the following command:
export AGENT_CATALOG_DEBUG=1
To set up pre-commit
and reap all the benefits of code formatting, linting, automatic poetry
lock generation, etc...
execute the following command:
pip install pre-commit
pre-commit install
Below, we list out some notes that developers might find useful w.r.t. Poetry:
- Before committing, always use
poetry update; poetry lock
! This will check if the dependencies laid out in thepyproject.toml
file are satisfiable and will repopulate the lock file appropriately. poetry install
vs.poetry update
: in the presence of apoetry.lock
file (which we do have), the former will only consider installing packages specified in the lock file. The latter (poetry update
) will read from thepyproject.toml
file and try to resolve dependencies from there.- Because these are a collection of libraries, we will not commit individual lock files for each sub-package. Do not
commit
poetry.lock
files.