banana-octo-py: a simple Python project

This simple project provides an example of how to create a package following the Python Packaging User Guide.

Also see the Tutorial on Packaging and Distributing Projects.

module contents

Module was assembled following the modules documentation.

Import the module:

import banana_octo_py as bop

The core.py file defines a hello_core() that is imported at the module level:

bop.hello_core()

The utils.py file defines a hello_utils() that is imported as a utils submodule:

bop.hello_utils()

The sub submodule defines a hello_submodule() function when it is imported:

bop.sub.hello_submodule()

There are further subcomponents of sub, specifically one and two:

bop.sub.hello_submodule_one()
bop.sub.hello_submodule_two()

building

To build with Python 2:

python2 setup.py install

To build with Python 3:

python3 setup.py install

Optional: specify your python as needed - e.g., with conda in a Travis container, or on Homebrew, or etc.

testing

To run the tests, you will need nose. From the project directory, run:

nosetets

This will run all tests in the tests/ directory.

continuous integration (CI) with travis

The .travis.yml file runs the Travis tests by using the tox test automation library. tox sets up and configures tests for different python v ersions/compilations/system configurations on Travis.

links

• Python Packaging User Guide
• Tutorial on Packaging and Distributing Projects.
• Python packging guide sample package.