theticketbot 0.4.0__tar.gz

theticketbot-0.4.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @thegamecracks

theticketbot-0.4.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a bug report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+### Describe the bug
+
+A clear and concise description of what the bug is.
+
+Project version that this has been tested on: [e.g. 1.0.0]
+
+### To Reproduce
+
+Steps to reproduce the behavior:
+1. Run command '...'
+2. Click on '...'
+3. Type in '...'
+4. See error
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Screenshots
+
+If applicable, add screenshots to help explain your problem.

theticketbot-0.4.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+### Is your feature request related to a problem? Please describe
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+### Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+### Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+### Additional context
+
+Add any other context or screenshots about the feature request here.

theticketbot-0.4.0/.github/pull_request_template.md

@@ -0,0 +1,11 @@
+## Summary
+
+<!-- What does this pull request do? -->
+
+## Checklist
+
+<!-- Put an X inside [ ] to check it, like so: [X] -->
+
+- [ ] This PR does *not* change any code (localization, documentation, ...)
+- [ ] If code changes were made then I have tested them.
+  - [ ] I have updated any docstrings/documentation to reflect my changes.

theticketbot-0.4.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,45 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      LOCALE_MANDATORY: '1'
+    steps:
+      - run: sudo apt-get update
+      - run: sudo apt-get install gettext
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - uses: actions/setup-python@v5
+        with:
+          cache: pip
+          cache-dependency-path: pyproject.toml
+          python-version: "3.11"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ runner.os }}
+          path: dist/
+
+  publish:
+    environment: release
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    needs:
+      - build
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: dist-*
+          path: dist/
+          merge-multiple: true
+      - uses: pypa/gh-action-pypi-publish@v1.9.0

theticketbot-0.4.0/.github/workflows/pyright-lint.yml

@@ -0,0 +1,29 @@
+name: Lint with Pyright
+
+on:
+  push:
+    paths:
+      - '**.py'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**.py'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        fetch-tags: true
+    - uses: actions/setup-python@v5
+      with:
+        cache: pip
+        cache-dependency-path: pyproject.toml
+        python-version-file: pyproject.toml
+    - run: pip install pyright
+    - run: pip install .
+    - run: pyright

theticketbot-0.4.0/.gitignore

@@ -0,0 +1,164 @@
+/data/
+/config*.toml
+.vscode/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+# *.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

theticketbot-0.4.0/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+default_language_version:
+    python: python3.11
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+    -   id: check-added-large-files
+    -   id: check-ast
+    -   id: check-toml
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black-pre-commit-mirror
+    rev:  24.4.2
+    hooks:
+    -   id: black

theticketbot-0.4.0/CHANGELOG.md

@@ -0,0 +1,129 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [Unreleased]
+
+## [0.4.0] - 2024-06-26
+
+This is theticketbot's first release to go on [PyPI](https://pypi.org/project/theticketbot/)! 🎉
+
+### Changes
+
+- BREAKING CHANGE:
+  The default database path now defaults to a user-specific directory
+  on your current platform.
+  - This path can be revealed by running `theticketbot --dump-config`.
+  - Users who want to revert to the old behaviour must explicitly write
+    `path = "data/theticketbot.db"` in their config file's `[db]` table.
+- Add classifiers, license, keywords, and URLs to the project's metadata
+- Unpin discord.py to `~=2.4`
+- Use PyPI version of asqlite pinned at `==2.0.0`
+
+### Fixes
+
+- Disable the polls intent by default, and don't enable any future standard intents
+  when upgrading discord.py
+
+## [0.3.2] - 2024-06-19
+
+### New Features
+
+- Add french localization, courtesy of @Bubobubobubobubo
+- Add `--sync` command-line argument to make registering application commands easier
+
+## [0.3.1] - 2024-06-17
+
+### New Features
+
+- Automatically lock tickets when archived by staff / auto-archived,
+  and bot is given Manage Threads permission ([#5])
+
+## [0.3.0] - 2024-06-10
+
+### New Features
+
+- Add german localization, courtesy of @GamingGalaxy200
+- Add `/inbox message` for editing inbox messages in-place ([#2])
+- Add `/inbox staff` all-in-one command for adding, listing, and removing inbox staff
+- Use per-channel Manage Threads permission to automatically add staff for new inboxes ([#8])
+- Prompt to select messages after using a command instead of requiring a selection beforehand ([#3])
+  - This should make the user experience easier overall, but may make it less convenient to perform multiple commands on the same message.
+- Automatically cleanup deleted roles from inbox staff ([#4])
+- Automatically archive tickets when their owner leaves the server
+- Optionally lock tickets during archival when the bot is given the Manage Threads permission
+- Add `theticketbot` console script as an alternative to `python -m theticketbot`
+  - Supports running with [pipx](https://pipx.pypa.io/latest/), if desired
+- Add experimental support for encrypted SQLite databases
+  - See the [README](https://github.com/thegamecracks/theticketbot/blob/v0.3.0/README.md#encryption) for usage
+
+### Changes
+
+- Make `/inbox` command guild-only
+- Don't include commas in the `$staff` placeholder for ticket starters
+- Rename `$name` to `$author` in ticket name placeholders
+  - This is automatically applied to existing inboxes during database migrations.
+- Don't request guild members during startup
+  - This can significantly reduce unnecessary bandwidth when added to large guilds.
+- For user convenience, reset timeouts for message selection commands when an error occurs
+  - Previously, the selection would always timeout 180s after the initial slash command even if the user was selecting messages.
+- Remove Manage Server permission check on inbox message selections
+  - This is no longer needed since the new message selection system is isolated to each guild, preventing users from attempting to manage inboxes from other guilds. Admins can now grant the `/inbox` command to staff that don't have the Manage Server permission.
+
+### Fixes
+
+- Fix deleted threads not being removed from database while bot is online
+
+### Removals
+
+- `/inbox staff add`
+- `/inbox staff list`
+- `/inbox staff remove`
+
+## [0.2.0] - 2024-06-04
+
+### New Features
+
+- Add `/inbox new-tickets name` for customizing names of new tickets
+  - See the [README](https://github.com/thegamecracks/theticketbot/blob/v0.2.0/README.md#customization) for available placeholders
+- Allow customizing per-user inbox ratelimits with native channel slowmode settings
+  - As of now, this ratelimit cannot be lower than 60 seconds.
+- Automatically archive tickets after being left by their owners
+- Show a helpful message when creating a ticket on an unrecognized inbox
+- Automated clean up of obsolete guilds in database, running every saturday
+
+### Changes
+
+- Update intents in default configuration:
+  - `members = true`
+    - This is needed to track when ticket owners leave their thread.
+  - `message_content = false`
+    - For now, all message content needed for bot functionality can be received without this intent.
+- Use [setuptools-scm](https://setuptools-scm.readthedocs.io/en/latest/) in build system
+  - Version automatically changes according to Git repository tags
+  - All tracked files are now included in source distributions
+
+### Removals
+
+- `/inbox starter get`
+- `/inbox starter set` - renamed to `/inbox new-tickets starter`
+
+## [0.1.0] - 2024-06-03
+
+This is theticketbot's first release! 🎉
+
+[Unreleased]: https://github.com/thegamecracks/theticketbot/compare/v0.4.0...main
+[0.4.0]: https://github.com/thegamecracks/theticketbot/compare/v0.3.2...v0.4.0
+[0.3.2]: https://github.com/thegamecracks/theticketbot/compare/v0.3.1...v0.3.2
+[0.3.1]: https://github.com/thegamecracks/theticketbot/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/thegamecracks/theticketbot/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/thegamecracks/theticketbot/compare/v0.1.1...v0.2.0
+[0.1.0]: https://github.com/thegamecracks/theticketbot/releases/tag/v0.1.0
+
+[#8]: https://github.com/thegamecracks/theticketbot/issues/8
+[#5]: https://github.com/thegamecracks/theticketbot/issues/5
+[#4]: https://github.com/thegamecracks/theticketbot/issues/4
+[#3]: https://github.com/thegamecracks/theticketbot/issues/3
+[#2]: https://github.com/thegamecracks/theticketbot/issues/2

theticketbot-0.4.0/CONTRIBUTING.md

@@ -0,0 +1,116 @@
+# Development Setup
+
+When installing the project for development, you can enable [editable mode]
+and install the [Jishaku] extension to help with iterative development and
+debugging:
+
+```sh
+pip install --editable .[jishaku]
+```
+
+[editable mode]: https://setuptools.pypa.io/en/latest/userguide/development_mode.html
+[Jishaku]: https://github.com/Gorialis/jishaku
+
+You can also install this project's [pre-commit] hooks to automatically
+run lints for you:
+
+```sh
+pip install pre-commit
+pre-commit install
+```
+
+[pre-commit]: https://pre-commit.com/
+
+And finally, you should use [Pyright] to type-check your code before committing.
+In VSCode, this is built into the Pylance extension and can be enabled in
+your settings, but you can also install the third-party pyright wrapper
+to manually run it:
+
+```sh
+pip install pyright
+pyright
+```
+
+[Pyright]: https://microsoft.github.io/pyright/
+
+Database migration scripts are stored in [migrations/] and are automatically
+executed upon bot startup. During development, if any changes to the database
+schema are required, please create a backup of your database before adding a
+new migration script.
+
+[migrations/]: https://github.com/thegamecracks/theticketbot/tree/main/src/theticketbot/migrations/
+
+When updating any file that contains `_()` translatable strings,
+it is recommended to run `utils/merge_po.py` and `utils/build_mo.py`
+just before starting the bot or creating a commit.
+This requires gettext to be installed.
+
+# Python Style Guide
+
+- Code should follow [PEP 8] where possible, unless exempted by this guide
+  - When unsure, run [Black] to format your code
+  - Use `# fmt: off` and `# fmt: on` comments to override the formatter when necessary
+
+- Unlike PEP 8, the max line length allowed in this codebase is 88 characters
+
+- Variable names must **NOT** be abbreviated unless their usage is already
+  conventional, such as `i`/`j` for indices or `c` for characters.
+  In general, prefer explicit and readable names over short variable names.
+
+  ```py
+  # Bad:
+  n = "thegamecracks"
+  un = "thegamecracks"
+  uName = "thegamecracks"
+  # Good:
+  user_name = "thegamecracks"
+  ```
+
+- Trailing commas **MUST** be used when arguments/elements are spread out
+  over several lines
+  - This includes single-length arguments/elements like `function(arg)`.
+    If doing so would exceed the line length, consider refactoring the argument
+    into a separate variable if not already done.
+
+- Line continuations (`\`) are **NOT** allowed and should be managed with either
+  implicit line continuations, decomposition of expressions into multiple statements,
+  or refactoring into functions.
+
+- All code must **NOT** have any trailing whitespace
+
+- As an extension to PEP 8, imports should be grouped into the following order:
+  - Built-in modules
+  - Third-party modules
+  - Absolute imports of local modules
+  - Relative imports of local modules
+
+  ```py
+  import sqlite3
+  import time
+  from typing import Awaitable, Callable, Iterable
+
+  import asqlite
+  import discord
+  from discord.ext import commands
+
+  from theticketbot.database import DatabaseClient
+
+  from .config import load_config
+  ```
+
+- Relatve imports **MAY** be used for sibling modules, i.e. those that reside
+  in the same directory
+
+- Absolute imports **MUST** be used for parent modules, i.e. those that exist
+  outside of the module. In other words, relative imports consisting of two
+  or more leadiing periods must be refactored into absolute imports.
+
+  ```py
+  # Bad:
+  from ..database import DatabaseClient
+  # Good:
+  from theticketbot.database import DatabaseClient
+  ```
+
+[PEP 8]: https://peps.python.org/pep-0008/
+[Black]: https://black.readthedocs.io/en/stable/

theticketbot-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 thegamecracks
+
+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.

theticketbot-0.4.0/MANIFEST.in

@@ -0,0 +1,3 @@
+recursive-include src *.md *.po *.pot
+include src/theticketbot/migrations/*.sql
+include src/theticketbot/config_default.toml