/python-cli-app-reference-design

Python 3 CLI application Reference Design project

Primary LanguagePythonMIT LicenseMIT

Python cli application reference design

Static Badge

This repository contains the skeleton for the CLI Python-based application, designed in accordance with best practice, including:

  • Fully-defined command-line interface
  • Modular design
  • Usage of common OOP patterns and best practice
  • Unit-tests
  • Documented API

Installation

python3 -m venv venv
source ./venv/bin/activate
pip install -r requirements.txt

Testing

pytest
python3 app.py -o test.txt

Linting

flake8 is a popular linter that comments on the style of code in relation to the PEP 8

flake8 --config flake8