Copy page

• Copy page
• View source

stouputils.continuous_delivery package

Continuous delivery and deployment utilities.

This module provides tools for automating software delivery and deployment:

Key Features: - GitHub release management and uploads - GitLab release management and uploads - PyPI package publishing utilities - pyproject.toml file management - Common CD/CI utilities - Local git changelog generation

Components:

• cd_utils: Common utilities for continuous delivery

• git: Local git changelog utilities (generate_local_changelog(), changelog_cli())

• github: GitHub-specific utilities (upload_to_github())

• gitlab: GitLab-specific utilities (upload_to_gitlab())

• pypi: PyPI publishing tools (pypi_full_routine())

• pyproject: pyproject.toml file management

# Create a git repository with a release tag and three commits after it
git init -q project && cd project
git commit -q --allow-empty -m "feat: ✨ Add the login page"
git tag -m "First release" v1.0.0
git commit -q --allow-empty -m "feat(auth): ✨ Remember the session for 30 days"
git commit -q --allow-empty -m "fix(auth): 🐛 Refuse expired tokens"
git commit -q --allow-empty -m "docs: 📝 Explain the token lifetime"

# Build the changelog of everything since the tag, grouped by commit type
stouputils changelog tag v1.0.0

Submodules

• stouputils.continuous_delivery.cd_utils module
  • parse_commit_message()
  • format_changelog()
  • format_sub_category()
  • load_credentials()
  • handle_response()
  • clean_version()
  • version_to_float()
• stouputils.continuous_delivery.git module
  • run_git_command()
  • get_local_tags()
  • get_latest_tag()
  • get_commits_since_tag()
  • get_commits_since_date()
  • get_commits_since_commit()
  • parse_date_fallback()
  • parse_commit_log()
  • get_remotes()
  • parse_remote_url()
  • detect_host_type()
  • create_url_formatter()
  • generate_local_changelog()
  • local_commits()
  • remote_url_formatters()
  • changelog_cli()
• stouputils.continuous_delivery.github module
  • UPLOAD_ATTEMPTS
  • UPLOAD_RETRY_DELAY
  • validate_github_credentials()
  • validate_github_config()
  • build_github_config()
  • delete_github_release()
  • delete_github_tag()
  • get_github_sha()
  • get_github_commit_date()
  • extract_github_commit_data()
  • get_pushed_head_sha()
  • create_github_tag()
  • create_github_release()
  • upload_github_assets()
  • upload_to_github()
• stouputils.continuous_delivery.gitlab module
  • validate_gitlab_credentials()
  • validate_gitlab_config()
  • build_gitlab_config()
  • delete_gitlab_release()
  • delete_gitlab_tag()
  • get_gitlab_sha()
  • get_gitlab_commit_date()
  • extract_gitlab_commit_data()
  • create_gitlab_tag()
  • create_gitlab_release()
  • upload_gitlab_assets()
  • upload_to_gitlab()
• stouputils.continuous_delivery.pypi module
  • update_pip_and_required_packages()
  • build_package()
  • upload_package()
  • pypi_full_routine()
  • pypi_full_routine_using_uv()
• stouputils.continuous_delivery.pyproject module
  • ONE_LINE_LIST
  • read_pyproject()
  • format_toml_lists()
  • write_pyproject()
  • increment_version_from_input()
  • increment_version_from_pyproject()
  • get_version_from_pyproject()
• stouputils.continuous_delivery.release_common module
  • PlatformConfig
    • PlatformConfig.base_url
    • PlatformConfig.project_identifier
    • PlatformConfig.headers
    • PlatformConfig.version
    • PlatformConfig.build_folder
    • PlatformConfig.endswith
    • PlatformConfig.project_api_url
    • PlatformConfig.web_url
    • PlatformConfig.tag_api_path
    • PlatformConfig.commit_api_path
    • PlatformConfig.release_api_path
    • PlatformConfig.commit_url_path
    • PlatformConfig.compare_url_path
    • PlatformConfig.platform_name
  • validate_required_keys()
  • check_existing_tag()
  • prompt_delete_existing()
  • handle_existing_tag()
  • fetch_latest_tag()
  • paginate_api()
  • fetch_commits_since_tag()
  • generate_changelog()
  • upload_files()
  • log_success()
  • delete_resource()
  • delete_resource_unconditional()
  • create_tag_on_branch()
  • create_release()
  • publish_release()