Skip to content

Upload#

Upload built packages to various conda package servers.

You can import the upload functions from rattler_build:

from rattler_build import (
    upload_package_to_quetz,
    upload_package_to_artifactory,
    upload_package_to_prefix,
    upload_package_to_anaconda,
    upload_packages_to_conda_forge,
)

upload_package_to_quetz#

Upload to a Quetz server. Authentication is used from the keychain / auth-file.

Parameters:

Name Type Description Default
package_files list[str]

The package files to upload.

required
url str

The URL of the Quetz server.

required
channels str

The channels to upload the package to.

required
api_key str | None

The API key for authentication.

None
auth_file str | Path | None

The authentication file.

None

Returns:

Type Description
None

None

upload_package_to_artifactory#

Upload to an Artifactory channel. Authentication is used from the keychain / auth-file.

Parameters:

Name Type Description Default
package_files list[str]

The package files to upload.

required
url str

The URL to your Artifactory server.

required
channels str

The URL to your channel.

required
token str | None

Your Artifactory token.

None
auth_file str | Path | None

The authentication file.

None

Returns:

Type Description
None

None

upload_package_to_prefix#

Upload to a prefix.dev server. Authentication is used from the keychain / auth-file.

Parameters:

Name Type Description Default
package_files list[str]

The package files to upload.

required
url str

The URL to the prefix.dev server (only necessary for self-hosted instances).

required
channels str

The channel to upload the package to.

required
api_key str | None

The prefix.dev API key, if none is provided, the token is read from the keychain / auth-file.

None
auth_file str | Path | None

The authentication file.

None
skip_existing bool

Skip upload if package is existed.

False
force bool

Whether to force overwrite existing packages.

False
generate_attestation bool

Whether to generate an attestation for the uploaded packages.

False
attestation_file str | Path | None

Path to an attestation file to upload along with the packages (note: only a single package can be uploaded when using this).

None
store_github_attestation bool

Whether to store the GitHub attestation.

False

Returns:

Type Description
None

None

upload_package_to_anaconda#

Upload to an Anaconda.org server.

Parameters:

Name Type Description Default
package_files list[str]

The package files to upload.

required
owner str

The owner of the Anaconda.org account.

required
channel list[str] | None

The channels to upload the package to.

None
api_key str | None

The Anaconda.org API key.

None
url str | None

The URL to the Anaconda.org server.

None
force bool

Whether to force the upload.

False
auth_file str | Path | None

The authentication file.

None

Returns:

Type Description
None

None

upload_packages_to_conda_forge#

Upload to conda forge.

Parameters:

Name Type Description Default
package_files list[str | Path]

The package files to upload.

required
staging_token str

The staging token for conda forge.

required
feedstock str

The feedstock repository.

required
feedstock_token str

The feedstock token.

required
staging_channel str | None

The staging channel for the upload.

None
anaconda_url str | None

The URL to the Anaconda.org server.

None
validation_endpoint str | None

The validation endpoint.

None
provider str | None

The provider for the upload.

None
dry_run bool

Whether to perform a dry run.

False

Returns:

Type Description
None

None