PYTHON APPLICATION TEMPLATE

 

SCOPE

This is a python application template that can be used out of the box. It comes with inbuilt argument parser, configuration file parser and a log handler. The idea is to have minimalistic starting point for implementing similar python applications.

FUNCTIONAL REQUIREMENTS

• Shell get config file path via command line arguments
• Shell parse and load given confignfile
• Shell get log file path from given config file
• Shell log output in given log file
• Shell read log level from given config file
• Shell filter out log entries with log level less than specified in the config file

NON FUNCTIONAL REQUIREMENTS

• Shell be minimalistic
• Shell work out of the box

DESIGN

USAGE

git

1. Clone the github repository
2. Remove .git
3. git init with your own remote

build

make venv - creates a virtual environment and installs requirements
make test - runs unit tests and code analysis
make vim - exports PYTHONPATH, activates virtual environment and opens a vim
make run - runs the application

REFERENCES