Skip to content

Commit

Permalink
fix: README.md + pyproject.toml + up deps
Browse files Browse the repository at this point in the history
- added badge for Python version in README.md
- shorten long lines in README.md
- fix license and add readme field in pyproject.toml
- update aiohttp, Ruff and TOML Kit
  • Loading branch information
Zalk0 committed Aug 15, 2024
1 parent d9b5501 commit 00d1028
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ repos:

- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.5.7
rev: v0.6.0
hooks:
# Run the linter.
- id: ruff
Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ChouetteBot-discord

![Python version 3.9+](https://img.shields.io/badge/Python-3.9+-blue)
[![Ruff status](https://github.com/Zalk0/ChouetteBot-discord/actions/workflows/ruff.yaml/badge.svg?branch=main)](https://github.com/Zalk0/ChouetteBot-discord/actions/workflows/ruff.yaml)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Zalk0/ChouetteBot-discord/main.svg)](https://results.pre-commit.ci/latest/github/Zalk0/ChouetteBot-discord/main)

Expand Down Expand Up @@ -55,13 +56,18 @@ You can also run ruff manually with the commands `ruff check` and `ruff format`.

[![Docker Image](https://github.com/Zalk0/ChouetteBot-discord/actions/workflows/docker-image.yaml/badge.svg?branch=main)](https://github.com/Zalk0/ChouetteBot-discord/actions/workflows/docker-image.yaml)

You can use a Docker image to deploy the bot. It's currently supporting amd64, armv6, armv7 and arm64
architectures. We provide deployment information on the [Docker Hub repository](https://hub.docker.com/r/gylfirst/chouettebot).
You can use a Docker image to deploy the bot.
It's currently supporting amd64, armv6, armv7 and arm64 architectures.
We provide deployment information on the
[Docker Hub repository](https://hub.docker.com/r/gylfirst/chouettebot).

You can build it from source with:

```bash
docker build .
# or
docker build --build-arg version=tag -t app:tag .
```
(see [Docker Build CLI Options](https://docs.docker.com/reference/cli/docker/image/build/#options) to get more info)

(see [Docker Build CLI Options](https://docs.docker.com/reference/cli/docker/image/build/#options)
to get more info)
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[project]
name = "ChouetteBot"
license = "MIT"
license = { text = "MIT License" }
readme = "README.md"
requires-python = ">=3.9"

[tool.ruff]
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
-r requirements.txt
pre-commit ~= 3.8
ruff == 0.5.7
ruff == 0.6.0
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
aiohttp ~= 3.10.2
aiohttp ~= 3.10.3
discord.py[speed] ~= 2.4.0
python-dotenv ~= 1.0.1
tomlkit ~= 0.13.0
tomlkit ~= 0.13.2
tzdata; os_name == "nt"

0 comments on commit 00d1028

Please sign in to comment.