Preocts / budgethelper

Small project to help me keep track of details

Module Name

Module Description

Requirements

• Python 3.8

Installation

It is highly recommended to use a venv for installation. Leveraging a venv will ensure the installed dependency files will not impact other python projects.

The instruction below make use of a bash shell and a Makefile. All commands should be able to be run individually of your shell does not support make

Clone this repo and enter root directory of repo:

git clone https://github.com/Preocts/[MODULENAME]
cd [MODULENAME]

Create and activate venv:

python3.8 -m venv venv
source ./venv/bin/activate

Your command prompt should now have a (venv) prefix on it.

Install the scripts:

make install

Install the scripts for development/tests:

make dev-install

To exit the venv:

deactivate

First time setup

Used as a template repo, the module_setup.sh can be executed in a newly cloned workingdirectory (or a fresh directory). It will create a venv, initial directory structures, git init, and install requiremenets from requirements-dev.in.

./module_setup.sh [MODULENAME]