Python

Publish a package

The following curl command (modified as required before submitting) describes the process above to publish a package to your Python registry:

curl -X POST https://buildkitepackages.com/api/v1/repos/{org.slug}/{registry.name}/packages.json \
  -H "Authorization: Bearer $REGISTRY_WRITE_TOKEN" \
  -F "package[package_file]=@<path_to_file>"

where:

• {org.slug} can be obtained from the end of your Buildkite URL, after accessing Pipelines in the global navigation of your organization in Buildkite.

• {registry.name} is the name of your Python registry.

• $REGISTRY_WRITE_TOKEN is the Buildkite Packages-generated API token required to publish/upload packages to your Python registry.

• <path_to_file> is the full path required to the package file. If the file is located in the same directory that this command is running from, then no path is required.

For example, to upload the file my-python-package-0.9.7b1.tar.gz from the current directory to the My-Python-packages registry in the My organization Buildkite organization, run the curl command:

curl -X POST https://buildkitepackages.com/api/v1/repos/my-organization/my-python-packages/packages.json \
  -H "Authorization: Bearer $REPLACE_WITH_MY_REGISTRY_WRITE_TOKEN" \
  -F "package[package_file]=@my-python-package-0.9.7b1.tar.gz"

Access a package's details

A Python package's details can be accessed from this registry using the Packages section of your Python registry page.

To access your Python package's details page:

1. Select Packages in the global navigation to access the Registries page.
2. Select your Python registry on this page.
3. On your Python registry page, select the package within the Packages section. The package's details page is displayed.

The package's details page provides the following information in the following sections:

• Installation (tab): the installation instructions.
• Contents (tab, where available): a list of directories and files contained within the package.
• Details (tab): a list of checksum values for this package—MD5, SHA1, SHA256, and SHA512.
• About this version: a brief (metadata) description about the package.

• Details: details about:

  • the name of the package (typically the file name excluding any version details and extension).
  • the package version.
  • the registry the package is located in.
  • the package's visibility (based on its registry's visibility)—whether the package is Private and requires authentication to access, or is publicly accessible.
  • the distribution name / version.
  • additional optional metadata contained within the package, such as a homepage, licenses, etc.

• Last pushed: the date when the last package was uploaded to the registry.

• Total files: the total number of files (and directories) within the package.

• Dependencies: the number of dependency packages required by this package.

• Package size: the storage size (in bytes) of this package.

• Downloads: the number of times this package has been downloaded.

Downloading a package

A Python package can be downloaded from the package's details page.

To download a package:

1. Access the package's details.
2. Select Download.

Installing a package

A Python package can be installed using code snippet details provided on the package's details page.

To install a package:

1. Access the package's details.
2. Ensure the Installation > Installation instructions section is displayed.
3. Copy the code snippet and paste this into either the package installer for Python (pip) configuration (pip.conf) file or end of the virtualenv requirements.txt file before installing this Python package.

The pip.conf code snippet is based on this format:

# Add this to the [global] section in your ~/.pip/pip.conf:
[global]
extra-index-url="https://{registry.read.token}@buildkitepackages.com/{org.slug}/{registry.name}/pypi/simple"

where:

• {registry.read.token} is the Buildkite Packages-generated API token required to download packages from your Python registry. This URL component, along with the following @ are not required for registries that are publicly accessible.

• {org.slug} can be obtained from the end of your Buildkite URL, after accessing Pipelines in the global navigation of your organization in Buildkite.

• {registry.name} is the name of your Python registry.

The alternative requirements.txt (for virtualenv) code snippet is based on this format:

# Otherwise if installing on a virtualenv, add this to the bottom of your requirements.txt:
--extra-index-url="https://{registry.read.token}@buildkitepackages.com/{org.slug}/{registry.name}/pypi/simple"