File tree Expand file tree Collapse file tree 1 file changed +13
-18
lines changed Expand file tree Collapse file tree 1 file changed +13
-18
lines changed Original file line number Diff line number Diff line change @@ -20,39 +20,34 @@ the [discord.py](https://pypi.org/project/discord.py/) library and [MongoDB](htt
20
20
## Prerequisites
21
21
22
22
- Git
23
- - Python 3.8 or higher (tested on 3.12)
23
+ - Python >= 3.8
24
+ - [ ` uv ` package manager] ( https://docs.astral.sh/uv/getting-started/installation/ )
24
25
- [ MongoDB Atlas] ( https://www.mongodb.com/products/platform/atlas-database ) or any other MongoDB instance
25
26
26
27
## Installation
27
28
28
- 1 . Clone the repository
29
+ 1 . Clone the repository.
29
30
30
31
``` shell
31
- git clone https://github.com/nerva-project/RoboNerva.git
32
+ git clone https://github.com/nerva-project/RoboNerva.git
32
33
```
33
34
34
- 2 . Switch to the project directory
35
+ 2 . Switch to the project directory.
35
36
36
37
``` shell
37
- cd RoboNerva
38
+ cd RoboNerva
38
39
```
39
40
40
- 3 . Create a virtual environment
41
+ 3 . Install the dependencies.
41
42
42
43
``` shell
43
- python -m venv .venv
44
+ uv sync --no-dev
44
45
```
45
-
46
- 4 . Activate the virtual environment
47
-
48
- ``` shell
49
- source .venv/bin/activate
50
- ```
51
-
52
- 5 . Install the dependencies
46
+
47
+ 4 . (Optional) Set up a development environment by installing the development dependencies and extras.
53
48
54
49
``` shell
55
- pip install .
50
+ uv sync --all-extras
56
51
```
57
52
58
53
## Configuration
@@ -62,11 +57,11 @@ Copy the [`config.example.py`](config.example.py) file to `config.py` and update
62
57
## Running
63
58
64
59
``` shell
65
- python launcher.py
60
+ uv run launcher.py
66
61
```
67
62
68
63
## License
69
64
70
65
[ GNU General Public License v3.0] ( LICENSE )
71
66
72
- Copyright © ; 2024 [ Sayan "Sn1F3rt" Bhattacharyya] ( https://sn1f3rt.me ) , [ The Nerva Project] ( https://nerva.one )
67
+ Copyright © ; 2024 [ Sayan "Sn1F3rt" Bhattacharyya] ( https://sn1f3rt.dev ) , [ The Nerva Project] ( https://nerva.one )
You can’t perform that action at this time.
0 commit comments