FEAT: Update Python project (#3)

#### CHANGELOG

* chore: update project configuration to meet modern standards
* docs: relocate notes and update README
* chore: apply formatting rules to entire project
* chore: update github workflow to use ruff

---------

Co-authored-by: Rudy Puig <[email protected]>

Author: rudisimo

.flake8

@@ -4,9 +4,6 @@ on:
   pull_request:
     branches:
       - 'main'
-  push:
-    branches:
-      - main
 
 jobs:
   build:
@@ -22,14 +19,17 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+          cache: pip
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install .[dev,test]
+          python -m pip install --quiet --upgrade pip setuptools
+          python -m pip install --editable '.[dev,test]'
+
       - name: Run linting
-        run: |
-          python -m flake8 -v --config .flake8 --black-config pyproject.toml --show-source
         continue-on-error: true
+        run: |
+          python -m ruff check -q --diff --output-format=full .
+          python -m ruff format -q --diff --check .
       - name: Run unit tests
         run: |
           python -m pytest -vvv --cov --cov-context=test --cov-report=xml

.github/workflows/build.yaml

@@ -1,33 +1,33 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
-  - repo: https://github.com/PyCQA/autoflake
-    rev: 'v1.7.8'
-    hooks:
-      - id: autoflake
-        args:
-          - "--in-place"
-
-  - repo: https://github.com/PyCQA/isort
-    rev: '5.11.5'
-    hooks:
-      - id: isort
-
-  - repo: https://github.com/psf/black
-    rev: '22.12.0'
-    hooks:
-      - id: black
-
-  - repo: https://github.com/PyCQA/flake8
-    rev: '5.0.4'
-    hooks:
-      - id: flake8
-
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: 'v4.5.0'
+    rev: 'v4.6.0'
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
-      - id: check-yaml
       - id: check-ast
       - id: check-toml
+      - id: check-yaml
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.2
+    hooks:
+      # run the linter
+      - id: ruff
+      # run the formatter
+      - id: ruff-format

.pre-commit-config.yaml

@@ -13,19 +13,14 @@ Create a virtual environment:
 ```bash
 python3 -m venv .venv
 source .venv/bin/activate
-```
-
-Install dependencies:
-
-```bash
 python3 -m pip install -U pip setuptools
 python3 -m pip install -e '.[test]'
 ```
 
-Check all answers for 2022:
+Check all answers for 2024:
 
 ```bash
-pytest --cov=. -k 2022
+python3 -m pytest --cov=. -k 2024
 ```
 
 ## License