Merge pull request #188 from onuralpszr/pre-commit

feat: ✨ bring pre-commit and tests from supervision

Author: tonylampada

.github/workflows/publish.yml

@@ -12,21 +12,21 @@ jobs:
         python-version: [3.8]
     steps:
       - name: 🛎️ Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
       - name: 🐍 Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: 🦾 Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install ".[dev]"
       - name: 🚀 Publish to PyPi
-        env: 
+        env:
           PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
           PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
           PYPI_TEST_PASSWORD: ${{ secrets.PYPI_TEST_PASSWORD }}
         run: |
-          make publish -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -e PYPI_TEST_PASSWORD=$PYPI_TEST_PASSWORD
+          make publish -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -e PYPI_TEST_PASSWORD=$PYPI_TEST_PASSWORD

.github/workflows/test.yml

@@ -11,16 +11,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.8, 3.9]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - name: 🛎️ Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.ref }}
           repository: ${{ github.event.pull_request.head.repo.full_name }}
       - name: 🐍 Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: 🦾 Install dependencies
@@ -31,8 +31,8 @@ jobs:
         run: |
           make check_code_quality
       - name: 🧪 Test
-        env: 
+        env:
           ROBOFLOW_API_KEY: ${{ secrets.ROBOFLOW_API_KEY }}
           PROJECT_NAME: ${{ secrets.PROJECT_NAME }}
           PROJECT_VERSION: ${{ secrets.PROJECT_VERSION }}
-        run: "python -m unittest"
+        run: "python -m unittest"

.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+ci:
+  autofix_prs: true
+  autoupdate_schedule: weekly
+  autofix_commit_msg: "fix(pre_commit): 🎨 auto format pre-commit hooks"
+  autoupdate_commit_msg: "chore(pre_commit): ⬆ pre_commit autoupdate"
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-docstring-first
+      - id: check-executables-have-shebangs
+      - id: check-toml
+      - id: check-case-conflict
+      - id: check-added-large-files
+      - id: detect-private-key
+      - id: forbid-new-submodules
+      - id: pretty-format-json
+        args: ['--autofix', '--no-sort-keys', '--indent=4']
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: Sort imports
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        name: Flake8 Checks
+        entry: flake8
+        additional_dependencies: [Flake8-pyproject]
+
+
+  -   repo: https://github.com/PyCQA/bandit
+      rev: '1.7.5'
+      hooks:
+      -   id: bandit
+          args: ["-c", "pyproject.toml"]
+          additional_dependencies: ["bandit[toml]"]
+
+  -   repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.0.288
+      hooks:
+      -   id: ruff
+          args: [--fix, --exit-non-zero-on-fix]

.vscode/settings.json

@@ -17,4 +17,4 @@
     "python.formatting.provider": "none",
     "python.testing.pytestEnabled": false,
     "editor.inlineSuggest.showToolbar": "onHover"
-}
+}

CHANGELOG.md

@@ -4,4 +4,4 @@ All notable changes to this project will be documented in this file.
 
 ## 1.1.5
 
-[stub]
+[stub]

CITATION.cff

@@ -17,4 +17,4 @@ abstract: >-
 keywords:
   - computer vision
   - image processing
-license: MIT
+license: MIT

Makefile

@@ -12,10 +12,10 @@ check_code_quality:
 	isort --check-only --profile black $(check_dirs)
 	# stop the build if there are Python syntax errors or undefined names
 	flake8 $(check_dirs) --count --select=E9,F63,F7,F82 --show-source --statistics
-	# exit-zero treats all errors as warnings. E203 for black, E501 for docstring, W503 for line breaks before logical operators 
+	# exit-zero treats all errors as warnings. E203 for black, E501 for docstring, W503 for line breaks before logical operators
 	flake8 $(check_dirs) --count --max-line-length=88 --exit-zero  --ignore=D --extend-ignore=E203,E501,W503  --statistics
-	
+
 publish:
 	python setup.py sdist bdist_wheel
 	twine check dist/*
-	twine upload dist/* -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} --verbose 
+	twine upload dist/* -u ${PYPI_USERNAME} -p ${PYPI_PASSWORD} --verbose

docs/core/dataset.md

@@ -1 +1 @@
-:::roboflow.core.dataset
+:::roboflow.core.dataset

docs/core/model.md

@@ -1 +1 @@
-:::roboflow.core.model
+:::roboflow.core.model

docs/core/project.md

@@ -1 +1 @@
-:::roboflow.core.project
+:::roboflow.core.project