From 29e46df0376a4329933ca35968369ec1affae449 Mon Sep 17 00:00:00 2001 From: Amrou Date: Sat, 25 Feb 2023 00:51:17 +0100 Subject: add guide to install a specific dependency group with poetry This sets up the stage to install the needed bootstrapping script dependencies --- .../installing-project-dependencies.md | 24 ++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md index 26d6de30..862f0add 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md @@ -39,3 +39,27 @@ $ poetry run task precommit ![PyCharm Poetry Environment](/static/images/content/contributing/pycharm_poetry.png)
6. PyCharm will automatically install the packages required into a virtual environment.
![PyCharm Project Interpreter](/static/images/content/contributing/pycharm_poetry_success.png) + + +## Installing specific dependency groups + +In some cases, like when you'll be using the configuration bootstrapping script, you might need to install extra dependencies that are +not necessary for the bot project to function. +These dependency are put in a separate optional group likewise: + +```text +[tool.poetry.group.group-name] +... +[tool.poetry.group.group-name.dependencies] +pytest = "^6.0.0" +pytest-mock = "*" +``` + +To install them, you simply need to run the following command +--- + +```shell +$ poetry install --only {{group-name}} +``` + +--- \ No newline at end of file -- cgit v1.2.3