setup module

Setup script

class setup.BakedDocumentation(dist, **kw)

Bases: setuptools.Command

description = 'create documentation distribution from baked project'

finalize_options()

initialize_options()

run()

Run command.

user_options = []

class setup.Clean(dist, **kw)

Bases: setuptools.Command

Custom clean command to tidy up the project root.

finalize_options()

initialize_options()

run()

user_options = []

class setup.Cookiecutter(dist, **kw)

Bases: setuptools.Command

Bake the cookies

description = 'bake the cookiecutter'

finalize_options()

Post-process options.

initialize_options()

Set default values for options.

run()

Run command.

user_options = [('no-input', None, 'Do not prompt for parameters and only use cookiecutter.json file content', ' [default: False]'), ('replay', None, 'Do not prompt for parameters and only use information entered previously [default: letter]')]

class setup.Documentation(dist, **kw)

Bases: setuptools.Command

Bake the cookies

description = 'create documentation distribution'

finalize_options()

initialize_options()

Set default values for options.

run()

Run command.

targets = {'dirhtml': {'comment': 'The HTML pages are in {build_dir!s}.'}, 'latex': {'comment': 'The LaTeX files are in {build_dir!s}.'}, 'html': {'comment': 'The HTML pages are in {build_dir!s}.'}, 'singlehtml': {'comment': 'The HTML pages are in {build_dir!s}.'}}

user_options = [('builder=', None, 'documentation output format [default: html]'), ('paper=', None, 'paper format [default: letter]'), ('dist-dir=', None, 'directory to put final built distributions in [default: dist/docs]'), ('build-dir=', None, 'temporary directory for creating the distribution [default: build/docs]'), ('src-dir=', None, 'documentation source directory [default: docs')]

class setup.Venv(dist, **kw)

Bases: setuptools.Command

Setup venvs for development or production

description = 'create a virtualenv pre-installed with dependencies'

finalize_options()

Post-process options.

initialize_options()

Set default values for options.

run()

Run command.

user_options = [('deps=', None, 'path to requirements.txt')]

class setup.WriteVersionFile(dist, **kw)

Bases: setuptools.Command

description = 'Write a Java properties file for use by Jenkins'

finalize_options()

Post-process options.

initialize_options()

Set default values for options.

run()

Run command.

user_options = []

setup.get_distribution_info()

setup.main()

setup.working_directory(*args, **kwds)

A context manager which changes the working directory to the given path, and then changes it back to its previous value on exit.