Python prototype

This package contains a simple sample of a Python package prototype. It is part of the educational repositories to learn how to write stardard code and common uses of the TDD.

See the documentation and how to do it on readthedocs. And see the development of this code step by step

• with see-git-steps
• on readthedocs / step by step

Installation

The package is self-consistent. So you can download the package by github:

$ git clone https://github.com/bilardi/python-prototype

Or you can install by python3-pip:

$ pip3 install simple_sample

Usage

Read the unit tests in tests/testMyClass.py file to use it. This is a best practice. You can read also the documentation by command line,

$ python3
>>> from simple_sample.myClass import MyClass
>>> print(MyClass.__doc__)
>>> help(MyClass)
>>> quit()

If you want to see the local documentation, that you have downloaded by github, you can use the same steps but before you must to change the directory

$ cd python-prototype

Development

It is common use to test the code step by step and unittest module is a good beginning for unit test and functional test.

Test with unittest module

$ cd python-prototype
$ python3 -m unittest discover -v

Change Log

See CHANGELOG.md for details.

License

This package is released under the MIT license. See LICENSE for details.