Skip to content

Commit c5fda5d

Browse files
authored
Merge pull request #511 from python-discord/update/docs-pipenv-to-poetry
Update guides to use `poetry` instead of `pipenv`
2 parents 7d6de90 + 3ff5d03 commit c5fda5d

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

docs/setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ Make sure you add the following to your hosts file:
8282
```
8383
When trying to access the site, you'll be using the domains above instead of the usual `localhost:8000`.
8484

85-
Finally, you will need to set the environment variable `DEBUG=1`. When using `pipenv`, you can
86-
set put this into an `.env` file to have it exported automatically. It's also recommended to
85+
Finally, you will need to set the environment variable `DEBUG=1`. If you have `python-dotenv` installed, you can put this into a
86+
`.env` file to have it exported automatically. It's also recommended to
8787
export `LOG_LEVEL=INFO` when using `DEBUG=1` if you don't want super verbose logs.
8888

8989
To run the server, run `python manage.py runserver`. If it gives you an error saying

pydis_site/apps/content/resources/guides/pydis-guides/contributing/contributing-guidelines/supplemental-information.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ If the linter complains, the commit is aborted so that you can fix the linting e
4040
That way, you never commit the problematic code in the first place!
4141

4242
Please refer to the project-specific documentation to see how to setup and run those tools.
43-
In most cases, you can install pre-commit using `pipenv run precommit` or `poetry run task precommit`, and lint using `pipenv run lint` or `poetry run task lint`.
43+
In most cases, you can install pre-commit using `poetry run task precommit`, and lint using `poetry run task lint`.
4444

4545
## Type Hinting
4646

pydis_site/apps/content/resources/guides/pydis-guides/contributing/installing-project-dependencies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You should have already cloned your fork as described in [**Cloning a Repository
2121
4. Navigate to `Project Interpreter`, then click the gear icon and click `Add`.<br/>
2222
![PyCharm Interpreter Settings](/static/images/content/contributing/pycharm_interpreter.png)<br/>
2323
5. Click `Poetry Environment`, then click `OK`.<br/>
24-
![PyCharm Pipenv Environment](/static/images/content/contributing/pycharm_poetry.png)<br/>
24+
![PyCharm Poetry Environment](/static/images/content/contributing/pycharm_poetry.png)<br/>
2525
6. PyCharm will automatically install the packages required into a virtual environment.<br/>
2626
![PyCharm Project Interpreter](/static/images/content/contributing/pycharm_poetry_success.png)
2727

pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ toc: 1
77

88
# Requirements
99

10-
- [Python 3.8](https://www.python.org/downloads/)
11-
- [Pipenv](https://github.com/pypa/pipenv#installation)
12-
- `pip install pipenv`
10+
- [Python 3.9](https://www.python.org/downloads/)
11+
- [Poetry](https://python-poetry.org/docs/#installation)
12+
- `pip install poetry`
1313
- [Git](https://git-scm.com/downloads)
1414
- [Windows](https://git-scm.com/download/win)
1515
- [MacOS](https://git-scm.com/download/mac) or `brew install git`
@@ -122,10 +122,10 @@ If you're not using Docker, then use [pg_ctl](https://www.postgresql.org/docs/cu
122122

123123
### Webserver
124124

125-
Starting the webserver is done simply through pipenv:
125+
Starting the webserver is done simply through poetry:
126126

127127
```shell
128-
pipenv run start
128+
poetry run task start
129129
```
130130

131131
---

0 commit comments

Comments
 (0)