refactor: ci & code quality (#76)

* Restructuring changes

* Some more changes

* Add to requirements

* More changes

* Fix requirements file path

* update files

* refactor: replace black with brunette

This keeps the current single quoted format to try and keep a minimal amount of changes

* tests: add version test

Signed-off-by: BobDotCom <[email protected]>
Signed-off-by: VincentRPS <[email protected]>
Co-authored-by: VincentRPS <[email protected]>

Author: BobDotCom

.flake8

@@ -1,4 +1,5 @@
 [flake8]
+min_python_version = 3.10
 count = true
 max-line-length = 120
 show_source = True
@@ -40,6 +41,8 @@ ignore =
     E722
     # W503: line break before binary operator
     W503
+    # E203: whitespace before ':'
+    E203
 
 per-file-ignores =
     # imported but unused
@@ -61,4 +64,4 @@ exclude =
 
 accept-encodings = utf-8
 max-complexity = 19
-docstring-convention = numpy
+docstring-convention = numpy

.gitattributes

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

.github/dependabot.yml

@@ -1,10 +1,10 @@
 version: 2
 updates:
-  - package-ecosystem: 'pip'
-    directory: '/'
+  - package-ecosystem: "pip"
+    directory: "/"
     schedule:
-      interval: 'daily'
-  - package-ecosystem: 'github-actions'
-    directory: '/'
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
     schedule:
-      interval: 'daily'
+      interval: "daily"

.gitignore

@@ -15,4 +15,5 @@ test.py
 .nox/
 *.inv
 ci.py
-.env
+.env
+testing/

.pre-commit-config.yaml

@@ -0,0 +1,91 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: https://github.com/PyCQA/autoflake
+    rev: v1.7.7
+    hooks:
+      - id: autoflake
+  #        args:
+  #          - --in-place
+  #          - --remove-all-unused-imports
+  #          - --expand-star-imports
+  #          - --remove-duplicate-keys
+  #          - --remove-unused-variables
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.1.0
+    hooks:
+      - id: pyupgrade
+        args: [--py310-plus]
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+  - repo: https://github.com/odwyersoftware/brunette
+    rev: 0.2.7
+    hooks:
+      - id: brunette
+        # See https://github.com/psf/black/issues/2188#issuecomment-1289317647 for why we can't use the --preview flag.
+        args: [--safe, --quiet, --single-quotes]
+  - repo: https://github.com/Pierre-Sassoulas/black-disable-checker
+    rev: 1.0.1
+    hooks:
+      - id: black-disable-checker
+  #  - repo: https://github.com/PyCQA/flake8
+  #    rev: 4.0.1
+  #    hooks:
+  #      - id: flake8
+  #        additional_dependencies: [flake8-typing-imports==1.12.0]
+  #  - repo: local
+  #    hooks:
+  #      - id: pylint
+  #        name: pylint
+  #        entry: pylint
+  #        language: system
+  #        types: [python]
+  #        args: ["-rn", "-sn", "--rcfile=.pylintrc", "--fail-on=I"]
+  #      # We define an additional manual step to allow running pylint with a spelling
+  #      # checker in CI.
+  #      - id: pylint
+  #        alias: pylint-with-spelling
+  #        name: pylint
+  #        entry: pylint
+  #        language: system
+  #        types: [python]
+  #        args: ["-rn", "-sn", "--rcfile=.pylintrc", "--fail-on=I", "--spelling-dict=en"]
+  #        stages: [manual]
+  #      - id: mypy
+  #        name: mypy
+  #        entry: mypy
+  #        language: system
+  #        types: [python]
+  #        args: ["--non-interactive"]
+  #  - repo: https://github.com/myint/rstcheck
+  #    rev: "v5.0.0"
+  #    hooks:
+  #      - id: rstcheck
+  #        args: ["--ignore-roles=func,class,mod", "--report=warning"]
+  #        types: [text]
+  #  - repo: https://github.com/pre-commit/mirrors-mypy
+  #    rev: v0.950
+  #    hooks:
+  #      - id: mypy
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.0-alpha.3
+    hooks:
+      - id: prettier
+        args: [--prose-wrap=always, --print-width=88]
+  - repo: https://github.com/DanielNoord/pydocstringformatter
+    rev: 93b15ca # TODO: Change this when v8.0 is released
+    hooks:
+      - id: pydocstringformatter
+        args:
+          [
+            --style=numpydoc,
+            --no-numpydoc-name-type-spacing,
+            --no-final-period,
+            --no-capitalize-first-letter,
+          ]

.prettierrc

@@ -0,0 +1,3 @@
+proseWrap: always
+printWidth: 88
+endOfLine: auto

.readthedocs.yml

@@ -6,15 +6,14 @@ build:
   tools:
     python: "3.10"
 
-
 python:
-    install:
-      - method: pip
-        path: .
-        extra_requirements:
-          - docs
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
 
 sphinx:
-   configuration: docs/conf.py
-   fail_on_warning: false
-   builder: html
+  configuration: docs/conf.py
+  fail_on_warning: false
+  builder: html

CHANGELOG.md

@@ -1,6 +1,5 @@
 MIT License
 
-Copyright (c) 2021-present VincentRPS
 Copyright (c) 2022-present Pycord
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,4 +18,4 @@ 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.
+SOFTWARE.

LICENSE

@@ -1,4 +1,20 @@
+include README.rst
+include LICENSE
 include requirements.txt
+include pycord/bin/*.dll
 include pycord/py.typed
 include pycord/banner.txt
-include pycord/bin/*.dll
+
+prune .github
+prune docs
+prune examples
+prune tests
+exclude pycord/bin/COPYING
+exclude .flake8
+exclude .gitignore
+exclude .pre-commit-config.yaml
+exclude .prettierrc
+exclude .readthedocs.yml
+exclude CHANGELOG.md
+exclude FUNDING.yml
+exclude requirements-dev.txt