define_08_saas

Setup SaaS services for your Open Source Python project.

class pywf_internal_proprietary.define_08_saas.PyWfSaas

Namespace class for SaaS service setup automation.

edit_github_repo_metadata(real_run: bool = True, verbose: bool = True)

Edit GitHub repo metadata such as description and homepage URL.

Ref:

• https://pygithub.readthedocs.io/en/latest/examples/Repository.html

Returns:

a boolean flag to indicate whether the operation is performed.

get_codecov_io_upload_token(real_run: bool = True) → str | None

Get the upload token for codecov io for your GitHub repo.

Ref:

• https://docs.codecov.com/reference/repos_retrieve

• https://docs.codecov.com/reference/repos_config_retrieve

Returns:

the upload token for codecov.io.

setup_codecov_io_upload_token_on_github(real_run: bool = True, verbose: bool = True)

Apply the codecov upload token to GitHub Action secrets in your GitHub repository.

Ref:

• https://docs.codecov.com/reference/repos_retrieve

• https://docs.codecov.com/reference/repos_config_retrieve

• https://pygithub.readthedocs.io/en/latest/examples/Repository.html

Returns:

a boolean flag to indicate whether the operation is performed.

setup_secret_env_var_on_github(real_run: bool = True, verbose: bool = True)

Apply necessary secret environment variable to GitHub Action secrets in your GitHub repository.

Ref:

• https://pygithub.readthedocs.io/en/latest/examples/Repository.html

Returns:

a boolean flag to indicate whether the operation is performed.