Index

Symbols

--add repo-helper-suggest-classifiers command line option --colour repo-helper-show-changelog command line option repo-helper-show-log command line option --commit repo-helper command line option repo-helper-init command line option repo-helper-release command line option --concise repo-helper-show-requirements command line option --depth <depth> repo-helper-show-requirements command line option --entries <entries> repo-helper-show-changelog command line option repo-helper-show-log command line option --file <file> repo-helper-add-requirement command line option --force repo-helper command line option repo-helper-init command line option repo-helper-release command line option --from-date <from_date> repo-helper-show-log command line option --from-tag <from_tag> repo-helper-show-log command line option --library repo-helper-suggest-classifiers command line option --message <message> repo-helper command line option repo-helper-init command line option repo-helper-release command line option --no-add repo-helper-suggest-classifiers command line option --no-colour repo-helper-show-changelog command line option repo-helper-show-log command line option --no-commit repo-helper command line option repo-helper-init command line option repo-helper-release command line option --no-pager repo-helper-show-changelog command line option repo-helper-show-log command line option repo-helper-show-requirements command line option --no-venv repo-helper-show-requirements command line option

--not-library repo-helper-suggest-classifiers command line option --quiet repo-helper-show-version command line option --reverse repo-helper-show-changelog command line option repo-helper-show-log command line option --rm-tox repo-helper-broomstick command line option --status <status> repo-helper-suggest-classifiers command line option --verbose repo-helper-broomstick command line option --version repo-helper command line option -c repo-helper-show-requirements command line option -d repo-helper-show-requirements command line option -f repo-helper command line option repo-helper-init command line option repo-helper-release command line option -l repo-helper-suggest-classifiers command line option -m repo-helper command line option repo-helper-init command line option repo-helper-release command line option -n repo-helper command line option repo-helper-init command line option repo-helper-release command line option repo-helper-show-changelog command line option repo-helper-show-log command line option -q repo-helper-show-version command line option -r repo-helper-show-changelog command line option repo-helper-show-log command line option -s repo-helper-suggest-classifiers command line option -v repo-helper-broomstick command line option -y repo-helper command line option repo-helper-init command line option repo-helper-release command line option

_

__eq__() (Repo method) __ge__() (Repo method) __getitem__() (ToxConfig method) __gt__() (Repo method)

__le__() (Repo method) __lt__() (Repo method) __ne__() (Repo method) __repr__() (Repo method)

A

ActionsManager (class in repo_helper.files.ci_cd) additional_ignore configuration value additional_requirements_files configuration value

additional_setup_args configuration value assignee configuration value author configuration value

B

bump() (Bumper method) bump_version_for_file() (Bumper method)

Bumper (class in repo_helper.release) bumpversion_file (Bumper attribute) BumpversionFileConfig (typeddict in repo_helper.release)

C

check_wheel_contents() (ToxConfig method) classifiers configuration value commit_changes() (in module repo_helper.utils) conda_channels configuration value conda_description configuration value conda_extras configuration value configuration value additional_ignore additional_requirements_files additional_setup_args assignee author classifiers conda_channels conda_description conda_extras console_scripts copyright_years desktopfile docker_name docker_shields docs_dir docs_fail_on_warning docs_url email enable_conda enable_devmode enable_docs enable_pre_commit enable_releases enable_tests entry_points exclude_files extra_lint_paths extra_sphinx_extensions extra_testenv_commands extras_require github_ci_requirements html_context html_theme_options imgbot_ignore import_name intersphinx_mapping keywords license manifest_additional min_coverage modname mypy_deps mypy_plugins mypy_version on_conda_forge on_pypi platforms pre_commit_exclude preserve_custom_theme primary_conda_channel pure_python py_modules pypi_name python_deploy_version python_versions repo_name requires_python rtfd_author setup_pre short_desc source_dir sphinx_conf_epilogue sphinx_conf_preamble sphinx_html_theme standalone_contrib_guide stubs_package tests_dir third_party_version_matrix tox_build_requirements tox_requirements tox_testenv_extras tox_unmanaged travis_additional_requirements travis_extra_install_post travis_extra_install_pre travis_ubuntu_version use_flit use_hatch use_maturin use_whey username version yapf_exclude

console_scripts configuration value copy_docs_styling() (in module repo_helper.files.docs) copy_existing_value() (IniConfigurator method) copyright_years configuration value coverage_report() (ToxConfig method) coverage_run() (ToxConfig method) create_docs_install_block() (in module repo_helper.blocks) create_docs_links_block() (in module repo_helper.blocks) create_readme_install_block() (in module repo_helper.blocks) create_short_desc_block() (in module repo_helper.blocks) current_version (Bumper attribute)

D

desktopfile configuration value discover_entry_points() (in module repo_helper.utils) docker_name configuration value docker_shields configuration value

docs_dir configuration value docs_fail_on_warning configuration value docs_url configuration value

E

email configuration value enable_conda configuration value enable_devmode configuration value enable_docs configuration value enable_pre_commit configuration value enable_releases configuration value enable_tests configuration value ensure_bumpversion() (in module repo_helper.files.ci_cd)

ensure_doc_requirements() (in module repo_helper.files.docs) ensure_tests_requirements() (in module repo_helper.files.testing) entry_points configuration value envlists() (ToxConfig method) exclude_files configuration value exclude_files() (RepoHelper property) extra_lint_paths configuration value extra_sphinx_extensions configuration value extra_testenv_commands configuration value extras_require configuration value

F

files (RepoHelper attribute)

flake8() (ToxConfig method)

G

get_bumpversion_config() (Bumper method) get_bumpversion_filenames() (in module repo_helper.files.ci_cd) get_current_version() (Bumper method) get_docs_installation_block_template() (in module repo_helper.blocks) get_docs_links_block_template() (in module repo_helper.blocks) get_gh_actions_matrix() (ActionsManager method) get_gh_actions_python_versions() (ActionsManager method) get_license_text() (in module repo_helper.utils) get_linux_ci_requirements() (ActionsManager method) get_linux_ci_versions() (ActionsManager method) get_linux_mypy_requirements() (ActionsManager method) get_macos_ci_requirements() (ActionsManager method) get_macos_ci_versions() (ActionsManager method) get_mypy_commands() (ToxConfig method)

get_mypy_dependencies() (ToxConfig method) get_mypy_requirements() (ActionsManager method) get_readme_installation_block_no_pypi_template() (in module repo_helper.blocks) get_readme_installation_block_template() (in module repo_helper.blocks) get_setenv() (ToxConfig method) get_source_files() (ToxConfig method) get_third_party_version_matrix() (ToxConfig method) get_windows_ci_requirements() (ActionsManager method) get_windows_ci_versions() (ActionsManager method) github_bash_block() (in module repo_helper.files.contributing) github_ci_requirements configuration value GITHUB_COM (in module repo_helper.files.pre_commit) GNU Lesser General Public License v3.0, [1]

H

Hook (typeddict in repo_helper.files.pre_commit) html_context configuration value

html_theme_options configuration value

I

imgbot_ignore configuration value import_name configuration value import_registered_functions() (in module repo_helper.core) indent_join() (in module repo_helper.utils) indent_with_tab() (in module repo_helper.utils)

IniConfigurator (class in repo_helper.utils) init_repo_template_dir (in module repo_helper.templates) installation_regex (in module repo_helper.blocks) intersphinx_mapping configuration value is_registered() (in module repo_helper.files) is_running_on_actions() (in module repo_helper.testing)

K

keywords configuration value

L

license configuration value

license_lookup (in module repo_helper.utils) links_regex (in module repo_helper.blocks) load_settings() (RepoHelper method)

M

major() (Bumper method) make() (ShieldsBlock method) make_404_page() (in module repo_helper.files.docs) make_actions_deploy_conda() (in module repo_helper.files.ci_cd) make_actions_linux_shield() (in module repo_helper.shields), [1] make_actions_macos_shield() (in module repo_helper.shields) make_actions_milestones() (in module repo_helper.files.ci_cd) make_actions_shield() (in module repo_helper.shields) make_actions_windows_shield() (in module repo_helper.shields) make_activity_shield() (in module repo_helper.shields) make_alabaster_theming() (in module repo_helper.files.docs) make_auto_assign_action() (in module repo_helper.files.bots) make_codefactor_shield() (in module repo_helper.shields) make_conda_actions_ci() (in module repo_helper.files.ci_cd) make_conda_platform_shield() (in module repo_helper.shields) make_conda_version_shield() (in module repo_helper.shields) make_conf() (in module repo_helper.files.docs) make_contributing() (in module repo_helper.files.contributing) make_coveralls_shield() (in module repo_helper.shields) make_dependabot() (in module repo_helper.files.bots) make_dependabotv2() (in module repo_helper.files.bots) make_docker_automated_build_shield() (in module repo_helper.shields) make_docker_build_status_shield() (in module repo_helper.shields) make_docker_size_shield() (in module repo_helper.shields) make_docs_check_shield() (in module repo_helper.shields) make_docs_contributing() (in module repo_helper.files.contributing) make_docs_license_rst() (in module repo_helper.files.docs) make_docs_source_rst() (in module repo_helper.files.docs) make_docutils_conf() (in module repo_helper.files.docs) make_flake8() (ActionsManager method) make_formate_toml() (in module repo_helper.files.testing) make_github_ci() (in module repo_helper.files.ci_cd) make_github_docs_test() (in module repo_helper.files.ci_cd) make_github_flake8() (in module repo_helper.files.ci_cd) make_github_manylinux() (in module repo_helper.files.ci_cd) make_github_mypy() (in module repo_helper.files.ci_cd) make_github_octocheese() (in module repo_helper.files.ci_cd) make_github_url() (in module repo_helper.files.pre_commit) make_gitignore() (in module repo_helper.files.gitignore) make_imgbot() (in module repo_helper.files.bots) make_isort() (in module repo_helper.files.testing) make_issue_templates() (in module repo_helper.files.contributing) make_justfile() (in module repo_helper.files.testing) make_language_shield() (in module repo_helper.shields) make_last_commit_shield() (in module repo_helper.shields) make_license_shield() (in module repo_helper.shields) make_linux() (ActionsManager method) make_macos() (ActionsManager method) make_maintained_shield() (in module repo_helper.shields) make_manifest() (in module repo_helper.files.packaging) make_mypy() (ActionsManager method) make_pkginfo() (in module repo_helper.files.packaging) make_pre_commit() (in module repo_helper.files.pre_commit) make_pre_commit_ci_shield() (in module repo_helper.shields) make_pre_commit_shield() (in module repo_helper.shields) make_pylintrc() (in module repo_helper.files.linting)

make_pypi_downloads_shield() (in module repo_helper.shields) make_pypi_version_shield() (in module repo_helper.shields) make_pyproject() (in module repo_helper.files.packaging) make_python_implementations_shield() (in module repo_helper.shields) make_python_versions_shield() (in module repo_helper.shields) make_readthedocs_theming() (in module repo_helper.files.docs) make_recipe() (in module repo_helper.conda) make_requires_shield() (in module repo_helper.shields) make_rtfd() (in module repo_helper.files.docs) make_rtfd_shield() (in module repo_helper.shields) make_rustpython() (ActionsManager method) make_setup() (in module repo_helper.files.packaging) make_setup_cfg() (in module repo_helper.files.packaging) make_stale_bot() (in module repo_helper.files.bots) make_tox() (in module repo_helper.files.testing) make_typing_shield() (in module repo_helper.shields) make_wheel_shield() (in module repo_helper.shields) make_windows() (ActionsManager method) make_yapf() (in module repo_helper.files.testing) managed_message() (RepoHelper property) Management (class in repo_helper.files) Manager (in module repo_helper.files) manifest_additional configuration value merge_existing() (IniConfigurator method) (ToxConfig method) min_coverage configuration value minor() (Bumper method) modname configuration value module repo_helper.blocks repo_helper.conda repo_helper.core repo_helper.files repo_helper.files.bots repo_helper.files.ci_cd repo_helper.files.contributing repo_helper.files.docs repo_helper.files.gitignore repo_helper.files.linting repo_helper.files.packaging repo_helper.files.pre_commit repo_helper.files.readme repo_helper.files.testing repo_helper.release repo_helper.shields repo_helper.templates repo_helper.testing repo_helper.utils mypy_deps configuration value mypy_plugins configuration value mypy_version configuration value

N

no_dev_versions() (in module repo_helper.utils)

normalize() (in module repo_helper.utils)

O

on_conda_forge configuration value

on_pypi configuration value

P

patch() (Bumper method) pformat_tabs() (in module repo_helper.utils) platforms configuration value pre_commit_exclude configuration value preserve_custom_theme configuration value primary_conda_channel configuration value pure_python configuration value

py_modules configuration value pypi_name configuration value pytest() (ToxConfig method) Python Enhancement Proposals PEP 484, [1] PEP 503 PEP 517, [1], [2] python_deploy_version configuration value python_versions configuration value

R

reformat_file() (in module repo_helper.utils) register() (Management method) repo (Bumper attribute) Repo (class in repo_helper.files.pre_commit) repo (Repo attribute) repo-helper command line option --commit --force --message <message> --no-commit --version -f -m -n -y repo-helper-add-requirement command line option --file <file> REQUIREMENT repo-helper-add-version command line option VERSION repo-helper-broomstick command line option --rm-tox --verbose -v repo-helper-init command line option --commit --force --message <message> --no-commit -f -m -n -y repo-helper-release command line option --commit --force --message <message> --no-commit -f -m -n -y repo-helper-show-changelog command line option --colour --entries <entries> --no-colour --no-pager --reverse -n -r repo-helper-show-log command line option --colour --entries <entries> --from-date <from_date> --from-tag <from_tag> --no-colour --no-pager --reverse -n -r repo-helper-show-requirements command line option --concise --depth <depth> --no-pager --no-venv -c -d

repo-helper-show-version command line option --quiet -q repo-helper-suggest-classifiers command line option --add --library --no-add --not-library --status <status> -l -s repo_helper.blocks module repo_helper.conda module repo_helper.core module repo_helper.files module repo_helper.files.bots module repo_helper.files.ci_cd module repo_helper.files.contributing module repo_helper.files.docs module repo_helper.files.gitignore module repo_helper.files.linting module repo_helper.files.packaging module repo_helper.files.pre_commit module repo_helper.files.readme module repo_helper.files.testing module repo_helper.release module repo_helper.shields module repo_helper.templates module repo_helper.testing module repo_helper.utils module repo_name configuration value repo_name() (RepoHelper property) RepoHelper (class in repo_helper.core) REQUIREMENT repo-helper-add-requirement command line option requires_python configuration value resource() (in module repo_helper.utils) rev (Repo attribute) rewrite_docs_index() (in module repo_helper.files.docs) rewrite_readme() (in module repo_helper.files.readme) rtfd_author configuration value run() (RepoHelper method)

S

sections (ShieldsBlock attribute) set_docs_mode() (ShieldsBlock method) set_gh_actions_versions() (in module repo_helper.utils) set_readme_mode() (ShieldsBlock method) setup_pre configuration value shields_regex (in module repo_helper.blocks) ShieldsBlock (class in repo_helper.blocks) short_desc configuration value short_desc_regex (in module repo_helper.blocks) sort_paths() (in module repo_helper.utils) source_dir configuration value

sphinx_conf_epilogue configuration value sphinx_conf_preamble configuration value sphinx_html_theme configuration value stage_changes() (in module repo_helper.utils) standalone_contrib_guide configuration value stubs_package configuration value substitutions (ShieldsBlock attribute)

T

target_repo (RepoHelper attribute) template_dir (in module repo_helper.templates) templates (RepoHelper attribute) testenv() (ToxConfig method) testenv__package() (ToxConfig method) testenv_build() (ToxConfig method) testenv_coverage() (ToxConfig method) testenv_docs() (ToxConfig method) testenv_lint() (ToxConfig method) testenv_mypy() (ToxConfig method) testenv_perflint() (ToxConfig method) testenv_py312_dev() (ToxConfig method) testenv_pyup() (ToxConfig method) tests_dir configuration value third_party_version_matrix configuration value to_dict() (Repo method) today (in module repo_helper.utils)

today() (Bumper method) tox() (ToxConfig method) tox_build_requirements configuration value tox_requirements configuration value tox_testenv_extras configuration value tox_unmanaged configuration value ToxConfig (class in repo_helper.files.testing) travis_additional_requirements configuration value travis_extra_install_post configuration value travis_extra_install_pre configuration value travis_ubuntu_version configuration value

U

use_flit configuration value use_hatch configuration value use_maturin configuration value

use_whey configuration value username configuration value

V

VERSION repo-helper-add-version command line option

version configuration value

W

write_out() (IniConfigurator method)

Y

yapf_exclude configuration value