Merge pull request #5 from python-discord/update-ci

Update packaging and CI config for CJ9

Author: janine9vn

.github/workflows/lint.yaml

@@ -2,9 +2,13 @@
 
 name: Lint
 
-# Trigger the workflow on both push (to the main repository)
-# and pull requests (against the main repository, but from any repo).
-on: [push, pull_request]
+# Trigger the workflow on both push (to the main repository, on the main branch)
+# and pull requests (against the main repository, but from any repo, from any branch).
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 # Brand new concurrency setting! This ensures that not more than one run can be triggered for the same commit.
 # It is useful for pull requests coming from the main repository since both triggers will match.
 concurrency: lint-${{ github.sha }}
@@ -14,22 +18,19 @@ jobs:
     runs-on: ubuntu-latest
 
     env:
-      # Set an environment variable to select pip's cache directory for us to actually cache between runs.
-      PIP_CACHE_DIR: /tmp/pip-cache-dir
       # The Python version your project uses. Feel free to change this if required.
-      PYTHON_VERSION: 3.9
+      PYTHON_VERSION: "3.10"
 
     steps:
       # Checks out the repository in the current folder.
       - name: Checks out repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # Set up the right version of Python
       - name: Set up Python ${{ env.PYTHON_VERSION }}
-        id: python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
-      - name: Run pre-commit hooks.
-        uses: pre-commit/action@v2.0.3
+      - name: Run pre-commit hooks
+        uses: pre-commit/action@v3.0.0

.pre-commit-config.yaml

@@ -18,17 +18,14 @@ repos:
     hooks:
       - id: python-check-blanket-noqa
 
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v5.9.2
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
     hooks:
       - id: isort
 
   - repo: https://github.com/pycqa/flake8
-    rev: 3.9.2
+    rev: 4.0.1
     hooks:
       - id: flake8
         additional_dependencies:
-          - flake8-annotations~=2.0
-          - flake8-bandit~=2.1
-          - flake8-docstrings~=1.5
-          - flake8-isort~=4.0
+          - flake8-docstrings~=1.6.0

README.md

@@ -28,11 +28,8 @@ Our first and probably most important tool is flake8. It will run a set of plugi
 Here is a sample output:
 ```
 ~> flake8
-./app.py:1:1: D100 Missing docstring in public module
 ./app.py:1:6: N802 function name 'helloWorld' should be lowercase
 ./app.py:1:16: E201 whitespace after '('
-./app.py:1:17: ANN001 Missing type annotation for function argument 'name'
-./app.py:1:23: ANN201 Missing return type annotation for public function
 ./app.py:2:1: D400 First line should end with a period
 ./app.py:2:1: D403 First word of the first line should be properly capitalized
 ./app.py:3:19: E225 missing whitespace around operator
@@ -53,10 +50,7 @@ It is run by calling `flake8` in the project root.
 
 #### Plugin List:
 
-- `flake8-annotations`: Checks your code for the presence of [type-hints](https://docs.python.org/3/library/typing.html).
-- `flake8-bandit`: Checks for common security breaches.
 - `flake8-docstring`: Checks that you properly documented your code.
-- `flake8-isort`: Makes sure you ran ISort on the project.
 
 ### ISort: automatic import sorting
 

dev-requirements.txt

@@ -3,12 +3,9 @@
 # This list will have to be migrated if you wish to use another dependency manager.
 
 # Base tools
-flake8~=3.7
-isort~=5.9
-pre-commit~=2.13.0
+flake8~=4.0.1
+isort~=5.10.1
+pre-commit~=2.17.0
 
 # Flake8 plugins, see https://github.com/python-discord/code-jam-template/tree/main#plugin-list
-flake8-annotations~=2.0
-flake8-bandit~=2.1
-flake8-docstrings~=1.5
-flake8-isort~=4.0
+flake8-docstrings~=1.6.0

samples/Pipfile

@@ -7,15 +7,12 @@ name = "pypi"
 
 [dev-packages]
 # Base tools
-flake8 = "~=3.7"
-isort = "~=5.9"
-pre-commit = "~=2.13.0"
+flake8 = "~=4.0.1"
+isort = "~=5.10.1"
+pre-commit = "~=2.17.0"
 
 # Flake8 plugins, see https://github.com/python-discord/code-jam-template/tree/main#plugin-list
-flake8-annotations = "~=2.0"
-flake8-bandit = "~=2.1"
-flake8-docstrings = "~=1.5"
-flake8-isort = "~=4.0"
+flake8-docstrings = "~=1.6.0"
 
 [requires]
-python_version = "3.9"
+python_version = "3.10"

samples/pyproject.toml

@@ -6,19 +6,16 @@ authors = ["Author 1 <email@mail.com>"]
 license = "MIT"
 
 [tool.poetry.dependencies]
-python = "3.9.*"
+python = "3.10.*"
 
 [tool.poetry.dev-dependencies]
 # Base tools
-flake8 = "~3.7"
-isort = "~5.9"
-pre-commit = "~2.13.0"
+flake8 = "~4.0.1"
+isort = "~5.10.1"
+pre-commit = "~2.17.0"
 
 # Flake8 plugins, see https://github.com/python-discord/code-jam-template/tree/main#plugin-list
-flake8-annotations = "~2.0"
-flake8-bandit = "~2.1"
-flake8-docstrings = "~1.5"
-flake8-isort = "~4.0"
+flake8-docstrings = "~1.6.0"
 
 
 [build-system]

tox.ini

@@ -9,7 +9,7 @@ max-line-length=119
 exclude=.venv,__pycache__
 # Ignore some of the most obnoxious linting errors.
 ignore=
-    B311,W503,E226,S311,T000
+    W503,E226,
     # Missing Docstrings
     D100,D104,D105,D106,D107,
     # Docstring Whitespace
@@ -19,9 +19,7 @@ ignore=
     # Docstring Content
     D400,D401,D402,D404,D405,D406,D407,D408,D409,D410,D411,D412,D413,D414,D416,D417,
     # Comments
-    E266,
-    # Type Annotations
-    ANN002,ANN003,ANN101,ANN102,ANN204,ANN206
+    E266
 
 [isort]
 # Select the 5th style (Hanging grid grouped) to handle longer import.