Build status Build Status Windows GitHub Issues MIT License Requirements Status Notebook Coverage


Quick start

  • install: python install
  • documentation: python build_sphinx
  • unit tests: python unittests


This project is a skeleton for any new project. It contains:

  • a source folder: src
  • a unit test folder: _unittests, go to this folder and run
  • a _doc folder: _doc, it will contains the documentation
  • a file to build and to install the module

All theses steps were only tested on Windows. Suppot for linux will be added later. To create your own project, you need to rename the folder project_name in src by your true module name. You also need to replace project_name wherever it is found:

  • project_var_name  = 'project_name' in, and _doc/sphinxdoc/source/
  • from src.project_name.subproject.myexample import myclass in _unittests/ut_example/
  • many places in _doc/sphinxdoc/source/index.rst
  • many places in README.rst


Adding a new module or subpackage

Any new module or subpackage should be added in src/project_name. Every subfolder should contain a file If the new file needs an existing submodule, you need to add something like the following:

import os
import sys

from ..subproject.myexample import myclass

You must use relative imports. To add a module at deeper level than the previous one, you should add relative imports in every along the way.