Skip to content

Commit

Permalink
Publish repo
Browse files Browse the repository at this point in the history
  • Loading branch information
hypergonial committed Dec 27, 2023
0 parents commit 766a1ac
Show file tree
Hide file tree
Showing 91 changed files with 7,656 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: hypergonial
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discord server
url: https://discord.gg/Jx4cNGG
about: Ask questions about the library in the server!
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/suggestion.yml
Original file line number Diff line number Diff line change
@@ -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
52 changes: 52 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Run checks

on: [push, pull_request]

jobs:
formatting:
runs-on: ubuntu-latest
name: "Run ruff on Python 3.12"
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Run ruff via nox
run: |
python -m pip install nox
python -m nox -s format
pyright:
runs-on: ubuntu-latest
name: "Run pyright via nox on Python 3.12"
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Run pyright via nox
run: |
python -m pip install nox
python -m nox -s pyright
pytest:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.10', '3.11', '3.12']
fail-fast: false

name: Run pytest via nox on Python ${{ matrix.python-version }}
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- run: |
python -m pip install nox
python -m nox -s pytest
61 changes: 61 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Deploy docs to Pages

on:
# Runs on release creation
release:
types: [published]

# 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@v3

- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: "3.11"

- name: Build docs via nox
run: |
python -m pip install nox
python -m nox -s docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
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@v2
20 changes: 20 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: publish

on:
release:
types: [published]

jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: publish
run: |
pip install build
python -m build
pip install twine
twine upload dist/* -u __token__ -p ${{ secrets.PYPI_TOKEN }}
Loading

0 comments on commit 766a1ac

Please sign in to comment.