feat: add documentation, enable makefile driven usage

This introduces a One-Stop-Shop Makefile.

Also brings back tensorflow as dependency, it is still needed
This commit is contained in:
Daniel Molkentin
2024-09-10 20:34:37 +02:00
committed by drbacke
parent c9bf0ecd36
commit e54f14bea1
4 changed files with 92 additions and 4 deletions

38
Makefile Normal file
View File

@@ -0,0 +1,38 @@
# Define the targets
.PHONY: help venv pip docs clean
# Default target
all: help
# Target to display help information
help:
@echo "Available targets:"
@echo " venv - Set up a Python 3 virtual environment."
@echo " pip - Install dependencies from requirements.txt."
@echo " docs - Generate HTML documentation using pdoc."
@echo " run - Run flask_server.py in the virtual environment."
@echo " clean - Remove generated documentation and virtual environment."
# Target to set up a Python 3 virtual environment
venv:
python3 -m venv .venv
@echo "Virtual environment created in '.venv'. Activate it using 'source .venv/bin/activate'."
# Target to install dependencies from requirements.txt
pip: venv
.venv/bin/pip install -r requirements.txt
@echo "Dependencies installed from requirements.txt."
# Target to generate HTML documentation
docs: pip
pdoc --html --force modules -o docs
# Clean target to remove generated documentation and virtual environment
clean:
@echo "Cleaning virtual env and documentation directories"
rm -rf docs
rm -rf .venv
run:
@echo "Starting flask server, please wait..."
.venv/bin/python ./flask_server.py