Python compatibility

CodeArtifact supports the PyPI Simple Repository API at /simple/<project>/, used by pip, twine, uv, and other Python clients. Clients choose between HTML and JSON responses using the Accept request header.

Simple Repository API support

CodeArtifact implements version 1.1 of the PyPI Simple Repository API as defined by PEP 503, PEP 691, and PEP 700.

The following Accept header content types are supported on the /simple/<project>/ endpoint:

If a client specifies an Accept header that does not include any of the supported content types, CodeArtifact returns 406 Not Acceptable.

JSON responses include the PEP 700 fields versions, size, and upload-time along with the PEP 691 fields. HTML responses carry the same per-artifact upload time as a data-upload-time attribute on each artifact link.

The size and upload-time fields may be missing for package versions cached before per-asset metadata capture was enabled. When a client requests such a package through the JSON Simple Repository API, CodeArtifact re-fetches the metadata from the upstream registry and populates the missing fields. No customer action is required, and subsequent requests for the same package version return the complete metadata.

pip 23.0 and later and uv send the JSON Accept header by default, so most clients receive JSON without any extra configuration.

Example: request JSON for a project

The following example uses curl to fetch the JSON Simple Repository API response for the requests project. Get the repository URL from aws codeartifact get-repository-endpoint, and the authorization token from aws codeartifact get-authorization-token.

curl --header "Accept: application/vnd.pypi.simple.v1+json" \
     --header "Authorization: Bearer $CODEARTIFACT_AUTH_TOKEN" \
     "https://my_domain-111122223333.d.codeartifact.region.amazonaws.com/pypi/my_repo/simple/requests/"

The following example shows a typical JSON response (truncated for brevity). The versions, size, and upload-time fields are from PEP 700; the hashes, requires-python, and yanked fields are from PEP 691.

{
  "meta": { "api-version": "1.1" },
  "name": "requests",
  "versions": [ "2.31.0", "2.32.0", "2.32.3" ],
  "files": [
    {
      "filename": "requests-2.32.3-py3-none-any.whl",
      "url": "2.32.3/requests-2.32.3-py3-none-any.whl",
      "hashes": {
        "sha256": "70761cfe03c773ceb22aa2f671b4757976145175cdfca038c02654d061d6dcc6",
        "md5": "df6df19f49fc7ae54ee5ff2dd3d22d2c"
      },
      "requires-python": ">=3.8",
      "size": 64928,
      "upload-time": "2024-05-29T15:37:49.123456Z",
      "yanked": false
    }
  ]
}

Unsupported PyPI APIs

CodeArtifact does not support the following PyPI APIs:

For more information about the PyPI APIs, see the Legacy API reference on the Python Packaging Authority's GitHub website.

pip command support

The following sections summarize the pip commands that are supported, by CodeArtifact repositories, in addition to specific commands that are not supported.

Supported commands that interact with a repository

This section lists pip commands where the pip client makes one or more requests to the registry it's been configured with. These commands have been verified to function correctly when invoked against a CodeArtifact repository.

CodeArtifact does not implement pip search. If you have configured pip with a CodeArtifact repository, running pip search will search and show packages from PyPI.

Supported client-side commands

These commands don't require any direct interaction with a repository, so CodeArtifact does not need to do anything to support them.