Index

_

__all__ (in module drain_swamp.check_type) (in module drain_swamp.constants) (in module drain_swamp.constants_maybe) (in module drain_swamp.exceptions) (in module drain_swamp.igor_utils) (in module drain_swamp.monkey.config_settings) (in module drain_swamp.monkey.hooks) (in module drain_swamp.monkey.hooks.constants) (in module drain_swamp.monkey.wrap_get_version) (in module drain_swamp.package_metadata) (in module drain_swamp.parser_in) (in module drain_swamp.snippet_sphinx_conf) (in module drain_swamp.version_file._overrides) (in module drain_swamp.version_file.dump_version) (in module drain_swamp.version_semantic) __slots__ (drain_swamp.package_metadata.PackageMetadata attribute) __url__ (in module drain_swamp.constants_maybe) __version__ (built-in variable) __version_app (in module drain_swamp.constants_maybe) __version_tuple__ (built-in variable)

_arbritary_version() (in module drain_swamp.version_semantic) _current_tag() (in module drain_swamp.version_semantic) _current_version() (in module drain_swamp.version_semantic) _is_ver_ok() (in module drain_swamp.version_semantic) _logger (in module drain_swamp.cli_igor) (in module drain_swamp.igor_utils) (in module drain_swamp.package_metadata) (in module drain_swamp.parser_in) (in module drain_swamp.snippet_sphinx_conf) (in module drain_swamp.version_semantic) _map_release (in module drain_swamp.version_semantic) _path_or_cwd() (in module drain_swamp.version_semantic) _PLUGIN_HOOKS (in module drain_swamp.monkey.hooks.constants) (in module drain_swamp.monkey.hooks.manager) _pre_split() (in module drain_swamp.version_semantic) _remove_v() (in module drain_swamp.version_semantic) _scm_key() (in module drain_swamp.version_semantic) _strip_epoch() (in module drain_swamp.version_semantic) _strip_local() (in module drain_swamp.version_semantic) _tag_version() (in module drain_swamp.version_semantic) _v (drain_swamp.version_semantic._pre_split parameter)

A

after() (in module drain_swamp.monkey.hooks.manager) anchor() (drain_swamp.version_semantic.SemVersion method) app_name (drain_swamp.package_metadata.PackageMetadata property)

as_tuple() (drain_swamp.version_semantic.SemVersion static method) AUTHOR_NAME_FALLBACK (in module drain_swamp.package_metadata) author_name_left (drain_swamp.snippet_sphinx_conf.SnipSphinxConf property)

B

before() (in module drain_swamp.monkey.hooks.manager)

build_package() (in module drain_swamp.igor_utils)

C

click_bool() (in module drain_swamp.check_type) CLICK_FALSE (in module drain_swamp.check_type) CLICK_TRUE (in module drain_swamp.check_type) config_settings (drain_swamp.monkey.hooks.specs.ds_after_version_infer parameter) (drain_swamp.monkey.hooks.specs.ds_before_version_infer parameter) (drain_swamp.monkey.hooks.specs.ds_on_version_infer parameter)

ConfigSettings (class in drain_swamp.monkey.config_settings) contents() (drain_swamp.snippet_sphinx_conf.SnipSphinxConf method) copyright_start_year (drain_swamp.snippet_sphinx_conf.SnipSphinxConf.contents parameter) COPYRIGHT_START_YEAR_FALLBACK (in module drain_swamp.igor_utils) CURRENT_ALIAS_DEFAULT (drain_swamp.version_semantic.SemVersion attribute) CURRENT_ALIASES (drain_swamp.version_semantic.SemVersion attribute) current_version() (in module drain_swamp.cli_igor)

D

d_config_settings (drain_swamp.monkey.wrap_infer_version.run_build_plugins parameter) d_pyproject_toml (drain_swamp.package_metadata.PackageMetadata property) (drain_swamp.parser_in.TomlParser property) DEFAULT_EXTENSIONS (in module drain_swamp.check_type) dev (drain_swamp.version_semantic.SemVersion property) dist (drain_swamp.monkey.wrap_version_keyword.version_keyword parameter) dist_name (drain_swamp.monkey.wrap_get_version.write_to_file parameter) (drain_swamp.version_file._overrides.normalize_dist_name parameter) (drain_swamp.version_file._overrides.read_named_env parameter) do_cheats() (in module drain_swamp.cli_igor) DOC_FOLDERS (drain_swamp.snippet_sphinx_conf.SnipSphinxConf attribute) DOTTED_PATH_SPECS (in module drain_swamp.monkey.hooks.constants) drain_swamp module drain_swamp.__all__ (in module drain_swamp) drain_swamp.check_type module drain_swamp.cli_igor module drain_swamp.cli_version module drain_swamp.constants module drain_swamp.constants_maybe module drain_swamp.exceptions module drain_swamp.igor_utils module drain_swamp.monkey.config_settings module drain_swamp.monkey.hooks module

drain_swamp.monkey.hooks.constants module drain_swamp.monkey.hooks.manager module drain_swamp.monkey.hooks.markers module drain_swamp.monkey.hooks.specs module drain_swamp.monkey.plugins module drain_swamp.monkey.plugins.ds_scm_version module drain_swamp.monkey.wrap_get_version module drain_swamp.monkey.wrap_infer_version module drain_swamp.monkey.wrap_version_keyword module drain_swamp.package_metadata module drain_swamp.parser_in module drain_swamp.snippet_sphinx_conf module drain_swamp.version_file._overrides module drain_swamp.version_file.dump_version module drain_swamp.version_semantic module ds_after_version_infer() (in module drain_swamp.monkey.hooks.specs) ds_before_version_infer() (in module drain_swamp.monkey.hooks.specs) ds_on_version_infer() (in module drain_swamp.monkey.hooks.specs) dump_version() (in module drain_swamp.version_file.dump_version)

E

edit() (in module drain_swamp.cli_igor) edit_for_release() (in module drain_swamp.igor_utils) email (drain_swamp.package_metadata.PackageMetadata property) entrypoint_name (in module drain_swamp.cli_igor) (in module drain_swamp.cli_version) (in module drain_swamp.snippet_sphinx_conf) entrypoint_plugins (drain_swamp.monkey.hooks.manager.get_plugin_manager parameter) ENVIRON_KEY (drain_swamp.monkey.config_settings.ConfigSettings attribute) EPILOG_BUILD (in module drain_swamp.cli_igor) EPILOG_CHEATS (in module drain_swamp.cli_igor)

EPILOG_CURRENT_VERSION (in module drain_swamp.cli_igor) EPILOG_EDITS (in module drain_swamp.cli_igor) EPILOG_LIST (in module drain_swamp.cli_igor) EPILOG_PRETAG (in module drain_swamp.cli_igor) EPILOG_SCM_PAIR (in module drain_swamp.cli_igor) EPILOG_SCM_VERSION_GET (in module drain_swamp.cli_version) EPILOG_SCM_VERSION_WRITE (in module drain_swamp.cli_version) EPILOG_SEED (in module drain_swamp.cli_igor) EPILOG_TAG_VERSION (in module drain_swamp.cli_igor) extensions (drain_swamp.check_type.is_relative_required parameter)

F

file_name (drain_swamp.monkey.config_settings.ConfigSettings property) (drain_swamp.monkey.config_settings.ConfigSettings.get_section_dict parameter) (drain_swamp.monkey.config_settings.ConfigSettings.write parameter)

FILE_NAME_DEFAULT (drain_swamp.monkey.config_settings.ConfigSettings attribute) full_name (drain_swamp.package_metadata.PackageMetadata property)

G

g_app_name (in module drain_swamp.constants) get_abs_path() (drain_swamp.monkey.config_settings.ConfigSettings class method) get_package_name() (in module drain_swamp.version_semantic) get_plugin_manager() (in module drain_swamp.monkey.hooks.manager)

get_scm_version() (in module drain_swamp.cli_scm_version) get_section_dict() (drain_swamp.monkey.config_settings.ConfigSettings class method) get_tag_version() (in module drain_swamp.igor_utils) get_version() (in module drain_swamp.version_semantic)

H

help_is_write (in module drain_swamp.cli_version) help_kind (in module drain_swamp.cli_igor) help_path (in module drain_swamp.cli_igor) (in module drain_swamp.cli_version) help_snippet_co (in module drain_swamp.cli_igor) help_write_to (in module drain_swamp.cli_version)

hook_impl (in module drain_swamp.monkey.hooks.markers) hook_impls (drain_swamp.monkey.hooks.manager.after parameter) (drain_swamp.monkey.hooks.manager.before parameter) hook_name (drain_swamp.monkey.hooks.manager.after parameter) (drain_swamp.monkey.hooks.manager.before parameter) HOOK_NAMESPACE (in module drain_swamp.monkey.hooks.constants) hook_spec (in module drain_swamp.monkey.hooks.specs)

I

is_iterable_not_str() (in module drain_swamp.check_type) is_latest (drain_swamp.version_semantic.SemVersion.readthedocs_url parameter) is_module_debug (in module drain_swamp.parser_in) is_ok() (in module drain_swamp.check_type) is_only_not_exists (drain_swamp.monkey.wrap_get_version.write_to_file parameter) (drain_swamp.version_file.dump_version.write_version_files parameter)

is_relative_required() (in module drain_swamp.check_type) is_test (drain_swamp.igor_utils.get_tag_version parameter) (drain_swamp.igor_utils.write_version_file parameter) is_use_final (drain_swamp.version_semantic.get_version parameter) (drain_swamp.version_semantic.SemVersion property) is_write (drain_swamp.cli_scm_version.get_scm_version parameter)

K

keyword (drain_swamp.monkey.wrap_version_keyword.version_keyword parameter) kind (drain_swamp.cli_igor.do_cheats parameter) (drain_swamp.cli_igor.edit parameter) (drain_swamp.cli_igor.semantic_version_aware_build parameter) (drain_swamp.cli_igor.setuptools_scm_key_value_pair parameter) (drain_swamp.igor_utils.build_package parameter) (drain_swamp.igor_utils.edit_for_release parameter) (drain_swamp.igor_utils.print_cheats parameter) (drain_swamp.igor_utils.write_version_file parameter) (drain_swamp.snippet_sphinx_conf.SnipSphinxConf.contents parameter) (drain_swamp.version_semantic.SemVersion.sanitize_kind parameter) (drain_swamp.version_semantic.SemVersion.version_clean parameter)

KINDS (drain_swamp.version_semantic.SemVersion attribute) kwargs (drain_swamp.monkey.hooks.manager.after parameter) (drain_swamp.monkey.hooks.manager.before parameter)

L

left_name (drain_swamp.package_metadata.PackageMetadata property) local (drain_swamp.version_semantic.SemVersion.parse_ver parameter) log (in module drain_swamp.monkey.config_settings) (in module drain_swamp.monkey.plugins.ds_scm_version) (in module drain_swamp.monkey.wrap_get_version) (in module drain_swamp.monkey.wrap_version_keyword)

logger (in module drain_swamp.monkey.hooks.manager)

M

main() (in module drain_swamp.cli_igor) (in module drain_swamp.cli_version) major (drain_swamp.version_semantic.SemVersion property) micro (drain_swamp.version_semantic.SemVersion property) minor (drain_swamp.version_semantic.SemVersion property) mixed (drain_swamp.check_type.is_iterable_not_str parameter) mod_pkg_plugins (drain_swamp.monkey.hooks.manager.get_plugin_manager parameter) module drain_swamp drain_swamp.check_type drain_swamp.cli_igor drain_swamp.cli_version drain_swamp.constants drain_swamp.constants_maybe drain_swamp.exceptions drain_swamp.igor_utils drain_swamp.monkey.config_settings drain_swamp.monkey.hooks drain_swamp.monkey.hooks.constants drain_swamp.monkey.hooks.manager drain_swamp.monkey.hooks.markers drain_swamp.monkey.hooks.specs drain_swamp.monkey.plugins drain_swamp.monkey.plugins.ds_scm_version drain_swamp.monkey.wrap_get_version drain_swamp.monkey.wrap_infer_version drain_swamp.monkey.wrap_version_keyword drain_swamp.package_metadata drain_swamp.parser_in drain_swamp.snippet_sphinx_conf drain_swamp.version_file._overrides drain_swamp.version_file.dump_version drain_swamp.version_semantic

N

name (drain_swamp.monkey.wrap_get_version.write_to_file parameter) (drain_swamp.version_file._overrides.read_named_env parameter) namespace (drain_swamp.monkey.hooks.manager.get_plugin_manager parameter) next_version (drain_swamp.version_semantic._arbritary_version parameter) (drain_swamp.version_semantic._tag_version parameter)

normalize_dist_name() (in module drain_swamp.version_file._overrides) now() (drain_swamp.snippet_sphinx_conf.SnipSphinxConf class method) now_to_str() (drain_swamp.snippet_sphinx_conf.SnipSphinxConf class method)

O

on_version_infer() (in module drain_swamp.monkey.plugins.ds_scm_version)

outcome (drain_swamp.monkey.hooks.manager.after parameter) outlier_sanitize() (in module drain_swamp.version_semantic)

P

package_name (drain_swamp.snippet_sphinx_conf.SnipSphinxConf.contents parameter) (drain_swamp.version_semantic.SemVersion.readthedocs_url parameter) (in module drain_swamp.constants) PackageMetadata (class in drain_swamp.package_metadata) parse_ver() (drain_swamp.version_semantic.SemVersion method) path (drain_swamp.cli_igor.current_version parameter) (drain_swamp.cli_igor.do_cheats parameter) (drain_swamp.cli_igor.edit parameter) (drain_swamp.cli_igor.seed parameter) (drain_swamp.cli_igor.semantic_version_aware_build parameter) (drain_swamp.cli_igor.setuptools_scm_key_value_pair parameter) (drain_swamp.cli_igor.snippets_list parameter) (drain_swamp.cli_igor.tag_version parameter) (drain_swamp.cli_scm_version.get_scm_version parameter) (drain_swamp.cli_scm_version.write_scm_version parameter) (drain_swamp.igor_utils.build_package parameter) (drain_swamp.igor_utils.get_tag_version parameter) (drain_swamp.igor_utils.print_cheats parameter) (drain_swamp.igor_utils.write_version_file parameter) (drain_swamp.version_semantic._arbritary_version parameter) (drain_swamp.version_semantic._current_tag parameter) (drain_swamp.version_semantic._current_version parameter) (drain_swamp.version_semantic._path_or_cwd parameter) (drain_swamp.version_semantic._tag_version parameter) (drain_swamp.version_semantic.get_package_name parameter)

path_abs (drain_swamp.snippet_sphinx_conf.SnipSphinxConf property) path_abs_init() (drain_swamp.snippet_sphinx_conf.SnipSphinxConf method) path_config (drain_swamp.parser_in.TomlParser.read parameter) (drain_swamp.parser_in.TomlParser.resolve parameter) path_cwd (drain_swamp.igor_utils.edit_for_release parameter) (drain_swamp.igor_utils.seed_changelog parameter) (drain_swamp.snippet_sphinx_conf.SnipSphinxConf property) (drain_swamp.version_semantic.SemVersion property) path_dir (drain_swamp.monkey.config_settings.ConfigSettings.get_section_dict parameter) (drain_swamp.monkey.config_settings.ConfigSettings.write parameter) path_file (drain_swamp.parser_in.TomlParser property) PATH_PIP_COMPILE (in module drain_swamp.constants) path_relative (drain_swamp.check_type.is_relative_required parameter) pretag() (in module drain_swamp.igor_utils) PRETEND_KEY (in module drain_swamp.version_file._overrides) PRETEND_KEY_NAMED (in module drain_swamp.version_file._overrides) print_cheats() (in module drain_swamp.igor_utils) PROG_LOCK (in module drain_swamp.constants) prog_name (drain_swamp.version_semantic._scm_key parameter) PROG_UNLOCK (in module drain_swamp.constants) PyProjectTOMLParseError PyProjectTOMLReadError

R

read() (drain_swamp.monkey.config_settings.ConfigSettings method) (drain_swamp.parser_in.TomlParser class method) read_named_env() (in module drain_swamp.version_file._overrides) readthedocs_url() (drain_swamp.version_semantic.SemVersion method) REGEX_COPYRIGHT_LINE (in module drain_swamp.igor_utils) relative_to (drain_swamp.monkey.wrap_get_version.scm_version parameter) release (drain_swamp.version_semantic.SemVersion property)

releaselevel (drain_swamp.version_semantic.SemVersion property) releaselevel_abbr (drain_swamp.version_semantic.SemVersion property) remove_abs_path() (drain_swamp.monkey.config_settings.ConfigSettings class method) replace() (drain_swamp.snippet_sphinx_conf.SnipSphinxConf method) resolve() (drain_swamp.parser_in.TomlParser class method) root (drain_swamp.version_file.dump_version.dump_version parameter) (drain_swamp.version_file.dump_version.write_version_files parameter) run_build_plugins() (in module drain_swamp.monkey.wrap_infer_version)

S

sane_default (drain_swamp.monkey.wrap_get_version.scm_version parameter) sanitize_kind() (drain_swamp.version_semantic.SemVersion class method) sanitize_tag() (in module drain_swamp.version_semantic) scm_ver (drain_swamp.cli_scm_version.write_scm_version parameter) scm_version() (in module drain_swamp.monkey.wrap_get_version) SCRIV_START (in module drain_swamp.igor_utils) SECTION_NAME (drain_swamp.monkey.config_settings.ConfigSettings attribute) seed() (in module drain_swamp.cli_igor) seed_changelog() (in module drain_swamp.igor_utils) semantic_version_aware_build() (in module drain_swamp.cli_igor) SemVersion (class in drain_swamp.version_semantic) serial (drain_swamp.version_semantic.SemVersion property) set_abs_path() (drain_swamp.monkey.config_settings.ConfigSettings class method) setuptools_scm_key_value_pair() (in module drain_swamp.cli_igor)

snippet_co (drain_swamp.cli_igor.edit parameter) (drain_swamp.igor_utils.edit_for_release parameter) (drain_swamp.snippet_sphinx_conf.SnipSphinxConf.replace parameter) snippets_list() (in module drain_swamp.cli_igor) SnipSphinxConf (class in drain_swamp.snippet_sphinx_conf) specs_dotted_path (drain_swamp.monkey.hooks.manager.get_plugin_manager parameter) str_v (drain_swamp.version_semantic._is_ver_ok parameter) str_ver (drain_swamp.monkey.wrap_get_version.write_to_file parameter) strftime_str (drain_swamp.snippet_sphinx_conf.SnipSphinxConf.now_to_str parameter) SUFFIX_IN (in module drain_swamp.constants) SUFFIX_LOCKED (in module drain_swamp.constants) SUFFIX_SHARED_IN (in module drain_swamp.constants) SUFFIX_SYMLINK (in module drain_swamp.constants) SUFFIX_UNLOCKED (in module drain_swamp.constants) SV (drain_swamp.snippet_sphinx_conf.SnipSphinxConf property)

T

tag (drain_swamp.igor_utils.pretag parameter) tag_version() (in module drain_swamp.cli_igor) target (drain_swamp.version_file.dump_version.write_version_to_path parameter) template (drain_swamp.version_file.dump_version.dump_version parameter) (drain_swamp.version_file.dump_version.write_version_to_path parameter)

TEMPLATES (in module drain_swamp.version_file.dump_version) test (drain_swamp.check_type.is_ok parameter) toml_contents (drain_swamp.monkey.config_settings.ConfigSettings.get_section_dict parameter) (drain_swamp.monkey.config_settings.ConfigSettings.write parameter) TomlParser (class in drain_swamp.parser_in) tool (drain_swamp.version_file._overrides.read_named_env parameter)

U

UNRELEASED (in module drain_swamp.igor_utils)

V

val (drain_swamp.check_type.click_bool parameter) (drain_swamp.monkey.config_settings.ConfigSettings.set_abs_path parameter) validate_tag() (in module drain_swamp.cli_igor) value (drain_swamp.monkey.wrap_version_keyword.version_keyword parameter) ver (drain_swamp.cli_igor.validate_tag parameter) (drain_swamp.version_semantic._remove_v parameter) (drain_swamp.version_semantic._strip_epoch parameter) (drain_swamp.version_semantic._strip_local parameter) (drain_swamp.version_semantic.get_version parameter) (drain_swamp.version_semantic.outlier_sanitize parameter) (drain_swamp.version_semantic.sanitize_tag parameter) (drain_swamp.version_semantic.SemVersion.parse_ver parameter)

version (built-in variable) (drain_swamp.version_file.dump_version.dump_version parameter) (drain_swamp.version_file.dump_version.write_version_files parameter) (drain_swamp.version_file.dump_version.write_version_to_path parameter) version_clean() (drain_swamp.version_semantic.SemVersion method) version_file (drain_swamp.version_file.dump_version.write_version_files parameter) version_keyword() (in module drain_swamp.monkey.wrap_version_keyword) version_str (drain_swamp.version_semantic.SemVersion.as_tuple parameter) version_tuple (built-in variable) version_xyz() (drain_swamp.version_semantic.SemVersion method)

W

write() (drain_swamp.monkey.config_settings.ConfigSettings method) write_scm_version() (in module drain_swamp.cli_scm_version) write_to (drain_swamp.cli_scm_version.get_scm_version parameter) (drain_swamp.cli_scm_version.write_scm_version parameter) (drain_swamp.monkey.wrap_get_version.write_to_file parameter) (drain_swamp.version_file.dump_version.dump_version parameter) (drain_swamp.version_file.dump_version.write_version_files parameter)

write_to_file() (in module drain_swamp.monkey.wrap_get_version) write_version_file() (in module drain_swamp.igor_utils) write_version_files() (in module drain_swamp.version_file.dump_version) write_version_to_path() (in module drain_swamp.version_file.dump_version)