pyscaffold.contrib.setuptools_scm package

Submodules

pyscaffold.contrib.setuptools_scm.discover module

pyscaffold.contrib.setuptools_scm.discover.iter_matching_entrypoints(path, entrypoint)

pyscaffold.contrib.setuptools_scm.git module

class pyscaffold.contrib.setuptools_scm.git.GitWorkdir(path)

Bases: object

experimental, may change at any time

count_all_nodes()

do_ex(cmd)

fetch_shallow()

classmethod from_potential_worktree(wd)

is_dirty()

is_shallow()

node()

pyscaffold.contrib.setuptools_scm.git.fail_on_shallow(wd)

experimental, may change at any time

pyscaffold.contrib.setuptools_scm.git.fetch_on_shallow(wd)

experimental, may change at any time

pyscaffold.contrib.setuptools_scm.git.list_files_in_archive(path)

List the files that ‘git archive’ generates.

pyscaffold.contrib.setuptools_scm.git.parse(root, describe_command='git describe --dirty --tags --long --match *.*', pre_parse=<function warn_on_shallow>)

Parameters:pre_parse – experimental pre_parse action, may change at any time

pyscaffold.contrib.setuptools_scm.git.warn_on_shallow(wd)

experimental, may change at any time

pyscaffold.contrib.setuptools_scm.hacks module

pyscaffold.contrib.setuptools_scm.hacks.parse_pip_egg_info(root)

pyscaffold.contrib.setuptools_scm.hacks.parse_pkginfo(root)

pyscaffold.contrib.setuptools_scm.hg module

pyscaffold.contrib.setuptools_scm.hg.archival_to_version(data)

pyscaffold.contrib.setuptools_scm.hg.parse(root)

pyscaffold.contrib.setuptools_scm.hg.parse_archival(root)

pyscaffold.contrib.setuptools_scm.integration module

pyscaffold.contrib.setuptools_scm.integration.find_files(path='.')

pyscaffold.contrib.setuptools_scm.integration.version_keyword(dist, keyword, value)

pyscaffold.contrib.setuptools_scm.utils module

utils

pyscaffold.contrib.setuptools_scm.utils.data_from_mime(path)

pyscaffold.contrib.setuptools_scm.utils.do(cmd, cwd='.')

pyscaffold.contrib.setuptools_scm.utils.do_ex(cmd, cwd='.')

pyscaffold.contrib.setuptools_scm.utils.ensure_stripped_str(str_or_bytes)

pyscaffold.contrib.setuptools_scm.utils.has_command(name)

pyscaffold.contrib.setuptools_scm.utils.trace(*k)

pyscaffold.contrib.setuptools_scm.version module

class pyscaffold.contrib.setuptools_scm.version.ScmVersion(tag_version, distance=None, node=None, dirty=False, preformatted=False, **kw)

Bases: object

exact

format_choice(clean_format, dirty_format)

format_with(fmt)

pyscaffold.contrib.setuptools_scm.version.callable_or_entrypoint(group, callable_or_name)

pyscaffold.contrib.setuptools_scm.version.format_version(version, **config)

pyscaffold.contrib.setuptools_scm.version.get_local_dirty_tag(version)

pyscaffold.contrib.setuptools_scm.version.get_local_node_and_date(version)

pyscaffold.contrib.setuptools_scm.version.get_local_node_and_timestamp(version, fmt='%Y%m%d%H%M%S')

pyscaffold.contrib.setuptools_scm.version.guess_next_dev_version(version)

pyscaffold.contrib.setuptools_scm.version.guess_next_version(tag_version, distance)

pyscaffold.contrib.setuptools_scm.version.meta(tag, distance=None, dirty=False, node=None, preformatted=False, **kw)

pyscaffold.contrib.setuptools_scm.version.postrelease_version(version)

pyscaffold.contrib.setuptools_scm.version.tag_to_version(tag)

pyscaffold.contrib.setuptools_scm.version.tags_to_versions(tags)

pyscaffold.contrib.setuptools_scm.win_py31_compat module

Module contents

copyright:2010-2015 by Ronny Pfannschmidt license:MIT

pyscaffold.contrib.setuptools_scm.dump_version(root, version, write_to, template=None)

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, parse=None)

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__.

pyscaffold.contrib.setuptools_scm.version_from_scm(root)