pyscaffold.templates package

Module contents

Templates for all files of a project’s scaffold

pyscaffold.templates.authors(opts)

Template of AUTHORS.rst

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

pyscaffold.templates.changelog(opts)

Template of CHANGELOG.rst

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

pyscaffold.templates.conftest_py(opts)

Template of conftest.py

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

pyscaffold.templates.coveragerc(opts)

Template of .coveragerc

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

pyscaffold.templates.get_template(name, relative_to='pyscaffold.templates')

Retrieve the template by name

Parameters:

• name – name of template (the .template extension will be automatically added to this name)
• relative_to –

  module/package object or name to which the resource file is relative (in the standard module format, e.g. foo.bar.baz). Notice that relative_to should not represent directly a shared namespace package, since this kind of package is spread in different folders in the file sytem.

  Default value: pyscaffold.templates (please assign accordingly when using in custom extensions).

Examples

Consider the following package organization:

.
├── src
│   └── my_package
│       ├── __init__.py
│       ├── templates
│       │   ├── __init__.py
│       │   ├── file1.template
│       │   └── file2.template
│       …
└── tests

Inside the file src/my_package/__init__.py, one can easily obtain the contents of file1.template by doing:

from pyscaffold.templates import get_template
from . import templates as my_templates

tpl1 = get_template("file1", relative_to=my_templates)
# OR
# tpl1 = get_template('file1', relative_to=my_templates.__name__)

Please notice you can also use relative_to=__name__ or a combination of from .. import __name__ as parent and relative_to=parent to deal with relative imports.

Returns:template Return type:string.Template

Changed in version 3.3: New parameter relative_to.

pyscaffold.templates.gitignore(opts)

Template of .gitignore

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

pyscaffold.templates.gitignore_empty(opts)

Template of empty .gitignore

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

pyscaffold.templates.gitlab_ci(opts)

Template of .gitlab-ci.yml

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

pyscaffold.templates.init(opts)

Template of __init__.py

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

pyscaffold.templates.isort_cfg(opts)

Template of .isort.cfg

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

pyscaffold.templates.license(opts)

Template of LICENSE.txt

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

pyscaffold.templates.licenses = {'affero': 'license_affero_3.0', 'apache': 'license_apache', 'artistic': 'license_artistic_2.0', 'cc0': 'license_cc0_1.0', 'eclipse': 'license_eclipse_1.0', 'gpl2': 'license_gpl_2.0', 'gpl3': 'license_gpl_3.0', 'isc': 'license_isc', 'lgpl2': 'license_lgpl_2.1', 'lgpl3': 'license_lgpl_3.0', 'mit': 'license_mit', 'mozilla': 'license_mozilla', 'new-bsd': 'license_new_bsd', 'none': 'license_none', 'proprietary': 'license_none', 'public-domain': 'license_public_domain', 'simple-bsd': 'license_simplified_bsd'}

All available licences

pyscaffold.templates.namespace(opts)

Template of __init__.py defining a namespace package

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

pyscaffold.templates.pre_commit_config(opts)

Template of .pre-commit-config.yaml

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

pyscaffold.templates.readme(opts)

Template of README.rst

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

pyscaffold.templates.requirements(opts)

Template of requirements.txt

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

pyscaffold.templates.setup_cfg(opts)

Template of setup.cfg

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

pyscaffold.templates.setup_py(opts)

Template of setup.py

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

pyscaffold.templates.skeleton(opts)

Template of skeleton.py defining a basic console script

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

pyscaffold.templates.sphinx_authors(opts)

Template of authors.rst

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

pyscaffold.templates.sphinx_changelog(opts)

Template of changelog.rst

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

pyscaffold.templates.sphinx_conf(opts)

Template of conf.py

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

pyscaffold.templates.sphinx_index(opts)

Template of index.rst

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

pyscaffold.templates.sphinx_license(opts)

Template of license.rst

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

pyscaffold.templates.sphinx_makefile(opts)

Template of Sphinx’s Makefile

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

pyscaffold.templates.test_skeleton(opts)

Template of unittest for skeleton.py

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

pyscaffold.templates.tox(opts)

Template of tox.ini

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

pyscaffold.templates.travis(opts)

Template of .travis.yml

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

pyscaffold.templates.travis_install(opts)

Template of travis_install.sh

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