Python

Publish a package

The following curl command (which you'll need to modify as required before submitting) describes the process above to publish a Python package to your Python registry:

curl -X POST https://api.buildkite.com/v2/packages/organizations/{org.slug}/registries/{registry.slug}/packages \
  -H "Authorization: Bearer $REGISTRY_WRITE_TOKEN" \
  -F "file=@<path_to_file>"

where:

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

• {registry.slug} is the slug of your Python registry, which is the kebab-case version of your Python registry name, and can be obtained after accessing Packages in the global navigation > your Python registry from the Registries page.

• $REGISTRY_WRITE_TOKEN is your API access token used to publish/upload packages to your Python registry. Ensure this access token has the Write Packages REST API scope, which allows this token to publish packages to any registry your user account has access to within your Buildkite organization.

• <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://api.buildkite.com/v2/packages/organizations/my-organization/registries/my-python-packages/packages \
  -H "Authorization: Bearer $REPLACE_WITH_YOUR_REGISTRY_WRITE_TOKEN" \
  -F "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 to display its details.

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.

• 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 do this:

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 do this:

1. Access the package's details.
2. Ensure the Installation > Instructions section is displayed.
3. Copy the relevant code snippet from the Registry Configuration section and paste it into either the package installer for Python (pip) configuration (pip.conf) file or end of the virtualenv requirements.txt file.
4. Run the installation command from the Package Installation section.

Registry Configuration

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://buildkite:{registry.read.token}@packages.buildkite.com/{org.slug}/{registry.slug}/pypi/simple"

where:

• {registry.read.token} is your API access token or registry token used to download packages from your Python registry. Ensure this access token has the Read Packages REST API scope, which allows this token to download packages from any registry your user account has access to within your Buildkite organization. This URL component, along with its surrounding buildkite: and @ components are not required for registries that are publicly accessible.

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

• {registry.slug} is the slug of your Python registry, which is the kebab-case version of your Python registry name, and can be obtained after accessing Packages in the global navigation > your Python registry from the Registries page.

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://buildkite:{registry.read.token}@packages.buildkite.com/{org.slug}/{registry.slug}/pypi/simple"

Package Installation

Use pip to install the package:

pip install package-name==version-number

where:

• package-name is the name of your package.

• version-numnber is the version number of this package.