Installing project dependencies
Note: The process varies depending on your choice of code editor / IDE, so refer to one of the following guides:
The following will use the SeasonalBot repository as an example, but the steps are the same for all other repositories. You should have already cloned your fork as described in Cloning a Repository.
Installing dependencies with PyCharm
- Load up your project in PyCharm.
- Go to the Project Settings by clicking
File
, thenSettings...
. Alternatively, use the shortcut keyCtrl+Alt+S
. - Navigate to
Project Interpreter
, then click the gear icon and clickAdd
.
- In the popup window, click
Pipenv Environment
, make sureInstall packages from Pipfile
is checked, then clickOK
.
- PyCharm will automatically install the packages required into a virtual environment.
Installing dependencies with the command line
- Make sure you are in the project directory.
- Install project and development dependencies:
$ pipenv sync --dev
- Remember to also set up pre-commit hooks to ensure your pushed commits will never fail linting:
$ pipenv run precommit