Skip to content

Commit d830736

Browse files
committed
Bump version to 0.2.1
- bump dependencies, pin them with == - add a Dockerfile + instructions in readme
1 parent 28f9ce0 commit d830736

File tree

5 files changed

+40
-17
lines changed

5 files changed

+40
-17
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,25 @@ MoneroChad and all the code in this repository is licensed under the GNU Affero
4747
|| Bot info and credits.
4848
```
4949

50-
### Deployment
50+
### Docker Deployment
5151

52-
The bot uses Python 3.10 features, so you need at least that version.
52+
#### Build the image
53+
```sh
54+
docker build -t monerochad:0.2.1 -f docker/Dockerfile .
55+
```
56+
57+
#### Create a `.env` file
58+
You copy and modify the one at [`docker/template.env`](docker/template.env).
59+
All the settings you can configure through `.env` are in [`config.py`](monerochad/config.py).
60+
61+
#### Run the container
62+
```sh
63+
docker run --env-file path/to/your/.env monerochad:0.2.1
64+
```
65+
It doesn't need any volumes or ports exposed.
5366

54-
These instructions are meant for deployment on Linux.
67+
### Manual Deployment (discouraged)
68+
These instructions are meant for deployment on Linux. You need Python 3.10 or higher.
5569

5670
#### Create venv and install dependencies
5771
```sh
@@ -64,14 +78,8 @@ python3 -m pip install -r requirements.txt
6478
```
6579

6680
#### Create a `.env` file
67-
```
68-
DISCORD_API_TOKEN=Your Discord API bot token
69-
GUILD_IDS=Comma separated IDs of guilds the bot runs in
70-
NEWS_CHANNEL_IDS=Comma separated IDs of channels the bot relays news feeds to
71-
```
72-
Put this into a file named `.env` in the directory the bot will run in.
73-
74-
You can see all the settings you can configure through `.env` in [`config.py`](monerochad/config.py).
81+
You copy and modify the one at [`docker/template.env`](docker/template.env).
82+
All the settings you can configure through `.env` are in [`config.py`](monerochad/config.py).
7583

7684
#### Run the bot
7785
```sh

docker/Dockerfile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
FROM python:3.12.2-alpine3.19
2+
3+
WORKDIR /code
4+
5+
COPY ../requirements.txt /code/requirements.txt
6+
7+
RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
8+
9+
COPY ../monerochad /code/monerochad
10+
11+
CMD ["python3", "-m", "monerochad.main"]

docker/template.env

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
DISCORD_API_TOKEN=Your Discord API bot token
2+
GUILD_IDS=Comma separated IDs of guilds the bot runs in
3+
NEWS_CHANNEL_IDS=Comma separated IDs of channels the bot relays news feeds to
4+
DEBUG_ADMIN_IDS=Comma separated IDS of users the bot will message when any error occurrs

monerochad/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.2.0"
1+
__version__ = "0.2.1"

requirements.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
discord.py>=2.3.1,<2.4.0
2-
lru-dict>=1.2.0,<1.3.0
3-
pydantic-settings>=2.0.2,<2.1.0
4-
requests>=2.31.0,<2.32.0
1+
discord.py==2.3.2
2+
lru-dict==1.3.0
3+
pydantic-settings==2.3.3
4+
requests==2.32.3
55
mplfinance==0.12.10b0
6-
defusedxml>=0.7.1,<0.8.0
6+
defusedxml==0.7.1

0 commit comments

Comments
 (0)