hikari-arc 1.4.0__tar.gz → 2.0.0__tar.gz

hikari_arc-2.0.0/.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

hikari_arc-2.0.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

hikari_arc-2.0.0/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: hypergonial

hikari_arc-2.0.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,70 @@
+name: Bug report
+description: Found a bug with the library? Report it here!
+labels: ["bug"]
+assignees:
+  - hypergonial
+
+body:
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to reproduce
+      description: Steps to reproduce the bug. Please be as detailed as possible in your explanations, and ensure the bug can be reproduced with these steps.
+      value: |
+        1. Run code
+        2. Do stuff
+        3. Crash system
+        4. Observe bug
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-result
+    attributes:
+      label: Expected result
+      description: What should have happened if the bug wasn't there?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-result
+    attributes:
+      label: Actual result
+      description: What happened exactly? Please provide a detailed explanation, and any errors, tracebacks, or other information.
+    validations:
+      required: true
+
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System information
+      description: The output of `python -m arc`.
+      placeholder: |
+        hikari-arc - package information
+        ----------------------------------
+        Arc version: 0.1.0
+        Install path: /home/foo/.local/lib/python3.10/site-packages/arc
+        Hikari version: 2.0.0.dev109
+        Install path: /home/foo/.local/lib/python3.10/site-packages/hikari
+        Python: CPython 3.10.4 (GCC 11.2.0)
+        System: Linux x86_64 (archlinux) - 5.17.1-zen1-1-zen
+      render: shell
+    validations:
+      required: true
+
+  - type: textarea
+    id: further-info
+    attributes:
+      label: Further information
+      description: Any further information, images, or other resources go here.
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      description: Make sure to tick all the following boxes.
+      options:
+        - label: I have made sure to remove ANY sensitive information (bot token, passwords, credentials, personal details, etc.).
+          required: true
+        - label: I have searched the issue tracker and have made sure it's not a duplicate. If it is a follow up of another issue, I have specified it.
+          required: true

hikari_arc-2.0.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discord server
+    url: https://discord.gg/hikari
+    about: Ask questions about the library in the server!

hikari_arc-2.0.0/.github/ISSUE_TEMPLATE/suggestion.yml

@@ -0,0 +1,36 @@
+name: Suggestion
+description: Do you have an idea on improving the library? Share it with us!
+labels: ["enhancement"]
+
+body:
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: Small summary of the suggestion.
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Why is this needed?
+      description: Why should this suggestion be implemented? What problem(s) would it solve?
+    validations:
+      required: true
+
+  - type: textarea
+    id: ideal-implementation
+    attributes:
+      label: Ideal implementation
+      description: How should this suggestion be implemented?
+      value: To be decided.
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      description: Make sure to tick all the following boxes.
+      options:
+        - label: I have searched the issue tracker and have made sure it's not a duplicate. If it is a follow up of another issue, I have specified it.
+          required: true

hikari_arc-2.0.0/.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on: [push, pull_request]
+
+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.4"
+          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.4"
+          python-version: "3.13"
+
+      - name: Run pyright via nox
+        run: |
+          uv run nox -s pyright
+
+  slotscheck:
+    runs-on: ubuntu-latest
+    name: "Run slotscheck via nox"
+    steps:
+        - uses: actions/checkout@v4
+        - name: Install uv
+          uses: astral-sh/setup-uv@v5
+          with:
+            version: "0.6.4"
+            python-version: "3.13"
+
+        - name: Run slotscheck via nox
+          run: |
+            uv run nox -s slotscheck
+
+  pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+      fail-fast: false
+
+    name: Run pytest via nox on Python ${{ matrix.python-version }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install uv with Python ${{ matrix.python-version }}
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "0.6.4"
+        python-version: ${{ matrix.python-version }}
+    - run: |
+        uv run nox -s pytest

hikari_arc-2.0.0/.github/workflows/docs.yml

@@ -0,0 +1,55 @@
+name: Deploy docs to Pages
+
+on:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.4"
+          python-version: "3.11"
+
+      - name: Build docs via nox
+        run: |
+          uv run nox -s docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./site
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

hikari_arc-2.0.0/.github/workflows/publish.yml

@@ -0,0 +1,19 @@
+name: publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.4"
+          python-version: "3.13"
+      - name: publish
+        run: |
+          uv build --no-sources
+          uv publish --token ${{ secrets.PYPI_TOKEN }}

hikari_arc-2.0.0/.gitignore

@@ -0,0 +1,135 @@
+# 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/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+# Ruff
+.ruff_cache/
+
+# Dolphin
+.directory

hikari_arc-2.0.0/.idea/.gitignore

@@ -0,0 +1,3 @@
+# Default ignored files
+/shelf/
+/workspace.xml

hikari_arc-2.0.0/.idea/externalDependencies.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ExternalDependencies">
+    <plugin id="org.editorconfig.editorconfigjetbrains" />
+  </component>
+</project>

hikari_arc-2.0.0/.idea/hikari-arc.iml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/examples" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/arc" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/tests" isTestSource="true" />
+      <excludeFolder url="file://$MODULE_DIR$/docs" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="PyDocumentationSettings">
+    <option name="format" value="NUMPY" />
+    <option name="myDocStringFormat" value="NumPy" />
+    <option name="renderExternalDocumentation" value="true" />
+  </component>
+  <component name="TestRunnerService">
+    <option name="PROJECT_TEST_RUNNER" value="py.test" />
+  </component>
+</module>

hikari_arc-2.0.0/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

hikari_arc-2.0.0/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/hikari-arc.iml" filepath="$PROJECT_DIR$/.idea/hikari-arc.iml" />
+    </modules>
+  </component>
+</project>

hikari_arc-2.0.0/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

hikari_arc-2.0.0/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "charliermarsh.ruff",
+        "njpwerner.autodocstring",
+        "EditorConfig.EditorConfig",
+        "tamasfe.even-better-toml"
+    ]
+}

hikari_arc-2.0.0/.vscode/python.code-snippets

@@ -0,0 +1,34 @@
+{
+    "Set up new file": {
+        "scope": "python",
+        "prefix": "!!!",
+        "body": [
+            "from __future__ import annotations",
+            "",
+            "$0",
+            "",
+            "# MIT License",
+            "#",
+            "# Copyright (c) 2023-present hypergonial",
+            "#",
+            "# 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."
+        ],
+        "description": "Set up a new Python source file"
+    }
+}

hikari_arc-2.0.0/.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+    "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",
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+}

hikari_arc-2.0.0/.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
+            }
+        }
+    ]
+}

hikari_arc-2.0.0/CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+
+All contributions are welcome, no matter how small! However there are some caveats to be aware of, detailed below.
+
+## Open an issue
+
+If your contribution is **not** a bugfix or small change, please [open an issue](https://github.com/hypergonial/hikari-arc/issues/new/choose) or contact me on [Discord](https://discord.gg/hikari) to discuss it.
+
+## Setting up the project
+
+### Installing dependencies
+
+`arc` uses [`uv`](https://github.com/astral-sh/uv) for dependency management, you should [install it](https://docs.astral.sh/uv/getting-started/installation/#installing-uv) if you haven't already.
+
+Use the command below to install all the tooling required to develop arc in a virtual environment:
+
+```sh
+$ uv sync --all-extras --dev
+```
+
+### Running nox
+
+Before submitting your changes, you should run [`nox`](https://pypi.org/project/nox/) and ensure all the pipelines pass successfully.
+This checks the code for typing errors, antipatterns & bad practices, along with formatting it & running all tests.
+
+```sh
+uv run nox
+```
+
+GitHub CI runs on every pull request to verify that `nox` passes.
+
+### Configuring your editor
+
+This is optional, but highly recommended if you're doing larger contributions.
+
+#### VS Code
+
+When cloning the project for the first time, VS Code should prompt you to install extensions recommended by the project, if you're missing any. Review and install them.
+
+This should set up linting & typechecking to be performed as you edit the source code, along with defaulting the formatter to [`ruff`](https://astral.sh/ruff). A fairly minimal [editorconfig](https://editorconfig.org) is also applied to ensure consistency with the rest of the project.
+
+You can also run `nox` by using the shortcut Ctrl+Shift+B. This uses VS Code's tasks system, [see here](https://go.microsoft.com/fwlink/?LinkId=733558) for more information.
+
+Custom snippets are also available:
+
+- `!!!` + TAB: Set up a new source file, insert annotations import & license
+
+#### PyCharm and other JetBrains IDEs
+
+Configuration should be applied automatically, however there is no good extension for [`ruff`](https://astral.sh/ruff), so you should doubly make sure `nox` successfully completes before committing your changes.
+
+#### Other editors
+
+If you want to add explicit support for other editors, please [open a PR](https://github.com/hypergonial/hikari-arc/pulls)!
+
+---
+
+That's all! Thanks for reading it all. If you have suggestions as to what other things should be added here to improve the developer experience, please [open an issue](https://github.com/hypergonial/hikari-arc/issues/new/choose)!