Skip to content

twine

twine documentation

footman._stubs.twine.Twine

Bases: Tool

__call__ 

__call__(
    *args: str, no_color: _Flag = ..., **flags: Any
) -> Result

Run this verb.

Parameters:

Name Type Description Default
no_color _Flag

disable colored output.

 ...

check 

check(
    dist: str,
    /,
    *args: str,
    strict: _Flag = ...,
    **flags: Any,
) -> Result

Run this verb.

Parameters:

Name Type Description Default
strict _Flag

Fail on warnings.

 ...

flags 

flags(*, no_color: _Flag = ..., **flags: Any) -> Twine

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.

upload 

upload(
    dist: str,
    /,
    *args: 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,
) -> Result

[--config-file CONFIG_FILE][--skip-existing] [--cert path] [--client-cert path] [--verbose][--disable-progress-bar]

Parameters:

Name Type Description Default
attestations _Flag

Upload each file's associated attestations.

 ...
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.

 ...