aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site/apps
diff options
context:
space:
mode:
authorGravatar Xithrius <[email protected]>2025-07-15 16:54:47 -0700
committerGravatar Xithrius <[email protected]>2025-07-17 18:41:46 -0700
commitb34e7148f0d2c0445f59d379c3e8cc35e30a37e9 (patch)
treebeb1959b13981bf04e43e5f838c041dd5cea9398 /pydis_site/apps
parentDependencies/docker to uv (diff)
Project installation guides from poetry to uv
Diffstat (limited to 'pydis_site/apps')
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/contributing/bot.md12
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/contributing/sir-lancebot.md6
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md7
3 files changed, 12 insertions, 13 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 173025fd..6c27cfae 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
@@ -16,9 +16,9 @@ This page will focus on the quickest steps one can take, with mentions of altern
Below are the dependencies you **must** have installed to get started with the bot.
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.
-1. [Install Poetry](https://github.com/python-poetry/poetry#installation).
-1. [Install the project's dependencies](../installing-project-dependencies).
-1. Docker.
+2. [Install uv](https://github.com/astral-sh/uv#installation).
+3. [Install the project's dependencies](../installing-project-dependencies).
+4. Docker.
<div class="card">
<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
#### .env.server
All server related configuration values are saved in this file, which also needs to be at the root directory of the project.
-We provide a script to automatically generate a server config.
+We provide a script to automatically generate a server config.
**Note**: The script **only** works with servers created with the template mentioned above.
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
**Note**: This script will overwrite the `.env.server` file. We suggest you put any configuration not generated by this script in to `.env` instead
```shell
-$ poetry run task configure
+$ uv run task configure
```
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
### Lint before you push
As mentioned in the [contributing guidelines](../contributing-guidelines), you should make sure your code passes linting for each commit you make.
-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.
+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.
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.
### Issues?
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 fc97e570..c618a4cb 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
@@ -11,7 +11,7 @@ Remember to ensure that you have read the [contributing guidelines](../contribut
### Requirements
- [Python 3.13.*](https://www.python.org/downloads/)
-- [Poetry](https://github.com/python-poetry/poetry#installation)
+- [uv](https://github.com/astral-sh/uv#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`
@@ -108,10 +108,10 @@ If you get any Docker related errors, reference the [Possible Issues](../docker#
{: .notification .is-warning }
## Run on the host
-After installing project dependencies use the poetry command `poetry run task start` in the project root.
+After installing project dependencies use the uv command `uv run task start` in the project root.
```shell
-$ poetry run task start
+$ uv run task start
```
---
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md
index 1927f449..fe44c40d 100644
--- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md
+++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md
@@ -10,8 +10,7 @@ You should have already forked the [`site`](https://github.com/python-discord/si
### Requirements
- [Python 3.11](https://www.python.org/downloads/)
-- [Poetry](https://python-poetry.org/docs/#installation)
- - `pip install poetry`
+- [uv](https://github.com/astral-sh/uv#installation)
- [Git](https://git-scm.com/downloads)
- [Windows](https://git-scm.com/download/win)
- [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
### Webserver
-Starting the webserver is done simply through poetry:
+Starting the webserver is done simply through uv:
```shell
-poetry run task start
+uv run task start
```
---