compwa_policy

import compwa_policy

Bundled developer configurations and tools for ComPWA repositories.

This package contains pre-commit hooks that the ComPWA repositories have in common.

Submodules and Subpackages

• check_dev_files
  • main()
  • Arguments
    • Arguments.allow_deprecated_workflows
    • Arguments.allow_labels
    • Arguments.allowed_cell_metadata
    • Arguments.ci_skipped_tests
    • Arguments.dev_python_version
    • Arguments.doc_apt_packages
    • Arguments.environment_variables
    • Arguments.excluded_python_versions
    • Arguments.github_pages
    • Arguments.gitpod
    • Arguments.imports_on_top
    • Arguments.keep_contributing_md
    • Arguments.keep_issue_templates
    • Arguments.keep_local_precommit
    • Arguments.keep_pr_linting
    • Arguments.keep_workflow
    • Arguments.macos_python_version
    • Arguments.no_binder
    • Arguments.no_cd
    • Arguments.no_cspell_update
    • Arguments.no_github_actions
    • Arguments.no_milestones
    • Arguments.no_pypi
    • Arguments.no_ruff
    • Arguments.no_version_branches
    • Arguments.package_manager
    • Arguments.pytest_single_threaded
    • Arguments.python
    • Arguments.repo_name
    • Arguments.repo_organization
    • Arguments.repo_title
    • Arguments.type_checker
    • Arguments.upgrade_frequency
  • pixi
    • has_pixi_config()
    • main()
  • binder
    • main()
    • PixiActivation
      • PixiActivation.scripts
      • PixiActivation.environment
  • black
    • main()
  • citation
    • main()
    • convert_zenodo_json()
    • remove_zenodo_json()
    • check_citation_keys()
    • add_json_schema_precommit()
    • update_vscode_settings()
  • commitlint
    • main()
  • conda
    • PackageManagerChoice
    • main()
    • update_conda_environment()
  • cspell
    • main()
  • dependabot
    • main()
    • get_dependabot_ecosystems()
  • deprecated
    • remove_deprecated_tools()
  • direnv
    • main()
  • editorconfig
    • main()
  • github_labels
    • main()
  • github_workflows
    • main()
    • remove_workflow()
    • update_workflow()
  • gitpod
    • main()
    • remove_gitpod_config()
  • jupyter
    • main()
  • mypy
    • main()
  • nbstripout
    • main()
  • poe
    • main()
  • precommit
    • main()
    • get_local_hooks()
    • get_non_functional_hooks()
  • prettier
    • main()
  • pyproject
    • main()
  • pyright
    • main()
  • pytest
    • main()
  • pyupgrade
    • main()
  • readthedocs
    • main()
    • ReadTheDocs
      • ReadTheDocs.dump()
      • ReadTheDocs.finalize()
  • release_drafter
    • main()
  • ruff
    • main()
  • toml
    • main()
  • ty
    • TypeChecker
    • main()
  • upgrade_lock
    • Frequency
    • main()
  • uv
    • main()
  • vscode
    • main()
• utilities
  • append_safe()
  • contains_line()
  • hash_file()
  • read()
  • write()
  • remove_configs()
  • rename_file()
  • remove_lines()
  • natural_sorting()
  • update_file()
  • get_nested_dict()
  • precommit
    • Precommit
      • Precommit.document
      • Precommit.parser
      • Precommit.source
      • Precommit.load()
      • Precommit.dumps()
      • Precommit.find_repo()
      • Precommit.find_repo_with_index()
    • ModifiablePrecommit
      • ModifiablePrecommit.dump()
      • ModifiablePrecommit.changelog
      • ModifiablePrecommit.remove_hook()
      • ModifiablePrecommit.update_single_hook_repo()
      • ModifiablePrecommit.update_hook()
    • getters
      • find_repo()
      • find_repo_with_index()
    • setters
      • remove_precommit_hook()
      • update_single_hook_precommit_repo()
      • update_precommit_hook()
    • struct
      • PrecommitConfig
        • PrecommitConfig.ci
        • PrecommitConfig.repos
        • PrecommitConfig.default_stages
        • PrecommitConfig.files
        • PrecommitConfig.exclude
        • PrecommitConfig.fail_fast
        • PrecommitConfig.minimum_pre_commit_version
      • PrecommitCi
        • PrecommitCi.autofix_commit_msg
        • PrecommitCi.autofix_prs
        • PrecommitCi.autoupdate_branch
        • PrecommitCi.autoupdate_commit_msg
        • PrecommitCi.autoupdate_schedule
        • PrecommitCi.skip
        • PrecommitCi.submodules
      • Repo
        • Repo.repo
        • Repo.rev
        • Repo.hooks
      • Hook
        • Hook.id
        • Hook.alias
        • Hook.name
        • Hook.entry
        • Hook.language
        • Hook.language_version
        • Hook.files
        • Hook.exclude
        • Hook.types
        • Hook.types_or
        • Hook.exclude_types
        • Hook.args
        • Hook.stages
        • Hook.additional_dependencies
        • Hook.always_run
        • Hook.require_serial
        • Hook.verbose
        • Hook.log_file
        • Hook.pass_filenames
      • validate()
  • pyproject
    • Pyproject
      • Pyproject.load()
      • Pyproject.dumps()
      • Pyproject.get_table()
      • Pyproject.has_table()
      • Pyproject.get_package_name()
      • Pyproject.get_repo_url()
      • Pyproject.get_supported_python_versions()
    • ModifiablePyproject
      • ModifiablePyproject.load()
      • ModifiablePyproject.dumps()
      • ModifiablePyproject.dump()
      • ModifiablePyproject.get_table()
      • ModifiablePyproject.add_dependency()
      • ModifiablePyproject.remove_dependency()
      • ModifiablePyproject.changelog
    • complies_with_subset()
    • has_pyproject_package_name()
    • has_dependency()
    • get_constraints_file()
    • load_pyproject_toml()
    • getters
      • get_package_name()
      • get_project_urls()
      • get_source_url()
      • get_supported_python_versions()
      • get_sub_table()
      • has_sub_table()
    • setters
      • add_dependency()
      • create_sub_table()
      • get_sub_table()
      • remove_dependency()
      • split_dependency_definition()
  • cfg
    • format_config()
    • open_config()
    • write_config()
  • executor
    • Executor
      • Executor.__call__()
      • Executor.error_messages
      • Executor.merge_messages()
      • Executor.print_execution_times()
  • match
    • filter_patterns()
    • git_ls_files()
    • is_committed()
    • matches_files()
    • matches_patterns()
  • notebook
    • load_notebook()
  • python
    • has_constraint_files()
  • readme
    • add_badge()
    • remove_badge()
  • toml
    • to_toml_array()
    • to_inline_table()
    • to_multiline_string()
  • vscode
    • RemovedKeys
    • get_recommended_extensions()
    • get_unwanted_extensions()
    • remove_settings()
    • update_settings()
    • add_extension_recommendation()
    • add_unwanted_extension()
    • remove_extension_recommendation()
  • yaml
    • create_prettier_round_trip_yaml()
    • read_preserved_yaml()
    • write_yaml()

• colab_toc_visible
  • main()
• config
• errors
  • PrecommitError
• fix_nbformat_version
  • main()
  • set_nbformat_version()
  • remove_cell_ids()
  • check_svg_output_cells()
• remove_empty_tags
  • main()
• self_check
  • main()
• set_nb_cells
  • main()
• set_nb_display_name
  • main()