Merge pull request #5 from runemalm/feature/next-version

Release version 1.0.0-alpha.7

Author: runemalm

.github/workflows/feature.yml

@@ -6,6 +6,21 @@ on:
       - 'feature/*'
 
 jobs:
+  pre-commit:
+    name: Run pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.7'
+
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.1
+
   unittests:
     name: Run tests
     runs-on: ubuntu-latest
@@ -18,7 +33,7 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-      
+
       - name: Run unittests
         uses: ./.github/actions/unittests
         with:

.github/workflows/master.yml

@@ -7,6 +7,22 @@ on:
   workflow_dispatch:
 
 jobs:
+  pre-commit:
+    name: Run pre-commit
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.7'
+
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.1
+
   unittests:
     name: Run unittests
     runs-on: ubuntu-latest
@@ -19,7 +35,7 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-      
+
       - name: Run unittests
         uses: ./.github/actions/unittests
         with:
@@ -71,7 +87,7 @@ jobs:
           version=$(grep -Eo "version=['\"]([^'\"]+)['\"]" setup.py | awk -F"'" '{print $2}')
           echo "Using version: $version"
           echo "::set-output name=RELEASE_VERSION::$version"
-      
+
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
@@ -84,7 +100,7 @@ jobs:
         run: |
           git config --global user.name "${{ github.actor }}"
           git config --global user.email "${{ github.actor }}@users.noreply.github.com"
-          
+
       - name: Create and push tag
         run: |
           git tag -a v${{ steps.extract-version.outputs.RELEASE_VERSION }} -m "Release version v${{ steps.extract-version.outputs.RELEASE_VERSION }}"

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0  # Use the latest version
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 22.3.0  # Use the latest version
+    hooks:
+      - id: black
+        args: ["--line-length=88"]  # Adjust line length as needed
+        language_version: python3.7
+  - repo: https://github.com/pycqa/flake8
+    rev: 4.0.1  # Use the latest version
+    hooks:
+      - id: flake8
+        args: ['--max-line-length=88']

Makefile

@@ -73,13 +73,37 @@ sphinx-rebuild: ## re-build the sphinx docs
 sphinx-autobuild: ## activate autobuild of docs
 	pipenv run sphinx-autobuild docs docs/_build/html --watch $(SRC)
 
+################################################################################
+# FORMAT & LINT
+################################################################################
+
+.PHONY: black
+black: ## run black auto-formatting
+	pipenv run black $(SRC) $(TESTS) --line-length=88
+
+.PHONY: black-check
+black-check: ## check code don't violate black formatting rules
+	pipenv run black --check $(SRC) --line-length=88
+
+.PHONY: flake
+flake: ## lint code with flake
+	pipenv run flake8 $(SRC)
+
+.PHONY: pre-commit-install
+pre-commit-install: ## install the pre-commit git hook
+	pipenv run pre-commit install
+
+.PHONY: pre-commit-run
+pre-commit-run: ## run the pre-commit hooks
+	pipenv run pre-commit run --all-files
+
 ################################################################################
 # PIPENV
 ################################################################################
 
 .PHONY: pipenv-install
 pipenv-install: ## setup the virtual environment
-	pipenv --python 3.7 install --dev
+	pipenv install --dev
 
 .PHONY: pipenv-packages-install
 pipenv-packages-install: ## install a package (uses PACKAGE)

Pipfile

@@ -14,6 +14,10 @@ sphinxcontrib-napoleon = "0.7"
 wheel = "0.41.2"
 pytest-xdist = "*"
 bump2version = "*"
+black = "*"
+flake8 = "*"
+importlib-metadata = "==4.13.0"
+pre-commit = "*"
 
 [requires]
-python_version = ">=3.7"
+python_version = "3.7.17"