Shapes Library

A general purpose Python library that provides clients with intuitive object-oriented APIs for 2D and 3D shapes.

Developer Installation

Note that all the below commands should be run within the project root directory (/path/to/coding-challenge)

Firstly, install all the required primary and testing dependencies with the following commands:

• pip install -r requirements.txt
• pip install -r requirements_test.txt

Then, shapes_library can be installed into your local Python package registry with the following command:

• pip install -e .

You should now be able to use functionality offered by the shapes_module Python module by importing shape APIs directly:

from shapes_library.shapes_package.shapes_module import Circle

Testing

Developers can test the library source using unittest with the following commands, assuming the aforementioned dependencies have been installed:

• python -m unittest [-v]
• To generate a coverage report as well as run the unit tests:
  • coverage run -m unitttest
  • coverage report