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

  1. Load up your project in PyCharm.
  2. Go to the Project Settings by clicking File, then Settings.... Alternatively, use the shortcut key Ctrl+Alt+S.
  3. Navigate to Project Interpreter, then click the gear icon and click Add.
    pycharm_interpreter
  4. In the popup window, click Pipenv Environment, make sure Install packages from Pipfile is checked, then click OK.
    pycharm_pipenv
  5. PyCharm will automatically install the packages required into a virtual environment.
    pycharm_pipenv_success

Installing dependencies with the command line

  1. Make sure you are in the project directory.
  2. 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