Merge pull request #2 from python-discord/global-actions

Global Actions

Author: HassanAbouelela

.github/workflows/lint.yaml

@@ -31,44 +31,5 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
-      # This step caches our Python dependencies. To make sure we
-      # only restore a cache when the dependencies, the python version and
-      # the runner operating system we create a cache key
-      # that is a composite of those states.
-      # Only when the context is exactly the same, we will restore the cache.
-      - name: Restore pip cache
-        uses: actions/cache@v2
-        with:
-          path: ${{ env.PIP_CACHE_DIR }}
-          key: "python-pip-${{ runner.os }}-\
-          ${{ steps.python.outputs.python-version }}-\
-          ${{ hashFiles('./Pipfile', './Pipfile.lock') }}"
-
-      # Uncomment the step that matches your setup.
-
-      # Default Env setup
-      - name: Run hooks through our requirement file
-        run: |
-          pip install -r dev-requirements.txt
-          pre-commit run --all-files
-        env:
-          # Force pre-commit to do a system install.
-          PIP_USER: 0
-
-        # Pipenv setup
-        # - name: Run hooks through our Pipenv environment.
-        #  run: |
-        #    pipenv install --system --dev
-        #    pipenv run python -m pre-commit run --all-files
-        #  env:
-        #    # Force pre-commit to do a system install.
-        #    PIP_USER: 0
-
-        # Poetry setup
-        # - name: Run hooks through our Poetry environment.
-        #  run: |
-        #    poetry install
-        #    poetry run python -m pre-commit run --all-files
-        #  env:
-        #    # Force pre-commit to do a system install.
-        #    PIP_USER: 0
+      - name: Run pre-commit hooks.
+        uses: pre-commit/action@v2.0.3

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ## Pre-commit setup
 # See https://github.com/python-discord/code-jam-template/tree/main#pre-commit-run-linting-before-committing
-#
-# Please uncomment the right lines depending on your setup.
+
+# Make sure to edit the `additional_dependencies` list if you want to add plugins
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -12,25 +12,23 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
+
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.5.1
     hooks:
       - id: python-check-blanket-noqa
-  - repo: local
+
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.9.2
     hooks:
       - id: isort
-        name: ISort
-        entry: python -m isort .  # Default Env setup
-        # entry: pipenv run python -m isort .  # Pipenv setup
-        # entry: poetry run python -m isort .  # Poetry setup
-        language: system
-        types: [python]
-        require_serial: true
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
       - id: flake8
-        name: Flake8
-        entry: python -m flake8  # Default Env setup
-        # entry: pipenv run python -m flake8  # Pipenv setup
-        # entry: poetry run python -m flake8  # Poetry setup
-        language: system
-        types: [python]
-        require_serial: true
+        additional_dependencies:
+          - flake8-annotations~=2.0
+          - flake8-bandit~=2.1
+          - flake8-docstrings~=1.5
+          - flake8-isort~=4.0

README.md

@@ -85,8 +85,6 @@ It is *installed* by running `pre-commit install` and can be run manually by cal
 - `isort`: Runs ISort.
 - `flake8`: Runs flake8.
 
-The last two hooks won't ship with their own environment but will rather run shell commands. You will have to modify them if you change your dependency manager.
-
 ## How do I use it?
 
 ### Creating your Team Repository
@@ -168,7 +166,8 @@ Once the environment is activated, all the commands listed previously should wor
 
 If you wish to use Pipenv or Poetry, you will have to move the dependencies in `dev-requirements.txt` to the development dependencies of your tool.
 
-Additionally, you will have to open `.pre-commit-config.yaml` and `.github/workflows/lint.yaml` and uncomment the right section.
+We've included a porting of `dev-requirements.txt` to both [poetry](./samples/pyproject.toml) and [pipenv](./samples/Pipfile) in the [samples folder](./samples).
+If you use the poetry setup, make sure to change the project name, description, and authors at the top of the file.
 
 When installing new dependencies, don't forget to [pin them](https://pip.pypa.io/en/stable/user_guide/#pinned-version-numbers) by adding a version tag at the end.
 For example, if I wish to install `Click`, a quick look at [PyPI](https://pypi.org/project/click/) tells me that 8.0.1 is the latest version.

samples/Pipfile

@@ -0,0 +1,21 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+# Base tools
+flake8 = "~=3.7"
+isort = "~=5.9"
+pre-commit = "~=2.13.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"
+
+[requires]
+python_version = "3.9"

samples/pyproject.toml

@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "Name"
+version = "0.1.0"
+description = ""
+authors = ["Author 1 <email@mail.com>"]
+license = "MIT"
+
+[tool.poetry.dependencies]
+python = "3.9.*"
+
+[tool.poetry.dev-dependencies]
+# Base tools
+flake8 = "~3.7"
+isort = "~5.9"
+pre-commit = "~2.13.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"
+
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"