README_project.md

PROJECT_NAME_URL

A one-liner description of your project goes here.

A longer paragraph description of your project goes here.

Install

* activate:        Activates the virtual environment.
* clean:           Cleans the environment, Overwrites the pyproject.toml file
* create:          Inits the poetry virtual environment and installs baseline packages.
* deps:            Install the dependencies.
* install:         installs the poetry environment with dependencies.
* lint:            Lints the project using ruff --fix
* release:         uses pyinstaller to package your Python application into a single package
* run:             Run the script main.py
* test:            Tests the project.
* update:          updates dependency versions
* vulncheck:        Checks for vulnerabilities in the project

Usage

Usage instructions go here.

venv/bin/python my_script.py

Development

# Get a comprehensive list of development tools
make help