easterobot 1.0.0__tar.gz

easterobot-1.0.0/.dockerignore

@@ -0,0 +1,9 @@
+*
+!uv.lock
+!pyproject.toml
+!LICENSE
+!/easterobot/*.py
+!/easterobot/commands/*.py
+!/easterobot/resources
+!README.rst
+!entrypoint.sh

easterobot-1.0.0/.editorconfig

@@ -0,0 +1,49 @@
+# https://editorconfig.org/
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+
+[*.py]
+indent_size = 4
+max_line_length = 79
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{tex,bib,toml}]
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[Dockerfile]
+indent_size = 4
+
+[*.{yml,yaml,json,jsonc,jsonl,js,ts}]
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{bat,cmd,ps1}]
+indent_style = tab
+end_of_line = crlf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{md,txt,rst}]
+insert_final_newline = true
+trim_trailing_whitespace = false
+
+[*.tsv]
+indent_style = tab
+
+[Makefile]
+indent_style = tab
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[LICENSE]
+insert_final_newline = false
+trim_trailing_whitespace = true

easterobot-1.0.0/.github/actions/setup-project/action.yml

@@ -0,0 +1,30 @@
+name: "Setup Python Environment"
+description: "Set up Python environment for the given Python version"
+
+inputs:
+  python-version:
+    description: "Python version to use"
+    required: true
+    default: "3.12"
+  uv-version:
+    description: "uv version to use"
+    required: true
+    default: "0.6.5"
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+      with:
+        version: ${{ inputs.uv-version }}
+        enable-cache: "true"
+        cache-suffix: ${{ matrix.python-version }}
+
+    - name: Install Python dependencies
+      run: uv sync --frozen
+      shell: bash

easterobot-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,35 @@
+name: docs
+
+on:
+  - push
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    name: Docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Set up project and environment
+        uses: ./.github/actions/setup-project
+
+      - name: Build documentation
+        run: uv run poe docs
+
+      - name: Deploy docs
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./public
+          force_orphan: true

easterobot-1.0.0/.github/workflows/lint.yml

@@ -0,0 +1,23 @@
+name: lint
+
+on:
+  - push
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Set up project and environment
+        uses: ./.github/actions/setup-project
+
+      - name: Run linting
+        run: uv run poe lint

easterobot-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: publish
+
+on:
+  push:
+    tags:
+      - "**"
+
+jobs:
+  publish:
+    name: Publish on PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/easterobot
+    permissions:
+      id-token: write
+    steps:
+
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up project and environment
+        uses: ./.github/actions/setup-project
+
+      - name: Check the tag
+        run: uv run poe check-tag
+
+      - name: Runn all tests
+        run: uv run poe check
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

easterobot-1.0.0/.github/workflows/tests.yml

@@ -0,0 +1,39 @@
+name: tests
+
+on:
+  - push
+
+jobs:
+  tests:
+    name: Tests on ${{ matrix.os }} (${{ matrix.python-version }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: macos-latest
+            python-version: "3.9"
+          - os: windows-latest
+            python-version: "3.9"
+          - os: ubuntu-latest
+            python-version: "3.9"
+          - os: ubuntu-latest
+            python-version: "3.13"
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Set up project and environment
+        uses: ./.github/actions/setup-project
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run tests
+        run: uv run poe test

easterobot-1.0.0/.gitignore

@@ -0,0 +1,115 @@
+# cached files
+__pycache__/
+*.py[cod]
+.cache
+.DS_Store
+*~
+.*.sw[po]
+.build
+.ve
+.env
+.pytest
+.benchmarks
+.bootstrap
+.appveyor.token
+*.bak
+
+# installation package
+*.egg-info/
+dist/
+build/
+
+# environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# C extensions
+*.so
+
+# pycharm
+.idea/
+
+# vscode
+*.code-workspace
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+.eggs
+parts
+bin
+var
+sdist
+wheelhouse
+develop-eggs
+.installed.cfg
+lib
+lib64
+venv*/
+.venv*/
+pyvenv*/
+pip-wheel-metadata/
+poetry.lock
+
+# Installer logs
+pip-log.txt
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+mypy.ini
+
+# test caches
+.tox/
+.pytest_cache/
+.coverage
+htmlcov
+report.xml
+nosetests.xml
+coverage.xml
+htmlcov
+
+# Translations
+*.mo
+
+# Buildout
+.mr.developer.cfg
+
+# IDE project files
+.project
+.pydevproject
+.idea
+*.iml
+*.komodoproject
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
+public/
+web/
+
+# Docs
+public/
+
+# Mypy Cache
+.mypy_cache/
+
+# Ruff cache
+.ruff_cache/
+
+config.yaml
+config.yml
+logs
+*.db
+/bot

easterobot-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,50 @@
+repos:
+  # https://github.com/pre-commit/pre-commit-hooks
+  - repo: local
+    hooks:
+    - id: trailing-whitespace
+      name: trim trailing whitespace
+      entry: uv run trailing-whitespace-fixer
+      language: system
+      types: [text]
+      stages: [pre-commit, pre-push, manual]
+    - id: end-of-file-fixer
+      name: fix end of files
+      entry: uv run end-of-file-fixer
+      language: system
+      types: [text]
+      stages: [pre-commit, pre-push, manual]
+    - id: check-yaml
+      name: check yaml
+      entry: uv run check-yaml
+      language: system
+      types: [yaml]
+    - id: check-json
+      name: check json
+      entry: uv run check-json
+      language: system
+      types: [json]
+      exclude: "^.vscode"
+    - id: check-toml
+      name: check toml
+      entry: uv run check-toml
+      language: system
+      types: [toml]
+  # https://github.com/commitizen-tools/commitizen
+  - repo: local
+    hooks:
+    - id: commitizen
+      name: commitizen check
+      entry: uv run cz check
+      args: [--allow-abort, --commit-msg-file]
+      stages: [commit-msg]
+      language: system
+  # https://github.com/astral-sh/ruff-pre-commit
+  - repo: local
+    hooks:
+    - id: poe-format
+      name: ruff linter, ruff formatter and mypy
+      entry: uv run poe format
+      language: system
+      pass_filenames: false
+      types: [python]

easterobot-1.0.0/.vscode/extensions.json

@@ -0,0 +1,31 @@
+{
+  "recommendations": [
+    "aaron-bond.better-comments",
+    "benspaulding.python-manifest-template",
+    "charliermarsh.ruff",
+    "DavidAnson.vscode-markdownlint",
+    "EditorConfig.EditorConfig",
+    "github.vscode-github-actions",
+    "jebbs.plantuml",
+    "KevinRose.vsc-python-indent",
+    "matangover.mypy",
+    "ms-python.vscode-pylance",
+    "ms-python.python",
+    "njpwerner.autodocstring",
+    "redhat.vscode-yaml",
+    "streetsidesoftware.code-spell-checker",
+    "tamasfe.even-better-toml",
+    "trond-snekvik.simple-rst",
+    "usernamehw.errorlens",
+    "VisualStudioExptTeam.vscodeintellicode"
+  ],
+  "unwantedRecommendations": [
+    "bungcip.better-toml",
+    "ms-python.mypy-type-checker",
+    "ms-python.autopep8",
+    "ms-python.pylint",
+    "ms-python.isort",
+    "ms-python.black-formatter",
+    "ms-pyright.pyright"
+  ]
+}

easterobot-1.0.0/.vscode/ltex.dictionary.en-US.txt

@@ -0,0 +1,5 @@
+noqa
+fmt
+pragma
+doctest
+mypy

easterobot-1.0.0/.vscode/ltex.hiddenFalsePositives.en-US.txt

@@ -0,0 +1 @@
+{"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qbash(code)\n:language: bash\\E$"}

easterobot-1.0.0/.vscode/settings.json

@@ -0,0 +1,98 @@
+{
+  // Don't format on save for formatters we don't explicitely control
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "always"
+  },
+  // Set file associations to support comments syntax highlight
+  "files.associations": {
+    "settings.json": "jsonc",
+    "extensions.json": "jsonc",
+    "LICENSE": "txt"
+  },
+  // Files to exclude
+  "files.exclude": {
+    ".bzr": true,
+    ".direnv": true,
+    ".eggs": true,
+    ".git": true,
+    ".hg": true,
+    ".mypy_cache": true,
+    ".nox": true,
+    ".pants.d": true,
+    ".pytype": true,
+    ".ruff_cache": true,
+    ".pytest_cache": true,
+    ".svn": true,
+    ".tox": true,
+    ".venv": true,
+    "__pypackages__": true,
+    "_build": true,
+    "buck-out": true,
+    "build": true,
+    "dist": true,
+    "node_modules": true,
+    "venv": true
+  },
+  // Conventional rulers for python
+  "editor.rulers": [72, 79, 120],
+  "ruff.fixAll": true,
+  // Conflict between Ruff and isort
+  "ruff.organizeImports": false,
+  "evenBetterToml.formatter.alignComments": false,
+  "evenBetterToml.formatter.alignEntries": false,
+  "evenBetterToml.formatter.allowedBlankLines": 1,
+  "evenBetterToml.formatter.arrayAutoCollapse": true,
+  "evenBetterToml.formatter.arrayAutoExpand": true,
+  "evenBetterToml.formatter.arrayTrailingComma": true,
+  "evenBetterToml.formatter.columnWidth": 79,
+  "evenBetterToml.formatter.compactArrays": true,
+  "evenBetterToml.formatter.compactEntries": false,
+  "evenBetterToml.formatter.compactInlineTables": false,
+  "evenBetterToml.formatter.indentEntries": false,
+  "evenBetterToml.formatter.indentTables": false,
+  "evenBetterToml.formatter.inlineTableExpand": false,
+  "evenBetterToml.formatter.reorderArrays": true,
+  "evenBetterToml.formatter.trailingNewline": true,
+  // We like keeping TOML keys in a certain non-alphabetical order that feels more natural
+  "evenBetterToml.formatter.reorderKeys": false,
+  "redhat.telemetry.enabled": false,
+  "ltex.language": "en",
+  "cSpell.language": "en",
+  "cSpell.words": [
+    "anyio",
+    "automodule",
+    "autouse",
+    "bysource",
+    "caplog",
+    "checkfirst",
+    "commitizen",
+    "Conjugable",
+    "cooldown",
+    "Coro",
+    "Dashstrom",
+    "docstrings",
+    "doctest",
+    "Easterbot",
+    "easterobot",
+    "elle",
+    "genindex",
+    "IMREAD",
+    "imwrite",
+    "levelname",
+    "modindex",
+    "mypy",
+    "noqa",
+    "parseable",
+    "pyarg",
+    "pypi",
+    "pyproject",
+    "sourcelink",
+    "sphinxcontrib",
+    "todos",
+    "typehints",
+    "undoc",
+    "viewcode",
+    "webbrowser"
+  ]
+}

easterobot-1.0.0/Dockerfile

@@ -0,0 +1,39 @@
+# Install uv
+FROM python:3.12-slim
+
+# Metadata for clarity and documentation
+LABEL maintainer="your_email@example.com"
+LABEL description="Docker image for easterobot using uv for dependency management"
+
+# Add the UV binary
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+
+# Add non-root user
+RUN useradd --create-home easterobot
+
+# Create directory
+RUN mkdir /data
+
+# Make it read-only
+RUN chown easterobot:easterobot /data
+
+# Use non-root user for security
+USER easterobot
+
+# Change the working directory to the `src` directory
+WORKDIR /src
+
+# Copy only project definition files (improves caching)
+COPY pyproject.toml uv.lock ./
+
+# Install dependencies
+RUN uv sync --frozen --no-install-project
+
+# Copy the project into the image
+COPY . .
+
+# Sync the project
+RUN uv sync --frozen
+
+# Default command (use exec form for signal handling)
+CMD ["/src/entrypoint.sh"]

easterobot-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024, Dashstrom <dashstrom.pro@gmail.com>
+
+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.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.