Index

A

add_badge() (in module compwa_policy.utilities.readme) (ModifiableReadme method) add_dependency() (in module compwa_policy.utilities.pyproject.setters) (ModifiablePyproject method) add_extension_recommendation() (in module compwa_policy.utilities.vscode) add_json_schema_precommit() (in module compwa_policy.repo.citation) add_recommendation() (ModifiableVscodeExtensions method) add_unwanted() (ModifiableVscodeExtensions method) add_unwanted_extension() (in module compwa_policy.utilities.vscode) additional_dependencies (Hook attribute) alias (Hook attribute) allow_deprecated_workflows (Arguments attribute)

allow_labels (Arguments attribute) allow_vscode_coverage_gutters (Arguments attribute) allowed_cell_metadata (Arguments attribute) always_run (Hook attribute) append_safe() (in module compwa_policy.utilities) args (Hook attribute) Arguments (class in compwa_policy) autofix_commit_msg (PrecommitCi attribute) autofix_prs (PrecommitCi attribute) autoupdate_branch (PrecommitCi attribute) autoupdate_commit_msg (PrecommitCi attribute) autoupdate_schedule (PrecommitCi attribute)

B

bootstrap() (in module compwa_policy.cli.bootstrap)

branch_coverage (Arguments attribute)

C

changed (ModifiablePath property) (ModifiableResource property) Changelog (in module compwa_policy.utilities.resource) changelog (ModifiablePath property) (ModifiablePrecommit property) (ModifiablePyproject property) (ModifiableReadme property) (ModifiableResource property) (Session attribute) ChangelogItem (in module compwa_policy.utilities.resource) characterize_repository() (in module compwa_policy.characterization) check_citation_keys() (in module compwa_policy.repo.citation) check_hook() (in module compwa_policy.utilities.check_hook) CheckContext (class in compwa_policy.utilities.check_hook) CheckHook (class in compwa_policy.utilities.check_hook) ci (PrecommitConfig attribute) ci_skipped_tests (Arguments attribute) collect_changes() (Session method) complies_with_subset() (in module compwa_policy.utilities.pyproject) compwa_policy module compwa_policy.characterization module compwa_policy.cli module compwa_policy.cli.bootstrap module compwa_policy.cli.env module compwa_policy.cli.format module compwa_policy.cli.github module compwa_policy.cli.migrate module compwa_policy.cli.nb module compwa_policy.cli.python module compwa_policy.cli.repo module compwa_policy.config module compwa_policy.env module compwa_policy.env.conda module compwa_policy.env.direnv module compwa_policy.env.pixi module compwa_policy.env.uv module compwa_policy.errors module compwa_policy.format module compwa_policy.format.cspell module compwa_policy.format.editorconfig module compwa_policy.format.precommit module compwa_policy.format.prettier module compwa_policy.format.toml module compwa_policy.github module compwa_policy.github.dependabot module compwa_policy.github.labels module compwa_policy.github.release_drafter module compwa_policy.github.upgrade_lock module compwa_policy.github.workflows module compwa_policy.nb module compwa_policy.nb.binder module

compwa_policy.nb.jupyter module compwa_policy.nb.nbstripout module compwa_policy.python module compwa_policy.python.black module compwa_policy.python.mypy module compwa_policy.python.pyproject module compwa_policy.python.pyright module compwa_policy.python.pytest module compwa_policy.python.pyupgrade module compwa_policy.python.ruff module compwa_policy.python.ty module compwa_policy.repo module compwa_policy.repo.citation module compwa_policy.repo.commitlint module compwa_policy.repo.deprecated module compwa_policy.repo.gitpod module compwa_policy.repo.poe module compwa_policy.repo.readthedocs module compwa_policy.repo.upgrade module compwa_policy.repo.vscode module compwa_policy.self_check module compwa_policy.utilities module compwa_policy.utilities.cfg module compwa_policy.utilities.check_hook module compwa_policy.utilities.match module compwa_policy.utilities.precommit module compwa_policy.utilities.precommit.getters module compwa_policy.utilities.precommit.setters module compwa_policy.utilities.precommit.struct module compwa_policy.utilities.pyproject module compwa_policy.utilities.pyproject.getters module compwa_policy.utilities.pyproject.setters module compwa_policy.utilities.python module compwa_policy.utilities.readme module compwa_policy.utilities.resource module compwa_policy.utilities.session module compwa_policy.utilities.toml module compwa_policy.utilities.vscode module compwa_policy.utilities.yaml module contains_line() (in module compwa_policy.utilities) convert_zenodo_json() (in module compwa_policy.repo.citation) create() (FileSet class method) create_prettier_round_trip_yaml() (in module compwa_policy.utilities.yaml) create_sub_table() (in module compwa_policy.utilities.pyproject.setters)

D

default_stages (PrecommitConfig attribute) detect_package_manager() (in module compwa_policy.characterization) detect_type_checkers() (in module compwa_policy.characterization) dev_python_version (Arguments attribute) directories (FileSet attribute) doc_apt_packages (Arguments attribute) (CheckContext attribute) document (Precommit property)

dump() (ModifiablePath method) (ModifiablePrecommit method) (ModifiablePyproject method) (ModifiableReadme method) (ModifiableResource method) (ReadTheDocs method) dumps() (ModifiablePyproject method) (Precommit method) (Pyproject method)

E

enabled (CheckHook attribute) entry (Hook attribute) env() (in module compwa_policy.cli.env) environment (PixiActivation attribute) environment_variables (Arguments attribute) (CheckContext attribute)

exclude (Hook attribute) (PrecommitConfig attribute) exclude_types (Hook attribute) excluded_dependencies (Arguments attribute) excluded_python_versions (Arguments attribute) exists (ModifiablePath property)

F

fail_fast (PrecommitConfig attribute) files (CheckHook attribute) (Hook attribute) (PrecommitConfig attribute) FileSet (class in compwa_policy.utilities.check_hook) filter_patterns() (in module compwa_policy.utilities.match) finalize() (ReadTheDocs method)

find_hook() (in module compwa_policy.utilities.precommit.getters) find_repo() (in module compwa_policy.utilities.precommit.getters) (Precommit method) find_repo_with_index() (in module compwa_policy.utilities.precommit.getters) (Precommit method) flush() (Session method) format_() (in module compwa_policy.cli.format) format_config() (in module compwa_policy.utilities.cfg)

G

get() (Session method) get_click_command() (in module compwa_policy.cli) get_constraints_file() (in module compwa_policy.utilities.pyproject) get_dependabot_ecosystems() (in module compwa_policy.github.dependabot) get_julia_manifest_paths() (in module compwa_policy.repo.upgrade) get_julia_upgrade_command() (in module compwa_policy.repo.upgrade) get_latest_rev() (in module compwa_policy.utilities.precommit.getters) get_local_hooks() (in module compwa_policy.format.precommit) get_nested_dict() (in module compwa_policy.utilities) get_non_functional_hooks() (in module compwa_policy.format.precommit) get_package_name() (in module compwa_policy.utilities.pyproject.getters) (Pyproject method) get_path() (Session method) get_project_urls() (in module compwa_policy.utilities.pyproject.getters) get_recommended() (ModifiableVscodeExtensions method) get_recommended_extensions() (in module compwa_policy.utilities.vscode)

get_repo_url() (Pyproject method) get_source_url() (in module compwa_policy.utilities.pyproject.getters) get_sub_table() (in module compwa_policy.utilities.pyproject.getters) (in module compwa_policy.utilities.pyproject.setters) get_supported_python_versions() (in module compwa_policy.utilities.pyproject.getters) (Pyproject method) get_table() (ModifiablePyproject method) (Pyproject method) get_unwanted() (ModifiableVscodeExtensions method) get_unwanted_extensions() (in module compwa_policy.utilities.vscode) get_uv_upgrade_script() (in module compwa_policy.repo.upgrade) git_ls_files() (in module compwa_policy.utilities.match) github() (in module compwa_policy.cli.github) github_pages (Arguments attribute) gitpod (Arguments attribute) group (CheckHook attribute) GROUP_FLAGS (in module compwa_policy.cli.migrate)

H

has_constraint_files() (in module compwa_policy.utilities.python) has_dependency() (in module compwa_policy.utilities.pyproject) has_documentation() (in module compwa_policy.characterization) has_nested_uv_lock() (in module compwa_policy.repo.upgrade) has_notebooks (CheckContext attribute) has_notebooks() (in module compwa_policy.characterization) has_pixi_config() (in module compwa_policy.env.pixi)

has_pyproject_package_name() (in module compwa_policy.utilities.pyproject) has_python_code (RepositoryCharacterization attribute) has_python_code() (in module compwa_policy.characterization) has_sub_table() (in module compwa_policy.utilities.pyproject.getters) has_table() (Pyproject method) hash_file() (in module compwa_policy.utilities) Hook (class in compwa_policy.utilities.precommit.struct) hooks (Repo attribute)

I

id (Hook attribute) imports_on_top (Arguments attribute)

is_committed() (in module compwa_policy.utilities.match) is_python_repo (CheckContext attribute)

K

keep_contributing_md (Arguments attribute) keep_issue_templates (Arguments attribute)

keep_pr_linting (Arguments attribute) keep_workflow (Arguments attribute)

L

language (Hook attribute) language_version (Hook attribute) load() (ModifiablePath class method) (ModifiablePixi class method) (ModifiablePyproject class method) (ModifiableReadme class method) (ModifiableResource class method) (Precommit class method) (Pyproject class method) (Session class method)

load_path() (ModifiablePath class method) load_pyproject_toml() (in module compwa_policy.utilities.pyproject) log_file (Hook attribute)

M

macos_python_version (Arguments attribute) main() (in module compwa_policy.cli) (in module compwa_policy.self_check) matches_files() (in module compwa_policy.utilities.match) matches_patterns() (in module compwa_policy.utilities.match) migrate() (in module compwa_policy.cli.migrate) migrate_notebook_hooks_to_nbhooks() (in module compwa_policy.format.precommit) minimum_pre_commit_version (PrecommitConfig attribute) ModifiablePath (class in compwa_policy.utilities.resource) ModifiablePixi (class in compwa_policy.utilities.pyproject) ModifiablePrecommit (class in compwa_policy.utilities.precommit) ModifiablePyproject (class in compwa_policy.utilities.pyproject) ModifiableReadme (class in compwa_policy.utilities.readme) ModifiableResource (class in compwa_policy.utilities.resource) ModifiableVscodeExtensions (class in compwa_policy.utilities.vscode) ModifiableVscodeSettings (class in compwa_policy.utilities.vscode) module compwa_policy compwa_policy.characterization compwa_policy.cli compwa_policy.cli.bootstrap compwa_policy.cli.env compwa_policy.cli.format compwa_policy.cli.github compwa_policy.cli.migrate compwa_policy.cli.nb compwa_policy.cli.python compwa_policy.cli.repo compwa_policy.config compwa_policy.env compwa_policy.env.conda compwa_policy.env.direnv compwa_policy.env.pixi compwa_policy.env.uv compwa_policy.errors compwa_policy.format compwa_policy.format.cspell compwa_policy.format.editorconfig compwa_policy.format.precommit compwa_policy.format.prettier compwa_policy.format.toml compwa_policy.github compwa_policy.github.dependabot compwa_policy.github.labels compwa_policy.github.release_drafter compwa_policy.github.upgrade_lock compwa_policy.github.workflows compwa_policy.nb compwa_policy.nb.binder compwa_policy.nb.jupyter compwa_policy.nb.nbstripout compwa_policy.python compwa_policy.python.black compwa_policy.python.mypy compwa_policy.python.pyproject compwa_policy.python.pyright compwa_policy.python.pytest compwa_policy.python.pyupgrade compwa_policy.python.ruff compwa_policy.python.ty compwa_policy.repo compwa_policy.repo.citation compwa_policy.repo.commitlint compwa_policy.repo.deprecated compwa_policy.repo.gitpod compwa_policy.repo.poe compwa_policy.repo.readthedocs compwa_policy.repo.upgrade compwa_policy.repo.vscode compwa_policy.self_check compwa_policy.utilities compwa_policy.utilities.cfg compwa_policy.utilities.check_hook compwa_policy.utilities.match compwa_policy.utilities.precommit compwa_policy.utilities.precommit.getters compwa_policy.utilities.precommit.setters compwa_policy.utilities.precommit.struct compwa_policy.utilities.pyproject compwa_policy.utilities.pyproject.getters compwa_policy.utilities.pyproject.setters compwa_policy.utilities.python compwa_policy.utilities.readme compwa_policy.utilities.resource compwa_policy.utilities.session compwa_policy.utilities.toml compwa_policy.utilities.vscode compwa_policy.utilities.yaml

N

name (Hook attribute) natural_sorting() (in module compwa_policy.utilities) nb() (in module compwa_policy.cli.nb) no_binder (Arguments attribute) no_cd (Arguments attribute) no_cspell_update (Arguments attribute)

no_github_actions (Arguments attribute) no_milestones (Arguments attribute) no_pypi (Arguments attribute) no_ruff (Arguments attribute) no_version_branches (Arguments attribute) NOTEBOOK_HOOK_IDS (in module compwa_policy.format.precommit)

O

open_config() (in module compwa_policy.utilities.cfg)

P

package_manager (Arguments attribute) (RepositoryCharacterization attribute) PackageManagerChoice (in module compwa_policy.config) parser (Precommit property) pass_filenames (Hook attribute) path (ModifiableVscodeExtensions attribute) (ModifiableVscodeSettings attribute) paths (FileSet attribute) patterns (FileSet attribute) pixi (Session property)

PixiActivation (class in compwa_policy.nb.binder) PolicyError Precommit (class in compwa_policy.utilities.precommit) precommit (Session property) PrecommitCi (class in compwa_policy.utilities.precommit.struct) PrecommitConfig (class in compwa_policy.utilities.precommit.struct) Pyproject (class in compwa_policy.utilities.pyproject) pyproject (Session property) pytest_single_threaded (Arguments attribute) python (Arguments attribute) python() (in module compwa_policy.cli.python)

R

read() (in module compwa_policy.utilities) read_preserved_yaml() (in module compwa_policy.utilities.yaml) read_text() (ModifiablePath method) ReadTheDocs (class in compwa_policy.repo.readthedocs) remove() (ModifiablePath method) (ModifiableVscodeSettings method) remove_badge() (in module compwa_policy.utilities.readme) (ModifiableReadme method) remove_configs() (in module compwa_policy.utilities) remove_dependency() (in module compwa_policy.utilities.pyproject.setters) (ModifiablePyproject method) remove_extension_recommendation() (in module compwa_policy.utilities.vscode) remove_gitpod_config() (in module compwa_policy.repo.gitpod) remove_hook() (ModifiablePrecommit method) remove_lines() (in module compwa_policy.utilities) remove_precommit_hook() (in module compwa_policy.utilities.precommit.setters) remove_recommendation() (ModifiableVscodeExtensions method)

remove_settings() (in module compwa_policy.utilities.vscode) remove_workflow() (in module compwa_policy.github.workflows) remove_zenodo_json() (in module compwa_policy.repo.citation) RemovedKeys (in module compwa_policy.utilities.vscode) rename_file() (in module compwa_policy.utilities) Repo (class in compwa_policy.utilities.precommit.struct) repo (Repo attribute) repo() (in module compwa_policy.cli.repo) repo_name (Arguments attribute) repo_organization (Arguments attribute) repo_title (Arguments attribute) repos (PrecommitConfig attribute) RepositoryCharacterization (class in compwa_policy.characterization) require_serial (Hook attribute) rev (Repo attribute) run (CheckHook attribute) run_everything() (in module compwa_policy.cli)

S

scripts (PixiActivation attribute) Session (class in compwa_policy.utilities.session) skip (PrecommitCi attribute)

source (Precommit property) split_dependency_definition() (in module compwa_policy.utilities.pyproject.setters) stages (Hook attribute) submodules (PrecommitCi attribute)

T

to_inline_table() (in module compwa_policy.utilities.toml) to_multiline_string() (in module compwa_policy.utilities.toml) to_regex() (FileSet method) to_toml_array() (in module compwa_policy.utilities.toml) tombi_errors_on_warnings (Arguments attribute) toml_formatter (Arguments attribute)

toml_formatter_configured (Arguments attribute) TomlFormatter (in module compwa_policy) type_checker (Arguments attribute) type_checkers (RepositoryCharacterization attribute) TypeChecker (in module compwa_policy.config) types (Hook attribute) types_or (Hook attribute)

U

union() (FileSet class method) update() (ModifiableVscodeSettings method) update_conda_environment() (in module compwa_policy.env.conda) update_file() (in module compwa_policy.utilities) update_hook() (ModifiablePrecommit method) update_precommit_hook() (in module compwa_policy.utilities.precommit.setters)

update_settings() (in module compwa_policy.utilities.vscode) update_single_hook_precommit_repo() (in module compwa_policy.utilities.precommit.setters) update_single_hook_repo() (ModifiablePrecommit method) update_vscode_settings() (in module compwa_policy.repo.citation) update_workflow() (in module compwa_policy.github.workflows) upgrade_frequency (Arguments attribute) UpgradeFrequency (in module compwa_policy.config)

V

validate() (in module compwa_policy.utilities.precommit.struct)

verbose (Hook attribute)

W

write() (in module compwa_policy.utilities) write_config() (in module compwa_policy.utilities.cfg)

write_text() (ModifiablePath method) write_yaml() (in module compwa_policy.utilities.yaml)