Contribute to Ergo core¶
To get started:
git clone https://github.com/oughtinc/ergo.git
poetry install
poetry shell
poetry
¶
Ergo uses poetry to manage its dependencies and environments.
Follow these directions to install poetry if you don’t already have it.
Troubleshooting: If you get Could not find a version that satisfies the requirement jaxlib ...
after using poetry to install, this is probably because your virtual environment has old version of pip due to how poetry choses pip versions.
Try:
poetry run pip install -U pip
poetry install
again
Before submitting a PR¶
Run
poetry install
to make sure you have the latest dependenciesFormat code using
make format
(black, isort)Run linting using
make lint
(flake8, mypy, black check)Run tests using
make test
To run the tests in
test_metaculus.py
, you’ll need our secret .env file. If you don’t have it, you can ask us for it, or rely on Travis CI to run those tests for you.
Generate docs using
make docs
, loaddocs/build/html/index.html
and review the generated docsOr run all of the above using
make all