Skip to content

twine

twine documentation

toolroom._stubs.twine.Twine

Bases: Tool[_R]

Check

Bases: Tool[_R2]

__call__ 

__call__(
    dist: str | PathLike[str],
    /,
    *args: str | PathLike[str],
    strict: Flag = ...,
    **flags: Any,
) -> _R2

Run this verb.

Parameters:

Name Type Description Default
strict Flag

Fail on warnings.

 ...

Upload

Bases: Tool[_R2]

__call__ 

__call__(
    dist: str | PathLike[str],
    /,
    *args: str | PathLike[str],
    attestations: Flag = ...,
    cert: Value = ...,
    client_cert: Value = ...,
    comment: Value = ...,
    config_file: Value = ...,
    disable_progress_bar: Flag = ...,
    identity: Value = ...,
    non_interactive: Flag = ...,
    password: Value = ...,
    repository: Value = ...,
    repository_url: Value = ...,
    sign: Flag = ...,
    sign_with: Value = ...,
    skip_existing: Flag = ...,
    username: Value = ...,
    verbose: Flag = ...,
    **flags: Any,
) -> _R2

Run this verb.

Parameters:

Name Type Description Default
attestations Flag

Upload each file's associated attestations. Added in 5.1.0.

 ...
cert Value

Path to alternate CA bundle (can also be set via TWINE_CERT environment variable).

 ...
client_cert Value

Path to SSL client certificate, a single file containing the private key and the certificate in PEM format.

 ...
comment Value

The comment to include with the distribution file.

 ...
config_file Value

The .pypirc config file to use.

 ...
disable_progress_bar Flag

Disable the progress bar.

 ...
identity Value

GPG identity used to sign files.

 ...
non_interactive Flag

Do not interactively prompt for username/password if the required credentials are missing.

 ...
password Value

The password to authenticate to the repository (package index) with.

 ...
repository Value

The repository (package index) to upload the package to. Defaults to pypi.

 ...
repository_url Value

The repository (package index) URL to upload the package to.

 ...
sign Flag

Sign files to upload using GPG.

 ...
sign_with Value

GPG program used to sign uploads. Defaults to gpg.

 ...
skip_existing Flag

Continue uploading files if one already exists.

 ...
username Value

The username to authenticate to the repository (package index) as.

 ...
verbose Flag

Show verbose output.

 ...

__call__ 

__call__(
    *args: str | PathLike[str],
    no_color: Flag = ...,
    **flags: Any,
) -> _R

Run this verb.

Parameters:

Name Type Description Default
no_color Flag

disable colored output.

 ...

flags 

flags(*, no_color: Flag = ..., **flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.