supervision-0.24.0 release

.github/workflows/publish-test.yml

@@ -1,4 +1,4 @@
-name: Supervision Test Releases to PyPi
+name: Publish Supervision Pre-Releases to PyPI and TestPyPI
 on:
  push:
  tags:
@@ -9,9 +9,11 @@ on:
  workflow_dispatch:
 
 jobs:
- build-n-publish:
+ build-and-publish-pre-release-pypi:
  name: Build and publish to PyPI
  runs-on: ubuntu-latest
+ permissions:
+ id-token: write
  strategy:
  matrix:
  python-version: ["3.10"]
@@ -30,14 +32,11 @@ jobs:
  python -m pip install --upgrade build twine
  python -m build
  twine check --strict dist/*
- - name: 🚀 Publish distribution to PyPI
- uses: pypa/gh-action-pypi-publish@release/v1
- with:
- user: ${{ secrets.PYPI_USERNAME }}
- password: ${{ secrets.PYPI_PASSWORD }}
+
+ - name: 🚀 Publish to PyPi
+ uses: pypa/gh-action-pypi-publish@release/v1.10
+
  - name: 🚀 Publish to Test-PyPi
- uses: pypa/gh-action-pypi-publish@release/v1
+ uses: pypa/gh-action-pypi-publish@release/v1.10
  with:
  repository-url: https://test.pypi.org/legacy/
- user: ${{ secrets.PYPI_TEST_USERNAME }}
- password: ${{ secrets.PYPI_TEST_PASSWORD }}

.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Supervision Releases to PyPi
+name: Publish Supervision Releases to PyPI and TestPyPI
 on:
  push:
  tags:
@@ -7,8 +7,10 @@ on:
  workflow_dispatch:
 
 jobs:
- build:
+ build-and-publish-pre-release:
  runs-on: ubuntu-latest
+ permissions:
+ id-token: write
  strategy:
  matrix:
  python-version: ["3.10"]
@@ -27,14 +29,11 @@ jobs:
  python -m pip install --upgrade build twine
  python -m build
  twine check --strict dist/*
+
  - name: 🚀 Publish to PyPi
- uses: pypa/gh-action-pypi-publish@release/v1
- with:
- user: ${{ secrets.PYPI_USERNAME }}
- password: ${{ secrets.PYPI_PASSWORD }}
+ uses: pypa/gh-action-pypi-publish@release/v1.10
+
  - name: 🚀 Publish to Test-PyPi
- uses: pypa/gh-action-pypi-publish@release/v1
+ uses: pypa/gh-action-pypi-publish@release/v1.10
  with:
  repository-url: https://test.pypi.org/legacy/
- user: ${{ secrets.PYPI_TEST_USERNAME }}
- password: ${{ secrets.PYPI_TEST_PASSWORD }}

.pre-commit-config.yaml

@@ -25,16 +25,31 @@ repos:
  - id: mixed-line-ending
 
  - repo: https://github.com/PyCQA/bandit
- rev: '1.7.9'
+ rev: '1.7.10'
  hooks:
  - id: bandit
  args: ["-c", "pyproject.toml"]
  additional_dependencies: ["bandit[toml]"]
 
  - repo: https://github.com/astral-sh/ruff-pre-commit
- rev: v0.6.2
+ rev: v0.6.8
  hooks:
  - id: ruff
  args: [--fix, --exit-non-zero-on-fix]
  - id: ruff-format
  types_or: [ python, pyi, jupyter ]
+
+ # - repo: https://github.com/executablebooks/mdformat
+ # rev: 0.7.17
+ # hooks:
+ # - id: mdformat
+ # additional_dependencies:
+ # - "mdformat-mkdocs[recommended]>=2.1.0"
+ # args: ["--number"]
+
+ - repo: https://github.com/codespell-project/codespell
+ rev: v2.3.0
+ hooks:
+ - id: codespell
+ additional_dependencies:
+ - tomli

CODE_OF_CONDUCT.md

@@ -1,12 +1,11 @@
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
+identity and expression, level of experience, education, socioeconomic status,
 nationality, personal appearance, race, caste, color, religion, or sexual
 identity and orientation.
 
@@ -18,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
+- Focusing on what is best not just for us as individuals, but for the overall
  community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or advances of
+- The use of sexualized language or imagery, and sexual attention or advances of
  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
  professional setting
 
 ## Enforcement Responsibilities
@@ -121,14 +120,14 @@ version 2.1, available at
 [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 
 Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
 
 For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
 [https://www.contributor-covenant.org/translations][translations].
 
+[faq]: https://www.contributor-covenant.org/faq
 [homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
+[mozilla coc]: https://github.com/mozilla/diversity
 [translations]: https://www.contributor-covenant.org/translations
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

CONTRIBUTING.md

@@ -6,22 +6,22 @@ We are actively improving this library to reduce the amount of work you need to
 
 ## Code of Conduct
 
-Please read and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). This document outlines the expected behavior for all participants in our project.
+Please read and adhere to our [Code of Conduct](https://supervision.roboflow.com/latest/code_of_conduct/). This document outlines the expected behavior for all participants in our project.
 
 ## Table of Contents
 
 - [Contribution Guidelines](#contribution-guidelines)
- - [Contributing Features](#contributing-features-)
+  - [Contributing Features](#contributing-features)
 - [How to Contribute Changes](#how-to-contribute-changes)
 - [Installation for Contributors](#installation-for-contributors)
-- [Code Style and Quality](#-code-style-and-quality)
- - [Pre-commit tool](#pre-commit-tool)
- - [Docstrings](#docstrings)
- - [Type checking](#type-checking)
-- [Documentation](#-documentation)
-- [Cookbooks](#-cookbooks)
-- [Tests](#-tests)
-- [License](#-license)
+- [Code Style and Quality](#code-style-and-quality)
+  - [Pre-commit tool](#pre-commit-tool)
+  - [Docstrings](#docstrings)
+  - [Type checking](#type-checking)
+- [Documentation](#documentation)
+- [Cookbooks](#cookbooks)
+- [Tests](#tests)
+- [License](#license)
 
 ## Contribution Guidelines
 
@@ -83,9 +83,10 @@ git push -u origin <your_branch_name>
 
 Use conventional commit messages to clearly describe your changes. The format is:
 
-<type>[optional scope]: <description>
+<type>\[optional scope\]: <description>
 
 Common types include:
+
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
@@ -128,40 +129,47 @@ PRs must pass all tests and linting requirements before they can be merged.
 Before starting your work on the project, set up your development environment:
 
 1. Clone your fork of the project:
- ```bash
- git clone https://github.com/YOUR_USERNAME/supervision.git
- cd supervision
- ```
- Replace `YOUR_USERNAME` with your GitHub username.
+
+ ```bash
+ git clone https://github.com/YOUR_USERNAME/supervision.git
+ cd supervision
+ ```
+
+ Replace `YOUR_USERNAME` with your GitHub username.
 
 2. Create and activate a virtual environment:
- ```bash
- python3 -m venv .venv
- source .venv/bin/activate
- ```
+
+ ```bash
+ python3 -m venv .venv
+ source .venv/bin/activate
+ ```
 
 3. Install Poetry:
 
- Using pip:
- ```bash
- pip install -U pip setuptools
- pip install poetry
- ```
+ Using pip:
 
- Or using pipx (recommended for global installation):
- ```bash
- pipx install poetry
- ```
+ ```bash
+ pip install -U pip setuptools
+ pip install poetry
+ ```
+
+ Or using pipx (recommended for global installation):
+
+ ```bash
+ pipx install poetry
+ ```
 
 4. Install project dependencies:
- ```bash
- poetry install
- ```
+
+ ```bash
+ poetry install
+ ```
 
 5. Run pytest to verify the setup:
- ```bash
- poetry run pytest
- ```
+
+ ```bash
+ poetry run pytest
+ ```
 
 ## 🎨 Code Style and Quality