Merge pull request #1 from pamelafox/ruff-updates

Ruff and 3.10 updates

Author: pamelafox

.github/dependabot.yaml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/python.yaml

@@ -14,24 +14,15 @@ jobs:
         - name: Set up Python 3
           uses: actions/setup-python@v3
           with:
-            python-version: 3.9
+            python-version: "3.10"
         - name: Install dependencies
           run: |
             python -m pip install --upgrade pip
             pip install -r requirements-dev.txt
         - name: Lint with ruff
-          run: |
-            ruff . --select=E9,F63,F7,F82
-            ruff . --exit-zero
-        - name: Check pyupgrade
-          run: pyupgrade --py310-plus *.py tests/*.py
+          run: ruff .
         - name: Check formatting with black
-          uses: psf/black@stable
-          with:
-            src: ". tests/"
-            options: "--check --verbose"
-        - name: Check Python import sorting
-          run: isort --check .
+          run: black . --check --verbose
         - name: Run unit tests
           run: |
             pytest

.pre-commit-config.yaml

@@ -1,26 +1,16 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v4.4.0
     hooks:
     -   id: check-yaml
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
+-   repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.252
+    hooks:
+    -   id: ruff
 -   repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 23.1.0
     hooks:
     -   id: black
         args: ['--config=./pyproject.toml']
--   repo: https://github.com/pycqa/isort
-    rev: 5.10.1
-    hooks:
-      - id: isort
-        name: isort (python)
--   repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.116
-    hooks:
-      - id: ruff
--   repo: https://github.com/asottile/pyupgrade
-    rev: v3.1.0
-    hooks:
-    -   id: pyupgrade
-        args: ['--py310-plus']

README.md

@@ -2,18 +2,16 @@
 
 This is a template repository for any Python project that comes with the following dev tools:
 
+* `ruff`: identifies many errors and style issues (`flake8`, `isort`, `pyupgrade`)
 * `black`: auto-formats code
-* `isort`: sorts the imports
-* `ruff`: looks for common errors
-* `pyupgrade`: upgrades Python syntax
 
-All of those checks are run as pre-commit hooks using the `pre-commit` library.
+Those checks are run as pre-commit hooks using the `pre-commit` library.
 
 It includes `pytest` for testing plus the `pytest-cov` plugin to measure coverage.
 
 The checks and tests are all run using Github actions on every pull request and merge to main.
 
-This repository is setup for Python 3.10. To customize that, change the `VARIANT` argument in `.devcontainer/devcontainer.json`, and change the flag passed into `pyupgrade` in `.precommit-config.yaml` and `.github/workflows/python.yaml`.
+This repository is setup for Python 3.10. To customize that, change the `VARIANT` argument in `.devcontainer/devcontainer.json`, change the config options in `.precommit-config.yaml` and change the version number in `.github/workflows/python.yaml`.
 
 ## Development instructions
 
@@ -35,7 +33,7 @@ source .venv/bin/activate
 Then install the dev tools and pre-commit hooks:
 
 ```
-pip3 install --user -r requirements-dev.txt
+python3 -m pip install --user -r requirements-dev.txt
 pre-commit install
 ```
 
@@ -45,10 +43,10 @@ This repository starts with a very simple `main.py` and a test for it at `tests/
 You'll want to replace that with your own code, and you'll probably want to add additional files
 as your code grows in complexity.
 
-When you're ready to run tests, just run:
+When you're ready to run tests, run:
 
 ```
-pytest
+python3 -m pytest
 ```
 
 # File breakdown

pyproject.toml

@@ -1,19 +1,18 @@
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+select = ["E", "F", "I", "UP"]
+ignore = ["D203"]
+show-source = true
+
 [tool.black]
 line-length = 100
-target-version = ['py39']
+target-version = ["py310"]
+
+[tool.pylint.messages_control]
+disable = "C0114,C0115,C0116"
 
 [tool.pytest.ini_options]
 addopts = "-ra --cov"
 testpaths = ["tests"]
 pythonpath = ['.']
-
-[tool.pylint.messages_control]
-disable = "C0114,C0115,C0116"
-
-[tool.isort]
-profile = "black"
-
-[tool.ruff]
-line-length = 100
-ignore = ["D203"]
-show-source = true

requirements-dev.txt

@@ -1,9 +1,7 @@
 -r requirements.txt
 pre-commit
-black
-isort
 ruff
-pyupgrade
+black
 pytest
 coverage
 pytest-cov