pyscaffold.templates package¶

Module contents¶

Templates for all files of a project’s scaffold

pyscaffold.templates.authors(opts)[source]¶

Template of AUTHORS.rst

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.changes(opts)[source]¶

Template of CHANGES.rst

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.conftest_py(opts)[source]¶

Template of conftest.py

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.coveragerc(opts)[source]¶

Template of .coveragerc

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.get_template(name)[source]¶

Retrieve the template by name

Parameters:	name – name of template
Returns:	template as string.Template

pyscaffold.templates.gitignore(opts)[source]¶

Template of .gitignore

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.gitignore_empty(opts)[source]¶

Template of empty .gitignore

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.init(opts)[source]¶

Template of __init__.py

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.license(opts)[source]¶

Template of LICENSE.txt

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.namespace(opts)[source]¶

Template of __init__.py defining a namespace package

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.pre_commit_config(opts)[source]¶

Template of .pre-commit-config.yaml

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.readme(opts)[source]¶

Template of README.rst

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.requirements(opts)[source]¶

Template of requirements.txt

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.setup_cfg(opts)[source]¶

Template of setup.cfg

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.setup_py(opts)[source]¶

Template of setup.py

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.skeleton(opts)[source]¶

Template of skeleton.py defining a basic console script

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.sphinx_authors(opts)[source]¶

Template of authors.rst

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.sphinx_changes(opts)[source]¶

Template of changes.rst

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.sphinx_conf(opts)[source]¶

Template of conf.py

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.sphinx_index(opts)[source]¶

Template of index.rst

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.sphinx_license(opts)[source]¶

Template of license.rst

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.sphinx_makefile(opts)[source]¶

Template of Sphinx’s Makefile

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.test_requirements(opts)[source]¶

Template of test-requirements.txt

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.test_skeleton(opts)[source]¶

Template of unittest for skeleton.py

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.tox(opts)[source]¶

Template of tox.ini

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.travis(opts)[source]¶

Template of .travis.yml

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string

pyscaffold.templates.travis_install(opts)[source]¶

Template of travis_install.sh

Parameters:	opts – mapping parameters as dictionary
Returns:	file content as string