aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Hassan Abouelela <[email protected]>2021-05-16 19:08:39 +0300
committerGravatar Hassan Abouelela <[email protected]>2021-05-16 19:08:39 +0300
commit636281d27df0113ea5e2be3c1ad7d9d77cd28271 (patch)
treeed85ae1dc1827edd68fb99407404fe0430720556
parentFixes Broken Images In Dependency Guide (diff)
Migrates Sir Lancebot And Python To Poetry
Updates the Python and Sir Lancebot guides to use poetry. Updates the dependency guide to include poetry, and explain when each dependency manager should be used.
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md8
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md14
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md8
3 files changed, 18 insertions, 12 deletions
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md
index 9e0f323a..741bf28e 100644
--- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md
+++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md
@@ -6,9 +6,9 @@ toc: 1
---
# Requirements
-* [Python 3.8](https://www.python.org/downloads/)
-* [Pipenv](https://github.com/pypa/pipenv#installation)
- * `pip install pipenv`
+* [Python 3.9](https://www.python.org/downloads/)
+* [Poetry](https://github.com/python-poetry/poetry#installation)
+ * `pip install poetry`
* [Git](https://git-scm.com/downloads)
* [Windows](https://git-scm.com/download/win)
* [MacOS](https://git-scm.com/download/mac) or `brew install git`
@@ -181,7 +181,7 @@ Running on the host is particularly useful if you wish to debug the bot.
The site has to have been started somehow beforehand.
```shell
-pipenv run start
+poetry run task start
```
---
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 7881c07d..ba5b3d1b 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
@@ -28,12 +28,18 @@ You should have already cloned your fork as described in [**Cloning a Repository
---
## Installing dependencies with the command line
-1. Make sure you are in the project directory.
-2. Install project and development dependencies:
+1. Make sure you are in the root project directory. This directory will always have a file titled `README.md`.
+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
```
-* Remember to also set up pre-commit hooks to ensure your pushed commits will never fail linting:
+
+- Other projects:
```shell
-$ pipenv run precommit
+$ poetry install
+$ poetry run task precommit
```
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md
index 4ff98095..601cfa4a 100644
--- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md
+++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md
@@ -9,8 +9,8 @@ toc: 1
---
# Requirements
-- [Python 3.8](https://www.python.org/downloads/)
-- [Pipenv](https://github.com/pypa/pipenv/blob/master/docs/install.rst#-installing-pipenv)
+- [Python 3.9](https://www.python.org/downloads/)
+- [Poetry](https://github.com/python-poetry/poetry#installation)
- [Git](https://git-scm.com/downloads)
- [Windows Installer](https://git-scm.com/download/win)
- [MacOS Installer](https://git-scm.com/download/mac) or `brew install git`
@@ -101,10 +101,10 @@ If you get any Docker related errors, reference the [Possible Issues](./docker/p
{: .notification .is-warning }
## Run on the host
-After installing project dependencies use the pipenv command `pipenv run start` in the project root.
+After installing project dependencies use the poetry command `poetry run task start` in the project root.
```shell
-$ pipenv run start
+$ poetry run task start
```
---