Skip to content

A minimal Python package containing a single function and a minimal set of `nose` tests. It is intended to serve as a template for building other packages.

License

Notifications You must be signed in to change notification settings

catawbasam/python_example_package

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

python_example_package

A minimal Python package containing a single function and a minimal set of nose tests. It is intended to serve as a template for building other packages.

TODO: Add MkDocs

Using this as a package skeleton

Adapted from: [http://learnpythonthehardway.org/book/ex46.html]

Whenever you want to start a new project, do this:

  1. Make a copy of the python_example_package directory. Name it after your new project.
  2. Rename python_example_package to your project name throughout the skeleton files.
  3. Edit your setup.py to have all the information for your project.
  4. Double check it's all working by running tests: - from the main package directory: - ipython - run tests/python_example_package_tests.py
  5. Remove the sample function from the package __init__.py and the corresponding tests from tests/.
  6. Start coding.

More on file and directory naming from StackOverflow:

[http://stackoverflow.com/questions/17457782/how-to-structure-python-packages-without-repeating-top-level-name-for-import/17530651#17530651]

About

A minimal Python package containing a single function and a minimal set of `nose` tests. It is intended to serve as a template for building other packages.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages