fix actions

Author: AbstractUmbra

.github/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+## Contributing to Mystbin.py
+
+First off, thanks for taking the time to contribute. It makes the library substantially better. :+1:
+
+The following is a set of guidelines for contributing to the repository. These are guidelines, not hard rules.
+
+## Good Bug Reports
+
+Please be aware of the following things when filing bug reports.
+
+1. Don't open duplicate issues. Please search your issue to see if it has been asked already. Duplicate issues will be closed.
+2. When filing a bug about exceptions or tracebacks, please include the *complete* traceback. Without the complete traceback the issue might be **unsolvable** and you will be asked to provide more information.
+3. Make sure to provide enough information to make the issue workable. The issue template will generally walk you through the process, but they are enumerated here as well:
+    - A **summary** of your bug report. This is generally a quick sentence or two to describe the issue in human terms.
+    - Guidance on **how to reproduce the issue**. Ideally, this should have a small code sample that allows us to run and see the issue for ourselves to debug. **Please make sure that the token is not displayed**. If you cannot provide a code snippet, then let us know what the steps were, how often it happens, etc.
+    - Tell us **what you expected to happen**. That way we can meet that expectation.
+    - Tell us **what actually happens**. What ends up happening in reality? It's not helpful to say "it fails" or "it doesn't work". Say *how* it failed, do you get an exception? Does it hang? How are the expectations different from reality?
+    - Tell us **information about your environment**. What version of `mystbin.py` are you using? How was it installed? What operating system are you running on? These are valuable questions and information that we use.
+
+If the bug report is missing this information then it'll take us longer to fix the issue. We will probably ask for clarification, and barring that if no response was given then the issue will be closed.
+
+## Submitting a Pull Request
+
+Submitting a pull request is fairly simple, just make sure it focuses on a single aspect and doesn't manage to have scope creep, and it's probably good to go. It would be incredibly lovely if the style is consistent to that found in the project. This project follows PEP-8 guidelines (mostly) with a column limit of 125.
+There are provided tool rules in `pyproject.toml` for `isort` and `black` when committing here.
+Please also check type completeness with `pyright`. (This is not mandatory but could lead to a PR review asking for it).
+
+### Git Commit Guidelines
+
+- Use present tense (e.g. "Add feature" not "Added feature")
+- Limit all lines to 72 characters or fewer.
+- Reference issues or pull requests outside the first line.
+    - Please use the shorthand `#123` and not the full URL.
+
+If you do not meet any of these guidelines, don't fret. Chances are they will be fixed upon rebasing but please do try to meet them to remove some workload.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,67 @@
+name: Bug Report
+description: Report broken or incorrect behaviour
+labels: unconfirmed bug
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Thanks for taking the time to fill out a bug.
+
+        Please note that this form is for bugs only!
+  - type: input
+    attributes:
+      label: Summary
+      description: A simple summary of your bug report
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Reproduction Steps
+      description: >
+        What you did to make it happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Minimal Reproducible Code
+      description: >
+        A short snippet of code that showcases the bug.
+      render: python
+  - type: textarea
+    attributes:
+      label: Expected Results
+      description: >
+        What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Actual Results
+      description: >
+        What actually happened?
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Related item UUIDs
+      description: >
+        What type of item were you interacting with?
+        If applicable, also include it's UUID for testing purposes.
+    validations:
+      required: false
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: >
+        Let's make sure you've properly done due diligence when reporting this issue!
+      options:
+        - label: I have searched the open issues for duplicates.
+          required: true
+        - label: I have shown the entire traceback, if possible.
+          required: true
+        - label: I have included debug logging (with my latest token remove), if applicable.
+          required: false
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: If there is anything else to say, please do so here.

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,12 @@
+## Summary
+
+<!-- What is this pull request for? Does it fix any issues? -->
+
+## Checklist
+
+<!-- Put an x inside [ ] to check it, like so: [x] -->
+
+- [ ] If code changes were made then they have been tested.
+- [ ] This PR fixes an issue.
+- [ ] This PR adds something new (e.g. new method or parameters).
+- [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,5 @@
 [settings]
 profile = black
-src_paths = hondana
-known_first_party = hondana
+src_paths = mystbin
+known_first_party = mystbin
 lines_after_imports = 2

.github/linters/.isort.cfg

@@ -0,0 +1,72 @@
+name: "Code Analysis"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '35 8 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.9
+
+    - name: Set up Poetry
+      uses: Gr1N/setup-poetry@v4
+
+    - name: Install Python deps
+      run: |
+          poetry install --no-dev
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/analysis.yml

@@ -0,0 +1,82 @@
+# Runs a build test on commit to ensure functionality.
+
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*.*.*'
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: [ 3.9 ]
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up Poetry
+        uses: Gr1N/setup-poetry@v4
+
+      - name: Install Python deps
+        run: |
+          poetry install --no-dev
+
+      - name: Check it imports
+        run: |
+          poetry run python -c 'import mystbin'
+
+      - name: Build wheels
+        run: |
+          poetry build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: distributions
+          path: dist/*
+
+  # Credits to most of this step go to Gorialis (Devon R [https://github.com/Gorialis])
+  # as I found them in their Jishaku builds (https://github.com/Gorialis/jishaku/blob/d3f50749b5a977b544e5fd14894585f656247486/.github/workflows/deploy.yml#L82-L119)
+  create_release:
+    needs: [ build ]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/')
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          submodules: true
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: distributions
+          path: dist
+
+      - name: Set up Poetry
+        uses: Gr1N/setup-poetry@v4
+
+      - name: Publish to PyPI
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          poetry config pypi-token.pypi $PYPI_TOKEN
+          poetry publish

.github/workflows/analyze.yml

@@ -28,11 +28,12 @@ jobs:
       - name: Install Python deps
         run: |
           poetry install --no-dev
+          poetry run pip install .
 
       - name: Type Coverage
         run: |
           npm install -g pyright
-          pyright --lib --ignoreexternal --verifytypes mystbin
+          poetry run pyright --lib --ignoreexternal --verifytypes mystbin
 
       - name: Lint
         uses: github/super-linter@v4