feat: ✨ ruff/python style and pre-commit added for github

Signed-off-by: Onuralp SEZER <[email protected]>

.gitignore

@@ -166,4 +166,4 @@ cython_debug/
 
 # YoloV8 files
 yolov8s-seg.pt
-yolov8s.pt
+yolov8s.pt

.pre-commit-config.yaml

@@ -0,0 +1,54 @@
+
+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.5.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        exclude: test/.*\.py
+      - 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
+        exclude: demo.ipynb
+        args: ['--autofix', '--no-sort-keys', '--indent=4']
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+
+
+
+  -   repo: https://github.com/PyCQA/bandit
+      rev: '1.7.6'
+      hooks:
+      -   id: bandit
+          args: ["-c", "pyproject.toml"]
+          additional_dependencies: ["bandit[toml]"]
+
+  -   repo: https://github.com/pycqa/isort
+      rev: 5.13.0
+      hooks:
+      -   id: isort
+          name: isort (python)
+      -   id: isort
+          name: isort (pyi)
+          types: [pyi]
+
+
+  -   repo: https://github.com/astral-sh/ruff-pre-commit
+      rev: v0.1.7
+      hooks:
+      -   id: ruff
+          args: [--fix, --exit-non-zero-on-fix]
+      -   id: ruff-format
+          types_or: [ python, pyi, jupyter ]

app.py

@@ -22,7 +22,8 @@ DUPLICATE = """
         <img src="https://bit.ly/3gLdBN6" alt="Duplicate Space" style="margin-right: 10px;">
     </a>
 </div>
-"""
+"""  # noqa: E501 title/docs
+
 
 def load_model(img):
     # Load model, get results and return detections/labels
@@ -60,7 +61,7 @@ def annotator(
     colorcir,
     colorlabel,
     colorhalo,
-    colortri
+    colortri,
 ):
     """
     Function that changes the color of annotators
@@ -126,12 +127,12 @@ def annotator(
         # Draw HeatMapAnnotator
         heatmap_annotator = sv.HeatMapAnnotator()
         img = heatmap_annotator.annotate(img, detections=detections)
-    
+
     if "Dot" in annotators:
         # Draw DotAnnotator
         dot_annotator = sv.DotAnnotator()
         img = dot_annotator.annotate(img, detections=detections)
-    
+
     if "Triangle" in annotators:
         # Draw TriangleAnnotator
         tri_annotator = sv.TriangleAnnotator(sv.Color.from_hex(str(colortri)))
@@ -179,7 +180,7 @@ with gr.Blocks(theme=purple_theme) as app:
             "Pixelate",
             "HeatMap",
             "Dot",
-            "Triangle"
+            "Triangle",
         ],
         value=["BoundingBox", "Mask"],
         label="Select Annotators:",

pyproject.toml

@@ -0,0 +1,109 @@
+[tool.isort]
+line_length = 88
+profile = "black"
+
+[tool.bandit]
+target = ["test", "supervision"]
+tests = ["B201", "B301", "B318", "B314", "B303", "B413", "B412", "B410"]
+
+[tool.autoflake]
+check = true
+imports = ["cv2", "supervision"]
+
+
+[tool.black]
+target-version = ["py38"]
+line-length = 88
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+  | docs
+)/
+'''
+
+[tool.ruff]
+target-version = "py38"
+# Enable pycodestyle (`E`) and Pyflakes (`F`) codes by default.
+select = ["E", "F"]
+ignore = []
+
+# Allow autofix for all enabled rules (when `--fix`) is provided.
+fixable = ["A", "B", "C", "D", "E", "F", "G", "I", "N", "Q", "S", "T", "W", "ANN", "ARG", "BLE", "COM", "DJ", "DTZ", "EM", "ERA", "EXE", "FBT", "ICN", "INP", "ISC", "NPY", "PD", "PGH", "PIE", "PL", "PT", "PTH", "PYI", "RET", "RSE", "RUF", "SIM", "SLF", "TCH", "TID", "TRY", "UP", "YTT"]
+unfixable = []
+
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "venv",
+    "yarn-error.log",
+    "yarn.lock",
+    "docs",
+]
+
+# Same as Black.
+line-length = 88
+indent-width = 4
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.flake8-quotes]
+inline-quotes = "double"
+multiline-quotes = "double"
+docstring-quotes = "double"
+
+[tool.ruff.pydocstyle]
+convention = "google"
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["E402","F401"]
+"supervision/assets/list.py" = ["E501"]
+
+[tool.ruff.lint.mccabe]
+# Flag errors (`C901`) whenever the complexity level exceeds 5.
+max-complexity = 20
+
+
+[tool.ruff.pylint]
+max-args = 20
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"