Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Update CONTRIBUTING.md Poetry dev install #1357

Merged
merged 8 commits into from
Oct 6, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,20 @@ Please come join us on our [Slack](https://join.slack.com/t/neuralprophet/shared

## Process
If this is your first time contributing to NeuralProphet, please read our [wiki summary](https://github.com/ourownstory/neural_prophet/wiki#contributing-process) of the steps involved.
## Dev Install

## Dev Install using Poetry
Prerequisite: [install poetry](https://python-poetry.org/docs/#installing-with-the-official-installer).
* Start by cloning the repo with `git clone <copied link from github>`.
* Make sure you have changed directories to your cloned neuralprophet github `cd neural_prophet`. There, run `poetry shell` to (create and) start a (new) poetry virtual environment. If you run `poetry env info --path` you should see the path to the venv.
* To complete the venv setup, install neuralprophet (in editable mode by default) with `poetry install`.
Note: poetry will automatically use the specific dependencies in the `poetry.lock` file for reproducibility. If you want to install the latest dependencies instead, run `poetry update`. This will update all dependencies and update the `poetry.lock` file. Be mindful to not track the `poetry.lock` file with git when commiting, unless the purpose of your pull request is to update it.

Warning, you are still lacking some git hooks to auto-format your code pre-commit and to run pytests pre-push.
Currently these need to be self-added. Simplified instructions to follow.

[Tutorial Link](https://realpython.com/dependency-management-python-poetry/)

## Dev Install (old)
Before starting it's a good idea to first create and activate a new virtual environment:
```
python3 -m venv <path-to-new-env>
Expand Down
Loading