mcot.utils.build

Support for importing and building the package

Functions

load_info(name)

Loads the docstring from README.rst and version from VERSION

load_info

mcot.utils.build.load_info(name)

Loads the docstring from README.rst and version from VERSION

Recommended usage in top-level __init__.py:

from mcot.utils.build import load_info
__doc__, __version__ = load_info(__name__)
del load_info

Package version and description are kept separate, so that pants can access them

Parameters

path (List[str]) – __path__ object in init.py

Returns

description of the package to be stored in docstring str: version of the package to be stored in __version__

Return type

str