pulp_python-client

Fetch, Upload, Organize, and Distribute Software Packages

This Python package is automatically generated by the OpenAPI Generator project:

API version: v3
Package version: 3.36.2
Generator version: 7.19.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://pulpproject.org

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import pulpcore.client.pulp_python

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import pulpcore.client.pulp_python

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:24817
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "http://localhost:24817"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_python.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with pulpcore.client.pulp_python.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_python.ContentPackagesApi(api_client)
    relative_path = 'relative_path_example' # str | Path where the artifact is located relative to distributions base_path
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    repository = 'repository_example' # str | A URI of a repository the new content unit should be associated with. (optional)
    overwrite = True # bool | When set to true, existing content in the repository with the same unique key will be silently overwritten. When set to false, the task will fail if content would be overwritten. Only used when 'repository' is specified. Defaults to true. (optional)
    pulp_labels = None # Dict[str, Optional[str]] | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. (optional)
    artifact = 'artifact_example' # str | Artifact file representing the physical content (optional)
    file = None # bytearray | An uploaded file that may be turned into the content unit. (optional)
    upload = 'upload_example' # str | An uncommitted upload that may be turned into the content unit. (optional)
    file_url = 'file_url_example' # str | A url that Pulp can download and turn into the content unit. (optional)
    downloader_config = pulpcore.client.pulp_python.RemoteNetworkConfig() # RemoteNetworkConfig | Configuration for the download process (e.g., proxies, auth, timeouts). Only applicable when providing a 'file_url. (optional)
    author = 'author_example' # str | Text containing the author's name. Contact information can also be added, separated with newlines. (optional)
    author_email = 'author_email_example' # str | The author's e-mail address.  (optional)
    description = 'description_example' # str | A longer description of the package that can run to several paragraphs. (optional)
    home_page = 'home_page_example' # str | The URL for the package's home page. (optional)
    keywords = 'keywords_example' # str | Additional keywords to be used to assist searching for the package in a larger catalog. (optional)
    license = 'license_example' # str | Text indicating the license covering the distribution (optional)
    platform = 'platform_example' # str | A comma-separated list of platform specifications, summarizing the operating systems supported by the package. (optional)
    summary = 'summary_example' # str | A one-line summary of what the package does. (optional)
    classifiers = None # object |  (optional)
    download_url = 'download_url_example' # str | Legacy field denoting the URL from which this package can be downloaded. (optional)
    supported_platform = 'supported_platform_example' # str | Field to specify the OS and CPU for which the binary package was compiled.  (optional)
    maintainer = 'maintainer_example' # str | The maintainer's name at a minimum; additional contact information may be provided. (optional)
    maintainer_email = 'maintainer_email_example' # str | The maintainer's e-mail address. (optional)
    obsoletes_dist = None # object |  (optional)
    project_url = 'project_url_example' # str | A browsable URL for the project and a label for it, separated by a comma. (optional)
    project_urls = None # object |  (optional)
    provides_dist = None # object |  (optional)
    requires_external = None # object |  (optional)
    requires_dist = None # object |  (optional)
    requires_python = 'requires_python_example' # str | The Python version(s) that the distribution is guaranteed to be compatible with. (optional)
    description_content_type = 'description_content_type_example' # str | A string stating the markup syntax (if any) used in the distribution's description, so that tools can intelligently render the description. (optional)
    provides_extras = None # object |  (optional)
    dynamic = None # object |  (optional)
    license_expression = 'license_expression_example' # str | Text string that is a valid SPDX license expression. (optional)
    license_file = None # object |  (optional)
    sha256 = '' # str | The SHA256 digest of this package. (optional) (default to '')
    metadata_sha256 = 'metadata_sha256_example' # str | The SHA256 digest of the package's METADATA file. (optional)
    attestations = None # object |  (optional)

    try:
        # Create a python package content
        api_response = api_instance.create(relative_path, x_task_diagnostics=x_task_diagnostics, repository=repository, overwrite=overwrite, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url, downloader_config=downloader_config, author=author, author_email=author_email, description=description, home_page=home_page, keywords=keywords, license=license, platform=platform, summary=summary, classifiers=classifiers, download_url=download_url, supported_platform=supported_platform, maintainer=maintainer, maintainer_email=maintainer_email, obsoletes_dist=obsoletes_dist, project_url=project_url, project_urls=project_urls, provides_dist=provides_dist, requires_external=requires_external, requires_dist=requires_dist, requires_python=requires_python, description_content_type=description_content_type, provides_extras=provides_extras, dynamic=dynamic, license_expression=license_expression, license_file=license_file, sha256=sha256, metadata_sha256=metadata_sha256, attestations=attestations)
        print("The response of ContentPackagesApi->create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentPackagesApi->create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:24817

Class	Method	HTTP request	Description
ContentPackagesApi	create	POST /pulp/api/v3/content/python/packages/	Create a python package content
ContentPackagesApi	list	GET /pulp/api/v3/content/python/packages/	List python package contents
ContentPackagesApi	read	GET {python_python_package_content_href}	Inspect a python package content
ContentPackagesApi	set_label	POST {python_python_package_content_href}set_label/	Set a label
ContentPackagesApi	unset_label	POST {python_python_package_content_href}unset_label/	Unset a label
ContentPackagesApi	upload	POST /pulp/api/v3/content/python/packages/upload/	Synchronous Python package upload
ContentProvenanceApi	create	POST /pulp/api/v3/content/python/provenance/	Create a package provenance
ContentProvenanceApi	list	GET /pulp/api/v3/content/python/provenance/	List package provenances
ContentProvenanceApi	read	GET {python_package_provenance_href}	Inspect a package provenance
ContentProvenanceApi	set_label	POST {python_package_provenance_href}set_label/	Set a label
ContentProvenanceApi	unset_label	POST {python_package_provenance_href}unset_label/	Unset a label
ContentYanksApi	list	GET /pulp/api/v3/content/python/yanks/	List package yanks
ContentYanksApi	read	GET {python_package_yank_href}	Inspect a package yank
ContentYanksApi	set_label	POST {python_package_yank_href}set_label/	Set a label
ContentYanksApi	unset_label	POST {python_package_yank_href}unset_label/	Unset a label
DistributionsPypiApi	add_role	POST {python_python_distribution_href}add_role/	Add a role
DistributionsPypiApi	create	POST /pulp/api/v3/distributions/python/pypi/	Create a python distribution
DistributionsPypiApi	delete	DELETE {python_python_distribution_href}	Delete a python distribution
DistributionsPypiApi	list	GET /pulp/api/v3/distributions/python/pypi/	List python distributions
DistributionsPypiApi	list_roles	GET {python_python_distribution_href}list_roles/	List roles
DistributionsPypiApi	my_permissions	GET {python_python_distribution_href}my_permissions/	List user permissions
DistributionsPypiApi	partial_update	PATCH {python_python_distribution_href}	Update a python distribution
DistributionsPypiApi	read	GET {python_python_distribution_href}	Inspect a python distribution
DistributionsPypiApi	remove_role	POST {python_python_distribution_href}remove_role/	Remove a role
DistributionsPypiApi	set_label	POST {python_python_distribution_href}set_label/	Set a label
DistributionsPypiApi	unset_label	POST {python_python_distribution_href}unset_label/	Unset a label
DistributionsPypiApi	update	PUT {python_python_distribution_href}	Update a python distribution
PublicationsPypiApi	add_role	POST {python_python_publication_href}add_role/	Add a role
PublicationsPypiApi	create	POST /pulp/api/v3/publications/python/pypi/	Create a python publication
PublicationsPypiApi	delete	DELETE {python_python_publication_href}	Delete a python publication
PublicationsPypiApi	list	GET /pulp/api/v3/publications/python/pypi/	List python publications
PublicationsPypiApi	list_roles	GET {python_python_publication_href}list_roles/	List roles
PublicationsPypiApi	my_permissions	GET {python_python_publication_href}my_permissions/	List user permissions
PublicationsPypiApi	read	GET {python_python_publication_href}	Inspect a python publication
PublicationsPypiApi	remove_role	POST {python_python_publication_href}remove_role/	Remove a role
PypiApi	read	GET /pypi/{path}/	Get index summary
PypiLegacyApi	create	POST /pypi/{path}/legacy/	Upload a package
PypiMetadataApi	read	GET /pypi/{path}/pypi/{meta}/	Get package metadata
PypiPackagesXmlApi	packages	GET /pypi/{path}/rss/packages.xml	Get newest packages RSS feed
PypiProjectReleasesXmlApi	project_releases	GET /pypi/{path}/rss/project/{package}/releases.xml	Get project releases RSS feed
PypiProvenanceApi	read	GET /pypi/{path}/integrity/{package}/{version}/{filename}/provenance/	Get package provenance
PypiSimpleApi	create	POST /pypi/{path}/simple/	Upload a package
PypiSimpleApi	pypi_simple_package_read	GET /pypi/{path}/simple/{package}/	Get package simple page
PypiSimpleApi	read	GET /pypi/{path}/simple/	Get index simple page
PypiUnyankApi	unyank	POST /pypi/{path}/unyank/	Unyank a package version
PypiUpdatesXmlApi	updates	GET /pypi/{path}/rss/updates.xml	Get latest updates RSS feed
PypiYankApi	yank	POST /pypi/{path}/yank/	Yank a package version
RemotesPythonApi	add_role	POST {python_python_remote_href}add_role/	Add a role
RemotesPythonApi	create	POST /pulp/api/v3/remotes/python/python/	Create a python remote
RemotesPythonApi	delete	DELETE {python_python_remote_href}	Delete a python remote
RemotesPythonApi	from_bandersnatch	POST /pulp/api/v3/remotes/python/python/from_bandersnatch/	Create from Bandersnatch
RemotesPythonApi	list	GET /pulp/api/v3/remotes/python/python/	List python remotes
RemotesPythonApi	list_roles	GET {python_python_remote_href}list_roles/	List roles
RemotesPythonApi	my_permissions	GET {python_python_remote_href}my_permissions/	List user permissions
RemotesPythonApi	partial_update	PATCH {python_python_remote_href}	Update a python remote
RemotesPythonApi	read	GET {python_python_remote_href}	Inspect a python remote
RemotesPythonApi	remove_role	POST {python_python_remote_href}remove_role/	Remove a role
RemotesPythonApi	set_label	POST {python_python_remote_href}set_label/	Set a label
RemotesPythonApi	unset_label	POST {python_python_remote_href}unset_label/	Unset a label
RemotesPythonApi	update	PUT {python_python_remote_href}	Update a python remote
RepositoriesPythonApi	add_role	POST {python_python_repository_href}add_role/	Add a role
RepositoriesPythonApi	create	POST /pulp/api/v3/repositories/python/python/	Create a python repository
RepositoriesPythonApi	delete	DELETE {python_python_repository_href}	Delete a python repository
RepositoriesPythonApi	list	GET /pulp/api/v3/repositories/python/python/	List python repositorys
RepositoriesPythonApi	list_roles	GET {python_python_repository_href}list_roles/	List roles
RepositoriesPythonApi	modify	POST {python_python_repository_href}modify/	Modify Repository Content
RepositoriesPythonApi	my_permissions	GET {python_python_repository_href}my_permissions/	List user permissions
RepositoriesPythonApi	partial_update	PATCH {python_python_repository_href}	Update a python repository
RepositoriesPythonApi	read	GET {python_python_repository_href}	Inspect a python repository
RepositoriesPythonApi	remove_role	POST {python_python_repository_href}remove_role/	Remove a role
RepositoriesPythonApi	repair_metadata	POST {python_python_repository_href}repair_metadata/	Repair metadata
RepositoriesPythonApi	set_label	POST {python_python_repository_href}set_label/	Set a label
RepositoriesPythonApi	sync	POST {python_python_repository_href}sync/	Sync from remote
RepositoriesPythonApi	unset_label	POST {python_python_repository_href}unset_label/	Unset a label
RepositoriesPythonApi	update	PUT {python_python_repository_href}	Update a python repository
RepositoriesPythonBlocklistEntriesApi	create	POST {python_python_repository_href}blocklist_entries/	Create a python blocklist entry
RepositoriesPythonBlocklistEntriesApi	delete	DELETE {python_python_python_blocklist_entry_href}	Delete a python blocklist entry
RepositoriesPythonBlocklistEntriesApi	list	GET {python_python_repository_href}blocklist_entries/	List python blocklist entrys
RepositoriesPythonBlocklistEntriesApi	read	GET {python_python_python_blocklist_entry_href}	Inspect a python blocklist entry
RepositoriesPythonVersionsApi	delete	DELETE {python_python_repository_version_href}	Delete a repository version
RepositoriesPythonVersionsApi	list	GET {python_python_repository_href}versions/	List repository versions
RepositoriesPythonVersionsApi	read	GET {python_python_repository_version_href}	Inspect a repository version
RepositoriesPythonVersionsApi	repair	POST {python_python_repository_version_href}repair/
RepositoriesPythonVersionsApi	scan	POST {python_python_repository_version_href}scan/	Generate vulnerability report

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

Type: HTTP basic authentication

cookieAuth

Type: API key
API key parameter name: sessionid
Location:

Author

pulp-list@redhat.com

Release files for pulp-python-client 3.36.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pulp-python-client 3.36.2
File	Size	Uploaded
pulp_python_client-3.36.2.tar.gz	114.5 kB	Sep 10, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for pulp-python-client 3.36.2
File	Interpreter	ABI	Platform	Reset
pulp_python_client-3.36.2-py3-none-any.whl 203.1 kB Sep 10, 2026	Python 3	none	any	Details

Total release size: 317.6 kB

Release files / pulp_python_client-3.36.2.tar.gz

Download URL	pulp_python_client-3.36.2.tar.gz
Size	114.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`a4fe7ed8d90deadf1f42ae0f81800794f57db52c43f65644cb95eca68dbbc2b5`
BLAKE2b-256 checksum How to use checksums	`bec2e1641164477aabe4f33a6de0cbab190c01f1eb02c3e7d2ff7ab07b3c8f53`
Upload date	Sep 10, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/pulp/pulp_python
Publishing commit: github.com/pulp/pulp_python/tree/a8e85ec4b966e8193d01a0d2c981c593276a086f

Workflow

Publishing configuration: github.com/pulp/pulp_python/blob/a8e85ec4b966e8193d01a0d2c981c593276a086f/.github/workflows/publish.yml
Publishing logs: github.com/pulp/pulp_python/actions/runs/34493341905/attempts/1

Artifact

Subject: pulp_python_client-3.36.2.tar.gz
SHA-256 checksum: a4fe7ed8d90deadf1f42ae0f81800794f57db52c43f65644cb95eca68dbbc2b5 Verifying attestations

Release files / pulp_python_client-3.36.2-py3-none-any.whl

Download URL	pulp_python_client-3.36.2-py3-none-any.whl
Size	203.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`5aa067165eb31d3f8f694fdb6ef4d1f6d454bbe3bb5f6bc8be26c2d0297a7783`
BLAKE2b-256 checksum How to use checksums	`abbabdf36544fc8c0168933fe1794fdadc3c46c0af6c9f26d7652eba080f84db`
Upload date	Sep 10, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/pulp/pulp_python
Publishing commit: github.com/pulp/pulp_python/tree/a8e85ec4b966e8193d01a0d2c981c593276a086f

Workflow

Publishing configuration: github.com/pulp/pulp_python/blob/a8e85ec4b966e8193d01a0d2c981c593276a086f/.github/workflows/publish.yml
Publishing logs: github.com/pulp/pulp_python/actions/runs/34493341905/attempts/1

Artifact

Subject: pulp_python_client-3.36.2-py3-none-any.whl
SHA-256 checksum: 5aa067165eb31d3f8f694fdb6ef4d1f6d454bbe3bb5f6bc8be26c2d0297a7783 Verifying attestations