/python-hierarchy

Demonstrates appropriate structure for Python repositories

Primary LanguagePythonMIT LicenseMIT

python-hierarchy

Python: 3.6 Build Status license: MIT

python-hierarchy is a project which demonstrates commonly used architecture for Python repositories. This repository comes with a full Medium post discussing the nature and purpose of each individual file. Below you can find the proposed contents of a root README.md file.

Installation

Download the project to your computer, navigate to the root folder and execute the command python setup.py install

Project Dependencies

The project uses the requests library in order to perform an HTTP request for demonstration purposes.

Limitations

Some of the limitations of the project:

  • Includes only four basic arithmetic operations
  • Can only mulitply two numbers at a time

Development

A list of features under development are:

  • Input validation
  • Source Code Documentation

Future Enhancements

  • Add additional arithmetic operations
  • Design of either a command line or a graphical user interface (GUI)

Communication

Do not hesitate to contact the creator of the project at: georgios.goniotakis@outlook.com for any concerns/questions.