Welcome to xcookie’s documentation!
The xcookie module is a CLI tool for initializing and maintaining standardized repo infrastructure. In other words it is a Python project cookie cutter that attempts to help keep existing modules up to date with latest infrastructure developments.
Currently this module is specialized towards Erotemic / PyUtils / Kitware projects but the goal is to eventually generalize everything.
Read the docs |
|
Github |
|
Pypi |
- xcookie package
- Subpackages
- xcookie.builders package
- Submodules
- xcookie.builders._builder module
- xcookie.builders.common_ci module
get_pyproject_optional_dependency_keys()filter_pyproject_extras()format_pyproject_install_target()make_ci_plan()make_typecheck_parts()make_build_sdist_parts()make_build_wheel_parts()make_install_and_test_wheel_parts()get_supported_platform_info()_py_shell_command()make_project_version_getter()make_project_version_assignment()
- xcookie.builders.docs module
- xcookie.builders.docs_conf module
- xcookie.builders.github_actions module
GitHubActionsRenderer_action_ref()_version_assign_command()ActionsActions.action_versionsActions._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()
_render_workflow_text()_normalize_cibuildwheel_skip_selector()_normalize_cibuildwheel_skip_string()_matrix_needs_qemu()_build_github_footer()_collect_test_jobs()_collect_release_jobs()build_github_actions()build_github_actions_tests()build_github_actions_release()lint_job()build_and_test_sdist_job()_vcpkg_build_support()build_binpy_wheels_job()build_purewheel_job()build_sdist_job()build_binpy_wheels_release_job()test_wheels_job()build_deploy()build_github_release()
- xcookie.builders.gitlab_ci module
- xcookie.builders.pyproject module
- xcookie.builders.readme module
- xcookie.builders.readthedocs module
- xcookie.builders.setup module
- Module contents
- Submodules
- xcookie.rc package
- xcookie.builders package
- Submodules
- xcookie.__main__ module
- xcookie.constants module
- xcookie.directive module
- xcookie.main module
SkipFileXCookieConfigXCookieConfig._descriptionXCookieConfig._load_pyproject_config()XCookieConfig._load_xcookie_pyproject_settings()XCookieConfig._infer_project_authors()XCookieConfig._infer_version_from_file()XCookieConfig._infer_version_from_pyproject()XCookieConfig._infer_xcookie_settings_from_pyproject()XCookieConfig.confirm()XCookieConfig.prompt()XCookieConfig.load_from_cli_and_pyproject()XCookieConfig.main()XCookieConfig._abc_impl
TemplateApplierTemplateApplier.template_infosTemplateApplier.apply()TemplateApplier.autostage()TemplateApplier.has_gitTemplateApplier.rel_mod_dpathTemplateApplier.mod_dpathTemplateApplier.mod_nameTemplateApplier.pkg_nameTemplateApplier.pkg_fname_prefixTemplateApplier._readme_fpath()TemplateApplier._readme_content_type()TemplateApplier._build_template_registry()TemplateApplier.tagsTemplateApplier._project_classifiers()TemplateApplier._presetup()TemplateApplier.setup()TemplateApplier.copy_staged_files()TemplateApplier.vcs_checks()TemplateApplier.template_contextTemplateApplier._stage_file()TemplateApplier._apply_xcookie_directives()TemplateApplier.stage_files()TemplateApplier.gather_tasks()TemplateApplier.render_patch_plan()TemplateApplier.build_requirements_txt()TemplateApplier.refresh_docs()TemplateApplier._github_org_environ()TemplateApplier._secret_rotation_backends()TemplateApplier.rotate_secrets()TemplateApplier.build_readthedocs()TemplateApplier.build_setup()TemplateApplier.build_pyproject()TemplateApplier.format_code()TemplateApplier._setup_pip_commands()TemplateApplier.build_github_actions()TemplateApplier.build_github_actions_tests()TemplateApplier.build_github_actions_release()TemplateApplier.build_gitlab_ci()TemplateApplier.build_manifest_in()TemplateApplier.build_refresh_locks_sh()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_optional_requirements()TemplateApplier.build_runtime_requirements()TemplateApplier.build_tests_requirements()TemplateApplier._build_special_requirements()TemplateApplier._build_cv2_requirements()TemplateApplier.build_cv2_headless_requirements_txt()TemplateApplier.build_cv2_graphics_requirements_txt()TemplateApplier.build_gdal_requirements_txt()TemplateApplier.build_run_doctests()TemplateApplier.lut()TemplateApplier._docs_quickstart()
main()_parse_remote_url()find_git_root()GitURL
- xcookie.rich_ext module
- xcookie.util_yaml module
- xcookie.vcs_remotes module
- Module contents
- Subpackages
- Release Workflow Design
- Trusted Publishing with GitHub Actions
- Refactor plan
- Chunk 0: generated-output safety net
- Chunk 1: typed template registry and staging layer
- Chunk 2: raw config versus resolved config
- Chunk 3: shared CI plan model
- Chunk 4: thin provider renderers
- Chunk 5: secret rotation plan
- Chunk 6: generated CI helper commands
- Chunk 7: split
TemplateApplierinto focused modules - Chunk 8: inline typing pass
- Chunk 9: remove legacy paths