Welcome to xcookie’s documentation!

The xcookie module is a CLI tool for initializing and maintaining standardized repo infastructure. In other words it is a Python project cookie cutter that attempts to help keep existing modules up to date with latest infastructure developments.

Currently this module is specialized towards Erotemic / PyUtils / Kitware projects but the goal is to eventually generalize everything.

Read the docs	https://xcookie.readthedocs.io
Github	https://github.com/Erotemic/xcookie
Pypi	https://pypi.org/project/xcookie

• xcookie package
  • Subpackages
    • xcookie.builders package
      • Submodules
        • xcookie.builders._builder module
          • Builder
        • xcookie.builders.common_ci module
          • make_mypy_check_parts()
          • make_build_wheel_parts()
          • make_install_and_test_wheel_parts()
        • xcookie.builders.docs module
          • DocsBuilder
            • DocsBuilder.docs_dpath
            • DocsBuilder.docs_auto_outdir
            • DocsBuilder.sphinx_apidoc_invocation()
          • build_docs_index()
          • build_docs_conf()
          • build_docs_requirements()
        • xcookie.builders.docs_conf module
        • xcookie.builders.github_actions module
          • Actions
            • Actions.action_versions
            • Actions._available_action_methods()
            • Actions._check_for_updates()
            • Actions.action()
            • Actions.checkout()
            • Actions.setup_python()
            • Actions.codecov_action()
            • Actions.combine_coverage()
            • Actions.upload_artifact()
            • Actions.download_artifact()
            • Actions.msvc_dev_cmd()
            • Actions.setup_qemu()
            • Actions.setup_xcode()
            • Actions.setup_ipfs()
            • Actions.cibuildwheel()
          • build_github_actions()
          • lint_job()
          • build_and_test_sdist_job()
          • build_binpy_wheels_job()
          • get_supported_platform_info()
          • build_purewheel_job()
          • test_wheels_job()
          • build_deploy()
          • build_github_release()
        • xcookie.builders.gitlab_ci module
          • build_gitlab_ci()
          • build_gitlab_rules()
          • make_purepy_ci_jobs()
        • xcookie.builders.pyproject module
          • build_pyproject()
        • xcookie.builders.readme module
          • BadgeBuilder
            • BadgeBuilder.build_templates()
          • ReadmeBuilder
          • build_readme()
          • _ibeis_badges()
        • xcookie.builders.readthedocs module
          • build_readthedocs()
        • xcookie.builders.setup module
          • build_setup()
      • Module contents
    • xcookie.rc package
      • Submodules
        • xcookie.rc.conf_ext module
          • PatchedPythonDomain
            • PatchedPythonDomain.resolve_xref()
          • GoogleStyleDocstringProcessor
            • GoogleStyleDocstringProcessor.register_section()
            • GoogleStyleDocstringProcessor._register_builtins()
            • GoogleStyleDocstringProcessor.process()
            • GoogleStyleDocstringProcessor.process_docstring_callback()
          • SphinxDocstring
            • SphinxDocstring.find_tagged_lines()
          • paragraph()
          • create_doctest_figure()
          • postprocess_hyperlinks()
          • fix_rst_todo_section()
          • setup()
      • Module contents
        • resource_fpath()
  • Submodules
    • xcookie.__main__ module
    • xcookie.constants module
    • xcookie.directive module
      • named()
      • Effect
        • Effect._asdict()
        • Effect._field_defaults
        • Effect._fields
        • Effect._make()
        • Effect._replace()
        • Effect.action
        • Effect.key
        • Effect.value
      • extract_directive_comment()
      • Directive
        • Directive.extract()
        • Directive._unpack_args()
        • Directive.effect()
        • Directive.effects()
      • _split_opstr()
      • _is_requires_satisfied()
      • DirectiveExtractor
        • DirectiveExtractor.extract()
      • _module_exists()
      • parse_directive_optstr()
    • xcookie.main module
      • SkipFile
      • XCookieConfig
        • XCookieConfig._load_pyproject_config()
        • XCookieConfig._load_xcookie_pyproject_settings()
        • XCookieConfig.confirm()
        • XCookieConfig.prompt()
        • XCookieConfig.main()
        • XCookieConfig.default
        • XCookieConfig.normalize()
      • TemplateApplier
        • TemplateApplier.apply()
        • TemplateApplier.autostage()
        • TemplateApplier.has_git
        • TemplateApplier.rel_mod_dpath
        • TemplateApplier.mod_dpath
        • TemplateApplier.mod_name
        • TemplateApplier.pkg_name
        • TemplateApplier._build_template_registry()
        • TemplateApplier.tags
        • TemplateApplier._presetup()
        • TemplateApplier.setup()
        • TemplateApplier.copy_staged_files()
        • TemplateApplier.vcs_checks()
        • TemplateApplier._stage_file()
        • TemplateApplier._apply_xcookie_directives()
        • TemplateApplier.stage_files()
        • TemplateApplier.gather_tasks()
        • TemplateApplier.build_requirements()
        • TemplateApplier.refresh_docs()
        • TemplateApplier.rotate_secrets()
        • TemplateApplier.print_help_tips()
        • TemplateApplier.build_readthedocs()
        • TemplateApplier.build_setup()
        • TemplateApplier.build_pyproject()
        • TemplateApplier.build_github_actions()
        • TemplateApplier.build_gitlab_ci()
        • TemplateApplier.build_run_linter()
        • TemplateApplier.build_gitlab_rules()
        • TemplateApplier.build_readme()
        • TemplateApplier.build_docs_index()
        • TemplateApplier.build_docs_conf()
        • TemplateApplier.build_docs_requirements()
        • TemplateApplier.build_run_doctests()
        • TemplateApplier.lut()
        • TemplateApplier._docs_quickstart()
      • main()
      • _parse_remote_url()
      • find_git_root()
      • GitURL
        • GitURL.info
        • GitURL.to_git()
        • GitURL.to_https()
    • xcookie.rich_ext module
      • FuzzyPrompt
        • FuzzyPrompt.process_response()
    • xcookie.util_yaml module
      • _YamlRepresenter
        • _YamlRepresenter.str_presenter()
      • _custom_ruaml_loader()
      • _custom_ruaml_dumper()
      • _custom_pyaml_dumper()
      • Yaml
        • Yaml.dumps()
        • Yaml.load()
        • Yaml.loads()
        • Yaml.coerce()
        • Yaml.InlineList()
        • Yaml.Dict()
        • Yaml.CodeBlock()
      • _dev()
    • xcookie.vcs_remotes module
      • NotFound
      • Ambiguous
      • _return_one()
      • GitlabRemote
        • GitlabRemote.auth()
        • GitlabRemote.group
        • GitlabRemote.project
        • GitlabRemote.new_project()
        • GitlabRemote.set_protected_branches()
      • GithubRemote
        • GithubRemote.new_project()
        • GithubRemote.publish_release()
      • version_bump()
      • _parse_changelog()
  • Module contents

Indices and tables

• Index

• Module Index