Skip to content

Commit

Permalink
Migrates Sir Lancebot And Python To Poetry
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
HassanAbouelela committed May 16, 2021
1 parent ab75c82 commit 636281d
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 12 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 @@ -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
```
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

0 comments on commit 636281d

Please sign in to comment.