Skip to content

Commit

Permalink
Merge pull request #502 from python-discord/poetry
Browse files Browse the repository at this point in the history
Poetry In Dev Guides
  • Loading branch information
HassanAbouelela committed May 16, 2021
2 parents c6196e5 + 636281d commit fd6491f
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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
```

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,30 @@ 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 Settings](/static/images/wiki/contributing/pycharm_interpreter.png)
4. In the popup window, click `Pipenv Environment`, make sure `Install packages from Pipfile` is checked, then click `OK`.
![PyCharm Pipenv Environment](/static/images/wiki/contributing/pycharm_pipenv.png)
5. PyCharm will automatically install the packages required into a virtual environment.
![PyCharm Project Interpreter](/static/images/wiki/contributing/pycharm_pipenv_success.png)
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)

---

## 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
```
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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
```

---
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fd6491f

Please sign in to comment.