Release

Co-authored-by: AdrianOrenstein <adrian.orenstein@gmail.com>
Co-authored-by: MatthewHowe <matthew.rob.howe@gmail.com>

Author: 3 people

.gitignore

@@ -0,0 +1,171 @@
+test/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# conda env
+envs
+.obsidian
+.DS_Store
+
+# tracks stuff
+tracks/**/*.zip
+tracks/**/*.exe
+
+tracks/**/*.ini_
+tracks/**/*.candidate
+tracks/**/*.opt
+
+tracks/**/*.ini
+tracks/**/*.dds
+tracks/**/*.png
+tracks/**/*.jpg
+tracks/**/*.ai
+tracks/**/*.kn5
+tracks/**/*.csv
+tracks/**/*.json
+tracks/**/*.fbx
+tracks/**/*.mtl
+tracks/**/*.obj
+
+# recording stuffs
+recordings/**/*.npy
+recordings/**/*.jpeg
+recordings/**/*.zip
+recordings/**/*.bin
+
+# benchmark
+.benchmarks/
+
+# analysis
+src/analysis/imgs
+
+segmentors
+envs/

.pre-push-config.yaml

@@ -0,0 +1,31 @@
+repos:
+  - repo: local
+    hooks:
+      - id: black
+        name: Code Prettifier - Black
+        entry: ./envs/bin/python3.9 -m black "src/"
+        language_version: python3.9
+        language: python
+        pass_filenames: false
+
+      - id: flake8
+        name: Code Linter - Flake8
+        entry: ./envs/bin/python3.9 -m flake8 "src/"
+        args: ['--config=linters/flake8.ini']
+        language: python
+        pass_filenames: false
+  
+      - id: isort
+        name: Import Sorter - isort
+        entry: ./envs/bin/python3.9 -m isort "src/"
+        args: ['--settings-path=linters/isort.ini']
+        language: python
+        pass_filenames: false
+
+      - id: pytest
+        name: Automated Unit Tests - PyTest
+        entry: ./envs/bin/python3.9 -m pytest "src/" -m "not benchmark and not gpu" 
+        args: ['--workers=4']
+        language: system
+        pass_filenames: false
+        always_run: true