========================================== Python Documentation and Releasing Project
This project is an attempt at documenting Python code and prepare a ready-to- release Python package, including proper tests and documentations. The ultimate goal of this project is to release a Python package of John A. Marohn (email@example.com) onto GitHub and PyPI.
:Authors: Hoang Long Nguyen :Email: firstname.lastname@example.org
The dummy package
This package is literally a dummy package. All it does is adding or subtracting two given numbers and give out a result.
- At the root document, run
python setup.py install.
- Test the module with
python setup.py test.
- Calling module:
result1 = dummy.calc(n1,op,n2)
result2 = dummy.calc(n1,op,n2)with n1,n2 are numbers, op are operation in string '+','-','*','.' and 'x'
result3 = dummy.circ(r)with r the radius of a circle
jinja 2.7.2 for documentation. Recommended numpy.