Merge pull request #764 from roboflow/develop

`supervision-0.18.0` release

.github/workflows/test-min.yml

@@ -20,13 +20,38 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           check-latest: true
-          cache: 'pip'
-          cache-dependency-path: '**/requirements-dev-min.txt'
 
       - name: 📦 Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r .github/requirements-dev-min.txt
+          pip install \
+              attrs==23.1.0 \
+              certifi==2023.7.22 \
+              charset-normalizer==2.0.12 \
+              cycler==0.12.1 \
+              exceptiongroup==1.1.3 \
+              fonttools==4.43.1 \
+              idna==3.4 \
+              iniconfig==2.0.0 \
+              kiwisolver==1.4.5 \
+              matplotlib==3.5.0 \
+              numpy==1.21.2 \
+              opencv-python==4.5.5.64 \
+              packaging==23.2 \
+              pluggy==1.3.0 \
+              pyparsing==3.1.1 \
+              pytest==7.2.0 \
+              python-dateutil==2.8.2 \
+              PyYAML==5.3 \
+              requests==2.26.0 \
+              scipy==1.10.0 \
+              setuptools-scm==8.0.4 \
+              six==1.16.0 \
+              tomli==2.0.1 \
+              tqdm==4.62.3 \
+              typing_extensions==4.8.0 \
+              urllib3==1.26.18 \
+              defusedxml==0.7.1
 
       - name: 🧪 Test
         run: "python -m pytest ./test"

.gitignore

@@ -135,3 +135,24 @@ dmypy.json
 
 # Notebooks
 notebooks/
+
+# OSX folder attributes
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+# Windows
+Thumbs.db
+Desktop.ini
+
+# Linux
+*~
+.directory
+.Trash-*

.pre-commit-config.yaml

@@ -13,13 +13,12 @@ repos:
       - id: trailing-whitespace
         exclude: test/.*\.py
       - id: check-yaml
+        exclude: mkdocs.yml
       - id: check-docstring-first
       - id: check-executables-have-shebangs
       - id: check-toml
       - id: check-case-conflict
       - id: check-added-large-files
-        args: ['--maxkb=2048']
-        exclude: ^logo/
       - id: detect-private-key
       - id: forbid-new-submodules
       - id: pretty-format-json
@@ -28,50 +27,29 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
 
-  # - repo: https://github.com/asottile/pyupgrade
-  #   rev: v3.9.0
-  #   hooks:
-  #     - id: pyupgrade
-  #       name: Upgrade code
-  #       args: [--py38-plus]
-
-
-  - 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'
+      rev: '1.7.6'
       hooks:
       -   id: bandit
           args: ["-c", "pyproject.toml"]
           additional_dependencies: ["bandit[toml]"]
 
   -   repo: https://github.com/pycqa/isort
-      rev: 5.12.0
+      rev: 5.13.2
       hooks:
       -   id: isort
           name: isort (python)
-      -   id: isort
-          name: isort (cython)
-          types: [cython]
       -   id: isort
           name: isort (pyi)
           types: [pyi]
 
 
-  -   repo: https://github.com/psf/black
-      rev: 23.11.0
-      hooks:
-      -   id: black
-
   -   repo: https://github.com/astral-sh/ruff-pre-commit
-      rev: v0.1.6
+      rev: v0.1.14
       hooks:
       -   id: ruff
           args: [--fix, --exit-non-zero-on-fix]
+      -   id: ruff-format
+          types_or: [ python, pyi, jupyter ]

CONTRIBUTING.md

@@ -52,7 +52,7 @@ git push -u origin main
 
 ### Pre-commit tool
 
-This project utilizes the [pre-commit](https://pre-commit.com/) tool to maintain code quality and consistency. Before submitting a pull request or making any commits, it is important to run the pre-commit tool to ensure that your changes meet the project's guidelines.
+This project uses the [pre-commit](https://pre-commit.com/) tool to maintain code quality and consistency. Before submitting a pull request or making any commits, it is important to run the pre-commit tool to ensure that your changes meet the project's guidelines.
 
 Furthermore, we have integrated a pre-commit GitHub Action into our workflow. This means that with every pull request opened, the pre-commit checks will be automatically enforced, streamlining the code review process and ensuring that all contributions adhere to our quality standards.
 
@@ -76,7 +76,6 @@ All new functions and classes in `supervision` should include docstrings. This i
 
 So far, **there is no type checking with mypy**. See [issue](https://github.com/roboflow-ai/template-python/issues/4).
 
-
 Then, go back to your fork of the `supervision` repository, click "Pull Requests", and click "New Pull Request".
 
 ![Opening a pull request](https://media.roboflow.com/open_pr.png)
@@ -109,7 +108,7 @@ PRs must pass all tests and linting requirements before they can be merged.
 
 The `supervision` documentation is stored in a folder called `docs`. The project documentation is built using `mkdocs`.
 
-To run the documentation, install the project requirements with `poetry install dev`. Then, run `mkdocs serve` to start the documentation server.
+To run the documentation, install the project requirements with `poetry install --with dev`. Then, run `mkdocs serve` to start the documentation server.
 
 You can learn more about mkdocs on the [mkdocs website](https://www.mkdocs.org/).