pyscaffold.contrib.setuptools_scm package¶
Submodules¶
pyscaffold.contrib.setuptools_scm.config module¶
configuration
-
class
pyscaffold.contrib.setuptools_scm.config.
Configuration
(relative_to=None, root='.', version_scheme='guess-next-dev', local_scheme='node-and-date', write_to=None, write_to_template=None, tag_regex='^(?:[\w-]+-)?(?P<version>[vV]?\d+(?:\.\d+){0, 2}[^\+]*)(?:\+.*)?$', parentdir_prefix_version=None, fallback_version=None, fallback_root='.', parse=None, git_describe_command=None)[source]¶ Bases:
object
Global configuration model
-
absolute_root
¶
-
fallback_root
¶
-
classmethod
from_file
(name='pyproject.toml')[source]¶ Read Configuration from pyproject.toml (or similar). Raises exceptions when file is not found or toml is not installed or the file has invalid format or does not contain the [tool.setuptools_scm] section.
-
relative_to
¶
-
root
¶
-
tag_regex
¶
-
pyscaffold.contrib.setuptools_scm.discover module¶
pyscaffold.contrib.setuptools_scm.file_finder module¶
-
pyscaffold.contrib.setuptools_scm.file_finder.
scm_find_files
(path, scm_files, scm_dirs)[source]¶ setuptools compatible file finder that follows symlinks
- path: the root directory from which to search
- scm_files: set of scm controlled files and symlinks (including symlinks to directories)
- scm_dirs: set of scm controlled directories (including directories containing no scm controlled files)
scm_files and scm_dirs must be absolute with symlinks resolved (realpath), with normalized case (normcase)
Spec here: http://setuptools.readthedocs.io/en/latest/setuptools.html# adding-support-for-revision-control-systems
pyscaffold.contrib.setuptools_scm.file_finder_git module¶
pyscaffold.contrib.setuptools_scm.file_finder_hg module¶
pyscaffold.contrib.setuptools_scm.git module¶
-
class
pyscaffold.contrib.setuptools_scm.git.
GitWorkdir
(path)[source]¶ Bases:
object
experimental, may change at any time
-
pyscaffold.contrib.setuptools_scm.git.
fail_on_shallow
(wd)[source]¶ experimental, may change at any time
-
pyscaffold.contrib.setuptools_scm.git.
fetch_on_shallow
(wd)[source]¶ experimental, may change at any time
pyscaffold.contrib.setuptools_scm.hacks module¶
pyscaffold.contrib.setuptools_scm.hg module¶
pyscaffold.contrib.setuptools_scm.integration module¶
pyscaffold.contrib.setuptools_scm.utils module¶
utils
-
class
pyscaffold.contrib.setuptools_scm.utils.
UTC
[source]¶ Bases:
datetime.tzinfo
pyscaffold.contrib.setuptools_scm.version module¶
-
class
pyscaffold.contrib.setuptools_scm.version.
ScmVersion
(tag_version, distance=None, node=None, dirty=False, preformatted=False, branch=None, config=None, **kw)[source]¶ Bases:
object
-
exact
¶
-
extra
¶
-
-
exception
pyscaffold.contrib.setuptools_scm.version.
SetuptoolsOutdatedWarning
[source]¶ Bases:
Warning
-
pyscaffold.contrib.setuptools_scm.version.
get_local_node_and_timestamp
(version, fmt='%Y%m%d%H%M%S')[source]¶
-
pyscaffold.contrib.setuptools_scm.version.
guess_next_simple_semver
(version, retain, increment=True)[source]¶
-
pyscaffold.contrib.setuptools_scm.version.
meta
(tag, distance=None, dirty=False, node=None, preformatted=False, branch=None, config=None, **kw)[source]¶
-
pyscaffold.contrib.setuptools_scm.version.
tag_to_version
(tag, config=None)[source]¶ take a tag that might be prefixed with a keyword and return only the version part :param config: optional configuration object
take tags that might be prefixed with a keyword and return only the version part :param tags: an iterable of tags :param config: optional configuration object
pyscaffold.contrib.setuptools_scm.win_py31_compat module¶
Module contents¶
copyright: | 2010-2015 by Ronny Pfannschmidt |
---|---|
license: | MIT |
-
pyscaffold.contrib.setuptools_scm.
get_version
(root='.', version_scheme='guess-next-dev', local_scheme='node-and-date', write_to=None, write_to_template=None, relative_to=None, tag_regex='^(?:[\\w-]+-)?(?P<version>[vV]?\\d+(?:\\.\\d+){0, 2}[^\\+]*)(?:\\+.*)?$', parentdir_prefix_version=None, fallback_version=None, fallback_root='.', parse=None, git_describe_command=None)[source]¶ If supplied, relative_to should be a file from which root may be resolved. Typically called by a script or module that is not in the root of the repository to direct setuptools_scm to the root of the repository by supplying
__file__
.