Added pre-commit configuration file (#41)

* Added pre-commit configuration file

* Added pre-commit installing instructions in README.md

* Added github action for running linter

* Linted project files

.github/workflows/main.yml

@@ -0,0 +1,15 @@
+---
+name: pre-commit
+
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: pre-commit/action@v3.0.1

.gitignore

@@ -1,2 +1,2 @@
 isaac_ws/datasets/**
-model/*
+model/*

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+---
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.8.0
+    hooks:
+      - id: black
+        args: [--safe, --quiet]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.1.1
+    hooks:
+      - id: flake8
+        language_version: python3
+        additional_dependencies:
+          - flake8-docstrings==1.5.0
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+        args: [--strict]

README.md

@@ -16,6 +16,20 @@ We recommend reading this [article](https://docs.omniverse.nvidia.com/isaacsim/l
 
 > **NOTE:** this project is disk savvy, make sure to have tens of GBs (~50GB) available of free disk space.
 
+## Contributing
+
+This projects uses pre-commit hooks for linting. To install and make sure they are run when committing:
+
+```bash
+python3 -m pip install -U pre-commit
+pre-commit install
+```
+
+If you want to run the linters but still not ready to commit you can run:
+
+```bash
+pre-commit run --all-files
+```
 
 # Using the different docker components
 
@@ -32,8 +46,8 @@ The available profiles are:
 - `detection`: loads the detection stack.
 - `visualization`: loads RQt to visualize the input and output image processing.
 - `test_camera`: loads the usb_cam driver that makes a connected webcam to publish. Useful when the Olive Camera is not available.
-- `simulation`: loads the simulation NVidia Isaac Omniverse. 
-- `dataset_gen`: generates a training dataset using NVidia Isaac Omniverse. 
+- `simulation`: loads the simulation NVidia Isaac Omniverse.
+- `dataset_gen`: generates a training dataset using NVidia Isaac Omniverse.
 > TBD
 
 Compound profiles are:
@@ -118,7 +132,7 @@ The following .gif video shows pictures where the ground plane conditions color
 
 ![Dataset gen](./doc/dataset_gen.gif)
 
-And once it finishes (note the scene does not evolve anymore) check the generated folder under `isaac_ws/datasets/YYYYMMDDHHMMSS_out_fruit_sdg` where `YYYYMMDDHHMMSS` is the stamp of the dataset creation. 
+And once it finishes (note the scene does not evolve anymore) check the generated folder under `isaac_ws/datasets/YYYYMMDDHHMMSS_out_fruit_sdg` where `YYYYMMDDHHMMSS` is the stamp of the dataset creation.
 
 
 # FAQs
@@ -131,4 +145,4 @@ Your good old friend `docker system prune` and the more agressive `docker system
 
 ```bash
 xhost +si:localuser:root
-```
+```

detection_ws/src/fruit_detection/fruit_detection/__init__.py

@@ -0,0 +1 @@
+"""Fruit detection module."""