discord-clyde 0.1.0__tar.gz

discord_clyde-0.1.0/.github/CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# How to Contribute
+
+Contributions to this project are gladly accepted, there are a just a few guidelines that need to be followed.
+
+## Reporting Issues
+
+Bugs and feature requests should be directed to the [GitHub Issue Tracker](https://github.com/EthanC/Clyde/issues).
+
+If reporting a bug, please try and provide as much context as possible such as your operating system, Python version, and anything else that might be relevant to the bug. Security related bugs should also be reported in the Issue Tracker, or if they are more sensitive, Direct Messaged to [@Mxtive on X](https://twitter.com/Mxtive) or `lacking` on Discord.
+
+For feature requests, please explain what you're trying to do and how the requested feature would help you do that.
+
+## Submitting a Contribution
+
+1. It's generally best to start by opening a new Issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial Issue that you are planning to work on that bug or feature so that it can be assigned to you.
+2. Follow the normal process of [Forking](https://help.github.com/articles/fork-a-repo) the repository, then setup a new Branch to work in. It's important that each group of changes be done in separate Branches in order to ensure that a Pull Request only includes the commits related to that bug or feature.
+3. [Ruff](https://github.com/astral-sh/ruff) is used in this project and make it very simple to ensure properly formatted code, so always run it on your code before committing.
+4. Any significant changes should almost always be accompanied by tests. The project already has good test coverage, so look at some of the existing tests if you're unsure how to go about it.
+5. Do your best to have [well-formed Commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for each change. This provides consistency throughout the project, and ensures that Commit messages are able to be formatted properly by various git tools.
+6. Finally, push the Commits to your Fork and submit a [Pull Request](https://help.github.com/articles/creating-a-pull-request). Please do not use Force-Push on Pull Requests in this repository, as it makes it more difficult for reviewers to see what has changed since the last code review.

discord_clyde-0.1.0/.github/workflows/FUNDING.yaml

@@ -0,0 +1 @@
+custom: ["https://cash.app/$EthanChrisp", "https://venmo.com/u/Mxtive"]

discord_clyde-0.1.0/.github/workflows/workflow.yaml

@@ -0,0 +1,68 @@
+name: Primary
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  library:
+    name: Library
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install Python
+        run: uv python install
+      - name: Install Dependencies
+        run: uv sync --dev
+      - name: Run ruff
+        run: uv run ruff check .
+      - name: Run pytest
+        run: uv run pytest --cov --cov-branch --cov-report=xml
+        env:
+          TESTS_WEBHOOK_URL: ${{ secrets.TESTS_WEBHOOK_URL }}
+      - name: Upload Coverage Report
+        uses: codecov/codecov-action@v5
+        with:
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Build Package
+        run: uv build
+      # - name: Publish Package to PyPI
+      #   env:
+      #     PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+      #   run: uv publish --token $PYPI_API_TOKEN
+  documentation:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install Python
+        run: uv python install
+      - name: Configure Git
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - name: Print cache_id
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache 
+          restore-keys: |
+            mkdocs-material-
+      - name: Install Dependencies
+        run: uv add mkdocstrings[python] mkdocs-material
+      - name: Build Documentation
+        run: uv run mkdocs build
+      - name: Deploy Documentation
+        run: uv run mkdocs gh-deploy --force

discord_clyde-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# 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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

discord_clyde-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

discord_clyde-0.1.0/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "charliermarsh.ruff",
+        "tamasfe.even-better-toml",
+        "redhat.vscode-yaml",
+    ]
+}