From e957cdfd2766f34140f9abc48280d1aba53267fc Mon Sep 17 00:00:00 2001 From: Chris Date: Mon, 17 May 2021 20:21:06 +0100 Subject: Update project dep guide to only reference poetry --- .../contributing/installing-project-dependencies.md | 20 +++++++------------- .../images/content/contributing/pycharm_pipenv.png | Bin 18513 -> 0 bytes .../content/contributing/pycharm_pipenv_success.png | Bin 27705 -> 0 bytes .../images/content/contributing/pycharm_poetry.png | Bin 0 -> 21396 bytes .../content/contributing/pycharm_poetry_success.png | Bin 0 -> 27819 bytes 5 files changed, 7 insertions(+), 13 deletions(-) delete mode 100644 pydis_site/static/images/content/contributing/pycharm_pipenv.png delete mode 100644 pydis_site/static/images/content/contributing/pycharm_pipenv_success.png create mode 100644 pydis_site/static/images/content/contributing/pycharm_poetry.png create mode 100644 pydis_site/static/images/content/contributing/pycharm_poetry_success.png 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 ba5b3d1b..653b71aa 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 @@ -17,13 +17,13 @@ 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` (`command+comma` on Mac OS). -3. Install the [poetry plugin](https://plugins.jetbrains.com/plugin/14307-poetry). (**Note:** This is not required for the site) -4. Navigate to `Project Interpreter`, then click the gear icon and click `Add`. -![PyCharm Interpreter Settings](/static/images/content/contributing/pycharm_interpreter.png) -5. If installing dependencies for the site, click `Pipenv Environment`, otherwise, click `Poetry Environment`, then click `OK`. -![PyCharm Pipenv Environment](/static/images/content/contributing/pycharm_pipenv.png) -6. PyCharm will automatically install the packages required into a virtual environment. -![PyCharm Project Interpreter](/static/images/content/contributing/pycharm_pipenv_success.png) +3. Install the [poetry plugin](https://plugins.jetbrains.com/plugin/14307-poetry). +4. Navigate to `Project Interpreter`, then click the gear icon and click `Add`.
+![PyCharm Interpreter Settings](/static/images/content/contributing/pycharm_interpreter.png)
+5. Click `Poetry Environment`, then click `OK`.
+![PyCharm Pipenv 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) --- @@ -32,13 +32,7 @@ You should have already cloned your fork as described in [**Cloning a Repository 2. Install project and development dependencies. Remember to also set up pre-commit hooks to ensure your pushed commits will never fail linting. --- -- Site: -```shell -$ pipenv sync --dev -$ pipenv run precommit -``` -- Other projects: ```shell $ poetry install $ poetry run task precommit diff --git a/pydis_site/static/images/content/contributing/pycharm_pipenv.png b/pydis_site/static/images/content/contributing/pycharm_pipenv.png deleted file mode 100644 index 5d6620ee..00000000 Binary files a/pydis_site/static/images/content/contributing/pycharm_pipenv.png and /dev/null differ diff --git a/pydis_site/static/images/content/contributing/pycharm_pipenv_success.png b/pydis_site/static/images/content/contributing/pycharm_pipenv_success.png deleted file mode 100644 index 65ac2040..00000000 Binary files a/pydis_site/static/images/content/contributing/pycharm_pipenv_success.png and /dev/null differ diff --git a/pydis_site/static/images/content/contributing/pycharm_poetry.png b/pydis_site/static/images/content/contributing/pycharm_poetry.png new file mode 100644 index 00000000..cb5402b0 Binary files /dev/null and b/pydis_site/static/images/content/contributing/pycharm_poetry.png differ diff --git a/pydis_site/static/images/content/contributing/pycharm_poetry_success.png b/pydis_site/static/images/content/contributing/pycharm_poetry_success.png new file mode 100644 index 00000000..31d44a69 Binary files /dev/null and b/pydis_site/static/images/content/contributing/pycharm_poetry_success.png differ -- cgit v1.2.3