Skip to content

Commit b34e714

Browse files
committed
Project installation guides from poetry to uv
1 parent 97a9d85 commit b34e714

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ This page will focus on the quickest steps one can take, with mentions of altern
1616
Below are the dependencies you **must** have installed to get started with the bot.
1717

1818
1. Make sure you have [Python 3.12](https://www.python.org/downloads/) installed. It helps if it is your system's default Python version.
19-
1. [Install Poetry](https://github.com/python-poetry/poetry#installation).
20-
1. [Install the project's dependencies](../installing-project-dependencies).
21-
1. Docker.
19+
2. [Install uv](https://github.com/astral-sh/uv#installation).
20+
3. [Install the project's dependencies](../installing-project-dependencies).
21+
4. Docker.
2222

2323
<div class="card">
2424
<button type="button" class="card-header collapsible">
@@ -87,7 +87,7 @@ Other values will be added to your `.env` over time as you need to interact with
8787
#### .env.server
8888
All server related configuration values are saved in this file, which also needs to be at the root directory of the project.
8989

90-
We provide a script to automatically generate a server config.
90+
We provide a script to automatically generate a server config.
9191
**Note**: The script **only** works with servers created with the template mentioned above.
9292

9393
If you want to setup the bot from an existing guild read out [manual configuration guide](../bot-extended-configuration-options#manual-constants-configuration). This is far more complicated and time consuming.
@@ -96,7 +96,7 @@ Running the below command will use the `BOT_TOKEN` and `GUILD_ID` from the `.env
9696

9797
**Note**: This script will overwrite the `.env.server` file. We suggest you put any configuration not generated by this script in to `.env` instead
9898
```shell
99-
$ poetry run task configure
99+
$ uv run task configure
100100
```
101101

102102
Once the script has finished running, you'll notice the creation of a new file called `.env.server` at your project's root directory.
@@ -163,7 +163,7 @@ Even if you run the bot through Docker, you might want to [setup a development e
163163
### Lint before you push
164164
As mentioned in the [contributing guidelines](../contributing-guidelines), you should make sure your code passes linting for each commit you make.
165165

166-
For ease of development, you can install the pre-commit hook with `poetry run task precommit`, which will check your code every time you try to commit it.
166+
For ease of development, you can install the pre-commit hook with `uv run task precommit`, which will check your code every time you try to commit it.
167167
For that purpose, even if you run the bot through Docker, you might want to [setup a development environment](../bot-extended-configuration-options#setting-up-a-development-environment), as otherwise the hook installation will fail.
168168

169169
### Issues?

pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Remember to ensure that you have read the [contributing guidelines](../contribut
1111

1212
### Requirements
1313
- [Python 3.13.*](https://www.python.org/downloads/)
14-
- [Poetry](https://github.com/python-poetry/poetry#installation)
14+
- [uv](https://github.com/astral-sh/uv#installation)
1515
- [Git](https://git-scm.com/downloads)
1616
- [Windows Installer](https://git-scm.com/download/win)
1717
- [MacOS Installer](https://git-scm.com/download/mac) or `brew install git`
@@ -108,10 +108,10 @@ If you get any Docker related errors, reference the [Possible Issues](../docker#
108108
{: .notification .is-warning }
109109

110110
## Run on the host
111-
After installing project dependencies use the poetry command `poetry run task start` in the project root.
111+
After installing project dependencies use the uv command `uv run task start` in the project root.
112112

113113
```shell
114-
$ poetry run task start
114+
$ uv run task start
115115
```
116116
---
117117

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ You should have already forked the [`site`](https://github.com/python-discord/si
1010
### Requirements
1111

1212
- [Python 3.11](https://www.python.org/downloads/)
13-
- [Poetry](https://python-poetry.org/docs/#installation)
14-
- `pip install poetry`
13+
- [uv](https://github.com/astral-sh/uv#installation)
1514
- [Git](https://git-scm.com/downloads)
1615
- [Windows](https://git-scm.com/download/win)
1716
- [MacOS](https://git-scm.com/download/mac) or `brew install git`
@@ -114,10 +113,10 @@ If you're not using Docker, then use [pg_ctl](https://www.postgresql.org/docs/cu
114113

115114
### Webserver
116115

117-
Starting the webserver is done simply through poetry:
116+
Starting the webserver is done simply through uv:
118117

119118
```shell
120-
poetry run task start
119+
uv run task start
121120
```
122121

123122
---

0 commit comments

Comments
 (0)