Add project scaffolding

hypergonial · hypergonial · commit ce0450f4e387 · 2025-03-23T16:27:56.000+01:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
diff --git a/.env.example b/.env.example
@@ -0,0 +1 @@
+TOKEN=DISCORD_BOT_TOKEN_HERE
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto eol=lf
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  formatting:
+    runs-on: ubuntu-latest
+    name: "Run ruff via nox"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.9"
+          python-version: "3.13"
+
+      - name: Run ruff via nox
+        run: |
+          uv run nox -s format
+
+  pyright:
+    runs-on: ubuntu-latest
+    name: "Run pyright via nox"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.9"
+          python-version: "3.13"
+
+      - name: Run pyright via nox
+        run: |
+          uv run nox -s pyright
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -0,0 +1,34 @@
+name: Publish to Github Container Registry
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  push-to-ghcr:
+    name: Push to Github Container Registry
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+    steps:
+      - name: Setup | Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup | QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Setup | Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build & Deploy | Docker image
+        uses: docker/build-push-action@v6
+        with:
+          push: true
+          tags: |
+            ghcr.io/${{ github.repository }}:${{ github.ref_name }}
+            ghcr.io/${{ github.repository }}:latest
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,9 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "charliermarsh.ruff",
+        "njpwerner.autodocstring",
+        "EditorConfig.EditorConfig",
+        "tamasfe.even-better-toml"
+    ]
+}
diff --git a/.vscode/python.code-snippets b/.vscode/python.code-snippets
@@ -0,0 +1,27 @@
+{
+    "Set up new file": {
+        "scope": "python",
+        "prefix": "!!!",
+        "body": [
+            "from __future__ import annotations",
+            "",
+            "$0",
+            "",
+            "# Copyright (C) 2025-present hypergonial, rayakame",
+            "",
+            "# This program is free software: you can redistribute it and/or modify",
+            "# it under the terms of the GNU General Public License as published by",
+            "# the Free Software Foundation, either version 3 of the License, or",
+            "# (at your option) any later version.",
+            "",
+            "# This program is distributed in the hope that it will be useful,",
+            "# but WITHOUT ANY WARRANTY; without even the implied warranty of",
+            "# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the",
+            "# GNU General Public License for more details.",
+            "",
+            "# You should have received a copy of the GNU General Public License",
+            "# along with this program.  If not, see: https://www.gnu.org/licenses",
+        ],
+        "description": "Set up a new Python source file"
+    }
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,15 @@
+{
+    "editor.tabCompletion": "onlySnippets",
+    "python.analysis.autoImportCompletions": true,
+    "python.analysis.typeCheckingMode": "strict",
+    "python.analysis.diagnosticMode": "workspace",
+    "python.analysis.exclude": [
+        "build*",
+        ".nox*",
+    ],
+    "editor.formatOnSave": true,
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "autoDocstring.docstringFormat": "numpy",
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -0,0 +1,17 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    // Use Ctrl+Shift+B or the command palette to run nox.
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Run nox",
+            "type": "shell",
+            "command": "uv run nox",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        }
+    ]
+}
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,29 @@
+FROM ghcr.io/astral-sh/uv:python3.13-bookworm
+
+WORKDIR /app
+
+# Enable bytecode compilation
+ENV UV_COMPILE_BYTECODE=1
+
+# Copy from the cache instead of linking since it's a mounted volume
+ENV UV_LINK_MODE=copy
+
+# Install the project's dependencies using the lockfile and settings
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --frozen --no-install-project --no-dev
+
+# Then, add the rest of the project source code and install it
+# Installing separately from its dependencies allows optimal layer caching
+ADD . /app
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --frozen --no-dev
+
+# Place executables in the environment at the front of the path
+ENV PATH="/app/.venv/bin:$PATH"
+
+# Reset the entrypoint, don't invoke `uv`
+ENTRYPOINT []
+
+CMD ["python3.13", "-O", "-m", "src"]
diff --git a/README.md b/README.md
@@ -1,2 +1,37 @@
 # hikari-gitbot
+
 A bot for managing GitHub issues and PRs on Discord.
+
+## Usage
+
+Set the `TOKEN` environment variable to a valid Discord token, then run the bot:
+
+```sh
+docker compose up -d
+```
+
+## Development
+
+Download [uv](https://docs.astral.sh/uv/), then run the following command to sync all dependencies:
+
+```sh
+uv sync --dev
+```
+
+A new venv will be created in the project root, and all dependencies will be installed.
+
+To activate the venv, run:
+
+```sh
+source .venv/bin/activate
+```
+
+In addition, to check if the code is formatted correctly and passes all the type checks, run:
+
+```sh
+uv run nox
+```
+
+## License
+
+This project is licensed under the GPL-v3 License - see the [LICENSE](LICENSE) file for details.
diff --git a/compose.yaml b/compose.yaml
@@ -0,0 +1,8 @@
+services:
+  hikari-gitbot:
+      build:
+          context: .
+          dockerfile: Dockerfile
+      environment:
+          TOKEN: ${TOKEN:?err}
+      restart: always
diff --git a/noxfile.py b/noxfile.py
@@ -0,0 +1,64 @@
+import os
+import typing as t
+
+import nox
+from nox import options
+
+PATH_TO_PROJECT = os.path.join(".", "src")
+SCRIPT_PATHS = [PATH_TO_PROJECT, "noxfile.py"]
+
+options.default_venv_backend = "uv"
+options.sessions = ["format_fix", "pyright"]
+
+
+# uv_sync taken from: https://github.com/hikari-py/hikari/blob/master/pipelines/nox.py#L48
+#
+# Copyright (c) 2020 Nekokatt
+# Copyright (c) 2021-present davfsa
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+def uv_sync(
+    session: nox.Session, /, *, include_self: bool = False, extras: t.Sequence[str] = (), groups: t.Sequence[str] = ()
+) -> None:
+    if extras and not include_self:
+        raise RuntimeError("When specifying extras, set `include_self=True`.")
+
+    args: list[str] = []
+    for extra in extras:
+        args.extend(("--extra", extra))
+
+    group_flag = "--group" if include_self else "--only-group"
+    for group in groups:
+        args.extend((group_flag, group))
+
+    session.run_install(
+        "uv", "sync", "--frozen", *args, silent=True, env={"UV_PROJECT_ENVIRONMENT": session.virtualenv.location}
+    )
+
+
+@nox.session()
+def format_fix(session: nox.Session) -> None:
+    uv_sync(session, groups=["dev"])
+    session.run("python", "-m", "ruff", "format", *SCRIPT_PATHS)
+    session.run("python", "-m", "ruff", "check", *SCRIPT_PATHS, "--fix")
+
+
+@nox.session()
+def format(session: nox.Session) -> None:
+    uv_sync(session, groups=["dev"])
+    session.run("python", "-m", "ruff", "format", *SCRIPT_PATHS, "--check")
+    session.run("python", "-m", "ruff", "check", *SCRIPT_PATHS)
+
+
+@nox.session()
+def pyright(session: nox.Session) -> None:
+    uv_sync(session, include_self=True, groups=["dev"])
+    session.run("pyright", *SCRIPT_PATHS)
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,91 @@
+[project]
+name = "hikari-gitbot"
+version = "0.0.0"
+description = "A bot for managing GitHub issues and PRs on Discord."
+readme = "README.md"
+license = "GPL-3.0"
+authors = [
+    { name = "hypergonial", email = "git@hypergonial.com" },
+    { name = "rayakame", email = "github.android206@passmail.net" },
+]
+maintainers = [
+    { name = "hypergonial", email = "git@hypergonial.com" },
+    { name = "rayakame", email = "github.android206@passmail.net" },
+]
+requires-python = ">=3.13"
+dependencies = [
+    "hikari-arc>=2.0.0",
+    "hikari[speedups]>=2.2.0",
+    "python-dotenv>=1.0.1",
+]
+
+[dependency-groups]
+dev = [
+    "nox>=2025.2.9",
+    "pyright>=1.1.397",
+    "ruff>=0.11",
+    "typing-extensions>=4.12",
+    "uv>=0.6",
+    "colorama>=0.4.6; sys_platform == 'win32'",
+]
+
+[tool.ruff]
+exclude = ["build"]
+line-length = 120
+target-version = "py313"
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "I",
+    "TCH",
+    "C",
+    "N",
+    "D2",
+    "D3",
+    "D415",
+    "D417",
+    "D418",
+    "D419",
+    "ASYNC",
+    "Q",
+    "RSE",
+    "SIM",
+    "RUF",
+]
+ignore = ["F405", "F403", "E501", "D205"]
+fixable = ["I", "TCH", "D", "RUF"]
+
+[tool.ruff.lint.isort]
+split-on-trailing-comma = false
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.format]
+skip-magic-trailing-comma = true
+
+[tool.slotscheck]
+strict-imports = true
+require-superclass = false
+require-subclass = true
+exclude-classes = ":.*(Exception|Error|Proto|AutocompleteData)"
+
+[tool.mypy]
+ignore_errors = true
+
+[tool.uv]
+required-version = "~=0.6"
+
+[tool.pyright]
+pythonVersion = "3.13"
+typeCheckingMode = "strict"
+reportPrivateUsage = false
+reportMissingTypeStubs = true
+reportUnnecessaryTypeIgnoreComment = "warning"
+reportUninitializedInstanceVariable = "error"
+reportShadowedImports = "warning"
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "function"
diff --git a/src/__init__.py b/src/__init__.py
diff --git a/src/__main__.py b/src/__main__.py
diff --git a/uv.lock b/uv.lock
