#Alcohol Intoxication #Facial Recognition #CLI
|
|
|
It is recommended to use uv to create a virtual environment and pip install the following package.
pip install sober-scanTo run the application, simply type:
sober-scan
# or
sober-scan --help-
Clone the repository and navigate to project folder:
git clone https://github.com/Sang-Buster/Sober-Scan cd Sober-Scan -
Install uv first:
# macOS/Linux curl -LsSf https://astral.sh/uv/install.sh | sh
# Windows powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
-
Create a virtual environment at
Sober-Scan/.venv/:uv venv --python 3.10
-
Activate the virtual environment:
# macOS/Linux source .venv/bin/activate
# Windows .venv\Scripts\activate -
Install the required packages:
uv pip install -e . -
Install ruff and pre-commit:
uv pip install ruff pre-commit
ruffis a super fast Python linter and formatter.pre-commithelps maintain code quality by running automated checks before commits are made.
-
Install git hooks:
pre-commit install --hook-type commit-msg --hook-type pre-commit --hook-type pre-push
These hooks perform different checks at various stages:
commit-msg: Ensures commit messages follow the conventional formatpre-commit: Runs Ruff linting and formatting checks before each commitpre-push: Performs final validation before pushing to remote
-
Code Linting:
ruff check ruff check --fix ruff check --select I ruff check --select I --fix ruff format
-
Run the application:
uv run src/sober_scan/cli.py
📂Sober-Scan
┣ 📂src // Source Code
┃ ┗ 📦sober_scan // Python package
┃ ┃ ┣ 📂commands // Command line interface
┃ ┃ ┃ ┣ 📄detect.py
┃ ┃ ┃ ┣ 📄model.py
┃ ┃ ┃ ┗ 📄train.py
┃ ┃ ┣ 📂models // Model files
┃ ┃ ┃ ┣ 📄cnn.py
┃ ┃ ┃ ┣ 📄knn.py
┃ ┃ ┃ ┣ 📄nb.py
┃ ┃ ┃ ┣ 📄rf.py
┃ ┃ ┃ ┗ 📄svm.py
┃ ┃ ┣ 📂tests // Test files
┃ ┃ ┃ ┗ 📄test_cli.py
┃ ┃ ┣ 📄cli.py // CLI interface
┃ ┃ ┣ 📄config.py // Configuration
┃ ┃ ┣ 📄feature_extraction.py // Feature extraction
┃ ┃ ┗ 📄utils.py // Utility functions
┣ 📄.gitignore // Git ignore patterns (env, cache, database)
┣ 📄.pre-commit-config.yaml // Pre-commit hooks (ruff, commit message)
┣ 📄.pre-commit_msg_template.py // Commit message format validator
┣ 📄.python-version // Python version
┣ 📄LICENSE // MIT License
┣ 📄README.md // Project documentation
┣ 📄pyproject.toml // Project configuration
┗ 📄uv.lock // Lock file