You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you don't have python 3.13.2 installed, you can install it using the following command:
32
+
This will install Poetry at `~/.local/bin/poetry`. Add this to your PATH if it's not already there.
33
+
34
+
```bash
35
+
export PATH="$HOME/.local/bin:$PATH"
36
+
```
37
+
38
+
Refer to the [official Poetry documentation](https://python-poetry.org/docs/#installation) for other installation methods.
39
+
40
+
Next, use Poetry to install the required Python version (e.g., 3.13.2) and configure the virtual environment:
33
41
34
42
```bash
35
43
poetry python install 3.13.2
44
+
poetry env use 3.13.2
36
45
```
37
46
38
-
* Note that this is an experimental feature and may not be as reliable as other methods.
39
-
* We recommend using something like [mise](https://mise.jdx.dev/) to install python and manage your environment.
40
-
* Other options include using `pyenv` or `asdf`. Last but not least, you can search your package manager.
47
+
* **Note:** While `poetry python install` is convenient, you can also manage Python versions using external tools like [mise](https://mise.jdx.dev/), `pyenv`, or `asdf`, and then run `poetry env use <python_version>` if you prefer.
41
48
42
-
Install all project dependencies:
49
+
Now, install all project dependencies (this will also install required Poetry plugins if needed):
43
50
44
51
```bash
45
52
poetry install
46
53
```
47
54
48
-
Install the `pre-commit` hooks:
55
+
Finally, install the `pre-commit` hooks:
49
56
50
57
```bash
51
58
poetry run pre-commit install
@@ -60,7 +67,7 @@ Before you begin, ensure you have the following installed:
60
67
61
68
Edit the `.env` file and fill out the required variables. The `.env` file is used for both local and Docker development.
62
69
63
-
At a minimum, you will need to fill in the `DEV_BOT_TOKEN` and `DEV_DATABASE_URL` variables for local development when using the CLI to start the bot with `poetry run tux --dev bot start`.
70
+
At a minimum, you will need to fill in the `DEV_BOT_TOKEN` and `DEV_DATABASE_URL` variables for local development when using the CLI to start the bot with `poetry run tux --dev start`.
64
71
65
72
```bash
66
73
DEV_BOT_TOKEN=your_dev_discord_token
@@ -103,7 +110,7 @@ This is the simplest and recommended way to get started and develop Tux.
103
110
Start the bot in development mode:
104
111
105
112
```bash
106
-
poetry run tux --dev bot start
113
+
poetry run tux --dev start
107
114
```
108
115
109
116
This command will:
@@ -118,7 +125,7 @@ This is the simplest and recommended way to get started and develop Tux.
118
125
119
126
The project includes a hot-reloading utility (`tux/utils/hot_reload.py`).
120
127
121
-
When the bot is running locally via `poetry run tux --dev bot start`, this utility watches forchangesin the `tux/cogs/` directory and attempts to automatically reload modified or affected cogs without requiring a full bot restart.
128
+
When the bot is running locally via `poetry run tux --dev start`, this utility watches forchangesin the `tux/cogs/` directory and attempts to automatically reload modified or affected cogs without requiring a full bot restart.
122
129
123
130
This significantly speeds up development for cog-related changes. Note that changes outside the `tux/cogs/` directory (e.g., utility files, core bot logic) may still require a manual restart (`Ctrl+C` and run the start command again).
124
131
@@ -235,7 +242,7 @@ This method provides a containerized environment, useful for ensuring consistenc
235
242
poetry run tux --dev docker up --build
236
243
```
237
244
238
-
This uses Docker Compose with the development overrides. The `develop: watch:` feature syncs code changes into the container. The container runs `python -m tux --dev bot start`.
245
+
This uses Docker Compose with the development overrides. The `develop: watch:` feature syncs code changes into the container. The container runs `python -m tux --dev start`.
0 commit comments