https://github.com/akaliutau/python-cli-app-reference-design

Python 3 CLI application Reference Design project
https://github.com/akaliutau/python-cli-app-reference-design

python-cli-app python3 reference-design

Last synced: 4 months ago
JSON representation

Python 3 CLI application Reference Design project

• Host: GitHub
• URL: https://github.com/akaliutau/python-cli-app-reference-design
• Owner: akaliutau
• License: mit
• Created: 2024-02-12T18:14:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-12T20:15:57.000Z (over 1 year ago)
• Last Synced: 2025-01-11T00:13:27.964Z (5 months ago)
• Topics: python-cli-app, python3, reference-design
• Language: Python
• Homepage:
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Python cli application reference design

![Static Badge](https://img.shields.io/badge/python-3.8-blue)

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

```shell

python3 -m venv venv

source ./venv/bin/activate

pip install -r requirements.txt

```

# Testing

```shell

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

```shell

flake8 --config flake8

```