crc-pulp-python-client 20251210.4

Pulp 3 API

pulpcore.client.pulp_python.ApiLegacyApi

All URIs are relative to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
create	POST /api/pypi/{pulp_domain}/{path}/legacy/	Upload a package

create

PackageUploadTaskResponse create(path, pulp_domain, content, sha256_digest, x_task_diagnostics=x_task_diagnostics, action=action)

Upload a package

Upload package to the index. This is the endpoint that tools like Twine and Poetry use for their upload commands.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.package_upload_task_response import PackageUploadTaskResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.ApiLegacyApi(api_client)
    path = 'path_example' # str | 
    pulp_domain = 'pulp_domain_example' # str | 
    content = None # bytearray | A Python package release file to upload to the index.
    sha256_digest = 'sha256_digest_example' # str | SHA256 of package to validate upload integrity.
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    action = 'file_upload' # str | Defaults to `file_upload`, don't change it or request will fail! (optional) (default to 'file_upload')

    try:
        # Upload a package
        api_response = api_instance.create(path, pulp_domain, content, sha256_digest, x_task_diagnostics=x_task_diagnostics, action=action)
        print("The response of ApiLegacyApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiLegacyApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
path	str
pulp_domain	str
content	bytearray	A Python package release file to upload to the index.
sha256_digest	str	SHA256 of package to validate upload integrity.
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
action	str	Defaults to `file_upload`, don't change it or request will fail!	[optional] [default to 'file_upload']

Return type

PackageUploadTaskResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: multipart/form-data, application/x-www-form-urlencoded
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_python.ApiPypiApi

All URIs are relative to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
read	GET /api/pypi/{pulp_domain}/{path}/	Get index summary

read

SummaryResponse read(path, pulp_domain, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Get index summary

Gets package summary stats of index.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.summary_response import SummaryResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.ApiPypiApi(api_client)
    path = 'path_example' # str | 
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Get index summary
        api_response = api_instance.read(path, pulp_domain, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ApiPypiApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiPypiApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
path	str
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

SummaryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_python.ApiSimpleApi

All URIs are relative to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
create	POST /api/pypi/{pulp_domain}/{path}/simple/	Upload a package
pypi_simple_package_read	GET /api/pypi/{pulp_domain}/{path}/simple/{package}/	Get package simple page
read	GET /api/pypi/{pulp_domain}/{path}/simple/	Get index simple page

create

PackageUploadTaskResponse create(path, pulp_domain, content, sha256_digest, x_task_diagnostics=x_task_diagnostics, action=action)

Upload a package

Upload package to the index. This endpoint has the same functionality as the upload endpoint at the /legacy url of the index. This is provided for convenience for users who want a single index url for all their Python tools. (pip, twine, poetry, pipenv, ...)

Example

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.package_upload_task_response import PackageUploadTaskResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)


# 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.ApiSimpleApi(api_client)
    path = 'path_example' # str | 
    pulp_domain = 'pulp_domain_example' # str | 
    content = None # bytearray | A Python package release file to upload to the index.
    sha256_digest = 'sha256_digest_example' # str | SHA256 of package to validate upload integrity.
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    action = 'file_upload' # str | Defaults to `file_upload`, don't change it or request will fail! (optional) (default to 'file_upload')

    try:
        # Upload a package
        api_response = api_instance.create(path, pulp_domain, content, sha256_digest, x_task_diagnostics=x_task_diagnostics, action=action)
        print("The response of ApiSimpleApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiSimpleApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
path	str
pulp_domain	str
content	bytearray	A Python package release file to upload to the index.
sha256_digest	str	SHA256 of package to validate upload integrity.
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
action	str	Defaults to `file_upload`, don't change it or request will fail!	[optional] [default to 'file_upload']

Return type

PackageUploadTaskResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: multipart/form-data, application/x-www-form-urlencoded
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pypi_simple_package_read

pypi_simple_package_read(package, path, pulp_domain, x_task_diagnostics=x_task_diagnostics, format=format, fields=fields, exclude_fields=exclude_fields)

Get package simple page

Retrieves the simple api html/json page for a package.

Example

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 https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)


# 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.ApiSimpleApi(api_client)
    package = 'package_example' # str | 
    path = 'path_example' # str | 
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    format = 'format_example' # str |  (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Get package simple page
        api_instance.pypi_simple_package_read(package, path, pulp_domain, x_task_diagnostics=x_task_diagnostics, format=format, fields=fields, exclude_fields=exclude_fields)
    except Exception as e:
        print("Exception when calling ApiSimpleApi->pypi_simple_package_read: %s\n" % e)

Parameters

Name	Type	Description	Notes
package	str
path	str
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
format	str		[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

read(path, pulp_domain, x_task_diagnostics=x_task_diagnostics, format=format, fields=fields, exclude_fields=exclude_fields)

Get index simple page

Gets the simple api html page for the index.

Example

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 https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)


# 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.ApiSimpleApi(api_client)
    path = 'path_example' # str | 
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    format = 'format_example' # str |  (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Get index simple page
        api_instance.read(path, pulp_domain, x_task_diagnostics=x_task_diagnostics, format=format, fields=fields, exclude_fields=exclude_fields)
    except Exception as e:
        print("Exception when calling ApiSimpleApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
path	str
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
format	str		[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AsyncOperationResponse

Serializer for asynchronous operations.

Properties

Name	Type	Description	Notes
task	str	The href of the task.

Example

from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse

# TODO update the JSON string below
json = "{}"
# create an instance of AsyncOperationResponse from a JSON string
async_operation_response_instance = AsyncOperationResponse.from_json(json)
# print the JSON string representation of the object
print(AsyncOperationResponse.to_json())

# convert the object into a dict
async_operation_response_dict = async_operation_response_instance.to_dict()
# create an instance of AsyncOperationResponse from a dict
async_operation_response_from_dict = AsyncOperationResponse.from_dict(async_operation_response_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_python.ContentPackagesApi

All URIs are relative to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
create	POST /api/pulp/{pulp_domain}/api/v3/content/python/packages/	Create a python package content
list	GET /api/pulp/{pulp_domain}/api/v3/content/python/packages/	List python package contents
read	GET {python_python_package_content_href}	Inspect a python package content
set_label	POST {python_python_package_content_href}set_label/	Set a label
unset_label	POST {python_python_package_content_href}unset_label/	Unset a label
upload	POST /api/pulp/{pulp_domain}/api/v3/content/python/packages/upload/	Synchronous Python package upload

create

AsyncOperationResponse create(pulp_domain, relative_path, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url, 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)

Create a python package content

Trigger an asynchronous task to create content,optionally create new repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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)
    pulp_domain = 'pulp_domain_example' # str | 
    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)
    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)
    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 | A JSON list containing classification values for a Python package. (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 | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. (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 | A dictionary of labels and URLs for the project. (optional)
    provides_dist = None # object | A JSON list containing names of a Distutils project which is contained within this distribution. (optional)
    requires_external = None # object | A JSON list containing some dependency in the system that the distribution is to be used. (optional)
    requires_dist = None # object | A JSON list containing names of some other distutils project required by this distribution. (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 | A JSON list containing names of optional features provided by the package. (optional)
    dynamic = None # object | A JSON list containing names of other core metadata fields which are permitted to vary between sdist and bdist packages. Fields NOT marked dynamic MUST be the same between bdist and sdist. (optional)
    license_expression = 'license_expression_example' # str | Text string that is a valid SPDX license expression. (optional)
    license_file = None # object | A JSON list containing names of the paths to license-related files. (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)

    try:
        # Create a python package content
        api_response = api_instance.create(pulp_domain, relative_path, x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url, 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)
        print("The response of ContentPackagesApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentPackagesApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
relative_path	str	Path where the artifact is located relative to distributions base_path
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
repository	str	A URI of a repository the new content unit should be associated with.	[optional]
pulp_labels	Dict[str, Optional[str]]	A dictionary of arbitrary key/value pairs used to describe a specific Content instance.	[optional]
artifact	str	Artifact file representing the physical content	[optional]
file	bytearray	An uploaded file that may be turned into the content unit.	[optional]
upload	str	An uncommitted upload that may be turned into the content unit.	[optional]
file_url	str	A url that Pulp can download and turn into the content unit.	[optional]
author	str	Text containing the author's name. Contact information can also be added, separated with newlines.	[optional]
author_email	str	The author's e-mail address.	[optional]
description	str	A longer description of the package that can run to several paragraphs.	[optional]
home_page	str	The URL for the package's home page.	[optional]
keywords	str	Additional keywords to be used to assist searching for the package in a larger catalog.	[optional]
license	str	Text indicating the license covering the distribution	[optional]
platform	str	A comma-separated list of platform specifications, summarizing the operating systems supported by the package.	[optional]
summary	str	A one-line summary of what the package does.	[optional]
classifiers	object	A JSON list containing classification values for a Python package.	[optional]
download_url	str	Legacy field denoting the URL from which this package can be downloaded.	[optional]
supported_platform	str	Field to specify the OS and CPU for which the binary package was compiled.	[optional]
maintainer	str	The maintainer's name at a minimum; additional contact information may be provided.	[optional]
maintainer_email	str	The maintainer's e-mail address.	[optional]
obsoletes_dist	object	A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.	[optional]
project_url	str	A browsable URL for the project and a label for it, separated by a comma.	[optional]
project_urls	object	A dictionary of labels and URLs for the project.	[optional]
provides_dist	object	A JSON list containing names of a Distutils project which is contained within this distribution.	[optional]
requires_external	object	A JSON list containing some dependency in the system that the distribution is to be used.	[optional]
requires_dist	object	A JSON list containing names of some other distutils project required by this distribution.	[optional]
requires_python	str	The Python version(s) that the distribution is guaranteed to be compatible with.	[optional]
description_content_type	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	object	A JSON list containing names of optional features provided by the package.	[optional]
dynamic	object	A JSON list containing names of other core metadata fields which are permitted to vary between sdist and bdist packages. Fields NOT marked dynamic MUST be the same between bdist and sdist.	[optional]
license_expression	str	Text string that is a valid SPDX license expression.	[optional]
license_file	object	A JSON list containing names of the paths to license-related files.	[optional]
sha256	str	The SHA256 digest of this package.	[optional] [default to '']
metadata_sha256	str	The SHA256 digest of the package's METADATA file.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: multipart/form-data, application/x-www-form-urlencoded
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedpythonPythonPackageContentResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, author=author, author__in=author__in, filename=filename, filename__contains=filename__contains, filename__in=filename__in, keywords__contains=keywords__contains, keywords__in=keywords__in, limit=limit, name=name, name__in=name__in, offset=offset, ordering=ordering, orphaned_for=orphaned_for, packagetype=packagetype, packagetype__in=packagetype__in, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, requires_python=requires_python, requires_python__contains=requires_python__contains, requires_python__in=requires_python__in, sha256=sha256, sha256__in=sha256__in, version=version, version__gt=version__gt, version__gte=version__gte, version__lt=version__lt, version__lte=version__lte, fields=fields, exclude_fields=exclude_fields)

List python package contents

PythonPackageContent represents each individually installable Python package. In the Python ecosystem, this is called a Python Distribution, sometimes (ambiguously) refered to as a package. In Pulp Python, we refer to it as PythonPackageContent. Each PythonPackageContent corresponds to a single filename, for example pulpcore-3.0.0rc1-py3-none-any.whl or pulpcore-3.0.0rc1.tar.gz.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.paginatedpython_python_package_content_response_list import PaginatedpythonPythonPackageContentResponseList
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    author = 'author_example' # str | Filter results where author matches value (optional)
    author__in = ['author__in_example'] # List[str] | Filter results where author is in a comma-separated list of values (optional)
    filename = 'filename_example' # str | Filter results where filename matches value (optional)
    filename__contains = 'filename__contains_example' # str | Filter results where filename contains value (optional)
    filename__in = ['filename__in_example'] # List[str] | Filter results where filename is in a comma-separated list of values (optional)
    keywords__contains = 'keywords__contains_example' # str | Filter results where keywords contains value (optional)
    keywords__in = ['keywords__in_example'] # List[str] | Filter results where keywords is in a comma-separated list of values (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `author` - Author * `-author` - Author (descending) * `author_email` - Author email * `-author_email` - Author email (descending) * `description` - Description * `-description` - Description (descending) * `home_page` - Home page * `-home_page` - Home page (descending) * `keywords` - Keywords * `-keywords` - Keywords (descending) * `license` - License * `-license` - License (descending) * `metadata_version` - Metadata version * `-metadata_version` - Metadata version (descending) * `name` - Name * `-name` - Name (descending) * `platform` - Platform * `-platform` - Platform (descending) * `summary` - Summary * `-summary` - Summary (descending) * `version` - Version * `-version` - Version (descending) * `classifiers` - Classifiers * `-classifiers` - Classifiers (descending) * `download_url` - Download url * `-download_url` - Download url (descending) * `supported_platform` - Supported platform * `-supported_platform` - Supported platform (descending) * `maintainer` - Maintainer * `-maintainer` - Maintainer (descending) * `maintainer_email` - Maintainer email * `-maintainer_email` - Maintainer email (descending) * `obsoletes_dist` - Obsoletes dist * `-obsoletes_dist` - Obsoletes dist (descending) * `project_url` - Project url * `-project_url` - Project url (descending) * `project_urls` - Project urls * `-project_urls` - Project urls (descending) * `provides_dist` - Provides dist * `-provides_dist` - Provides dist (descending) * `requires_external` - Requires external * `-requires_external` - Requires external (descending) * `requires_dist` - Requires dist * `-requires_dist` - Requires dist (descending) * `requires_python` - Requires python * `-requires_python` - Requires python (descending) * `description_content_type` - Description content type * `-description_content_type` - Description content type (descending) * `provides_extras` - Provides extras * `-provides_extras` - Provides extras (descending) * `dynamic` - Dynamic * `-dynamic` - Dynamic (descending) * `license_expression` - License expression * `-license_expression` - License expression (descending) * `license_file` - License file * `-license_file` - License file (descending) * `filename` - Filename * `-filename` - Filename (descending) * `packagetype` - Packagetype * `-packagetype` - Packagetype (descending) * `python_version` - Python version * `-python_version` - Python version (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `metadata_sha256` - Metadata sha256 * `-metadata_sha256` - Metadata sha256 (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    orphaned_for = 3.4 # float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. (optional)
    packagetype = 'packagetype_example' # str | Filter results where packagetype matches value  * `bdist_dmg` - bdist_dmg * `bdist_dumb` - bdist_dumb * `bdist_egg` - bdist_egg * `bdist_msi` - bdist_msi * `bdist_rpm` - bdist_rpm * `bdist_wheel` - bdist_wheel * `bdist_wininst` - bdist_wininst * `sdist` - sdist (optional)
    packagetype__in = ['packagetype__in_example'] # List[str] | Filter results where packagetype is in a comma-separated list of values (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_added = 'repository_version_added_example' # str | Repository Version referenced by HREF/PRN (optional)
    repository_version_removed = 'repository_version_removed_example' # str | Repository Version referenced by HREF/PRN (optional)
    requires_python = 'requires_python_example' # str | Filter results where requires_python matches value (optional)
    requires_python__contains = 'requires_python__contains_example' # str | Filter results where requires_python contains value (optional)
    requires_python__in = ['requires_python__in_example'] # List[str] | Filter results where requires_python is in a comma-separated list of values (optional)
    sha256 = 'sha256_example' # str | Filter results where sha256 matches value (optional)
    sha256__in = ['sha256__in_example'] # List[str] | Filter results where sha256 is in a comma-separated list of values (optional)
    version = 'version_example' # str | Filter results where version matches value (optional)
    version__gt = 'version__gt_example' # str | Filter results where version is greater than value (optional)
    version__gte = 'version__gte_example' # str | Filter results where version is greater than or equal to value (optional)
    version__lt = 'version__lt_example' # str | Filter results where version is less than value (optional)
    version__lte = 'version__lte_example' # str | Filter results where version is less than or equal to value (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List python package contents
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, author=author, author__in=author__in, filename=filename, filename__contains=filename__contains, filename__in=filename__in, keywords__contains=keywords__contains, keywords__in=keywords__in, limit=limit, name=name, name__in=name__in, offset=offset, ordering=ordering, orphaned_for=orphaned_for, packagetype=packagetype, packagetype__in=packagetype__in, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository_version=repository_version, repository_version_added=repository_version_added, repository_version_removed=repository_version_removed, requires_python=requires_python, requires_python__contains=requires_python__contains, requires_python__in=requires_python__in, sha256=sha256, sha256__in=sha256__in, version=version, version__gt=version__gt, version__gte=version__gte, version__lt=version__lt, version__lte=version__lte, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentPackagesApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentPackagesApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
author	str	Filter results where author matches value	[optional]
author__in	List[str]	Filter results where author is in a comma-separated list of values	[optional]
filename	str	Filter results where filename matches value	[optional]
filename__contains	str	Filter results where filename contains value	[optional]
filename__in	List[str]	Filter results where filename is in a comma-separated list of values	[optional]
keywords__contains	str	Filter results where keywords contains value	[optional]
keywords__in	List[str]	Filter results where keywords is in a comma-separated list of values	[optional]
limit	int	Number of results to return per page.	[optional]
name	str	Filter results where name matches value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `author` - Author * `-author` - Author (descending) * `author_email` - Author email * `-author_email` - Author email (descending) * `description` - Description * `-description` - Description (descending) * `home_page` - Home page * `-home_page` - Home page (descending) * `keywords` - Keywords * `-keywords` - Keywords (descending) * `license` - License * `-license` - License (descending) * `metadata_version` - Metadata version * `-metadata_version` - Metadata version (descending) * `name` - Name * `-name` - Name (descending) * `platform` - Platform * `-platform` - Platform (descending) * `summary` - Summary * `-summary` - Summary (descending) * `version` - Version * `-version` - Version (descending) * `classifiers` - Classifiers * `-classifiers` - Classifiers (descending) * `download_url` - Download url * `-download_url` - Download url (descending) * `supported_platform` - Supported platform * `-supported_platform` - Supported platform (descending) * `maintainer` - Maintainer * `-maintainer` - Maintainer (descending) * `maintainer_email` - Maintainer email * `-maintainer_email` - Maintainer email (descending) * `obsoletes_dist` - Obsoletes dist * `-obsoletes_dist` - Obsoletes dist (descending) * `project_url` - Project url * `-project_url` - Project url (descending) * `project_urls` - Project urls * `-project_urls` - Project urls (descending) * `provides_dist` - Provides dist * `-provides_dist` - Provides dist (descending) * `requires_external` - Requires external * `-requires_external` - Requires external (descending) * `requires_dist` - Requires dist * `-requires_dist` - Requires dist (descending) * `requires_python` - Requires python * `-requires_python` - Requires python (descending) * `description_content_type` - Description content type * `-description_content_type` - Description content type (descending) * `provides_extras` - Provides extras * `-provides_extras` - Provides extras (descending) * `dynamic` - Dynamic * `-dynamic` - Dynamic (descending) * `license_expression` - License expression * `-license_expression` - License expression (descending) * `license_file` - License file * `-license_file` - License file (descending) * `filename` - Filename * `-filename` - Filename (descending) * `packagetype` - Packagetype * `-packagetype` - Packagetype (descending) * `python_version` - Python version * `-python_version` - Python version (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `metadata_sha256` - Metadata sha256 * `-metadata_sha256` - Metadata sha256 (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
orphaned_for	float	Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.	[optional]
packagetype	str	Filter results where packagetype matches value * `bdist_dmg` - bdist_dmg * `bdist_dumb` - bdist_dumb * `bdist_egg` - bdist_egg * `bdist_msi` - bdist_msi * `bdist_rpm` - bdist_rpm * `bdist_wheel` - bdist_wheel * `bdist_wininst` - bdist_wininst * `sdist` - sdist	[optional]
packagetype__in	List[str]	Filter results where packagetype is in a comma-separated list of values	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_label_select	str	Filter labels by search string	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
repository_version	str	Repository Version referenced by HREF/PRN	[optional]
repository_version_added	str	Repository Version referenced by HREF/PRN	[optional]
repository_version_removed	str	Repository Version referenced by HREF/PRN	[optional]
requires_python	str	Filter results where requires_python matches value	[optional]
requires_python__contains	str	Filter results where requires_python contains value	[optional]
requires_python__in	List[str]	Filter results where requires_python is in a comma-separated list of values	[optional]
sha256	str	Filter results where sha256 matches value	[optional]
sha256__in	List[str]	Filter results where sha256 is in a comma-separated list of values	[optional]
version	str	Filter results where version matches value	[optional]
version__gt	str	Filter results where version is greater than value	[optional]
version__gte	str	Filter results where version is greater than or equal to value	[optional]
version__lt	str	Filter results where version is less than value	[optional]
version__lte	str	Filter results where version is less than or equal to value	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedpythonPythonPackageContentResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

PythonPythonPackageContentResponse read(python_python_package_content_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a python package content

PythonPackageContent represents each individually installable Python package. In the Python ecosystem, this is called a Python Distribution, sometimes (ambiguously) refered to as a package. In Pulp Python, we refer to it as PythonPackageContent. Each PythonPackageContent corresponds to a single filename, for example pulpcore-3.0.0rc1-py3-none-any.whl or pulpcore-3.0.0rc1.tar.gz.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_package_content_response import PythonPythonPackageContentResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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)
    python_python_package_content_href = 'python_python_package_content_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a python package content
        api_response = api_instance.read(python_python_package_content_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of ContentPackagesApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentPackagesApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_package_content_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PythonPythonPackageContentResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(python_python_package_content_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.set_label import SetLabel
from pulpcore.client.pulp_python.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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)
    python_python_package_content_href = 'python_python_package_content_href_example' # str | 
    set_label = pulpcore.client.pulp_python.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(python_python_package_content_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentPackagesApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentPackagesApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_package_content_href	str
set_label	SetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(python_python_package_content_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.unset_label import UnsetLabel
from pulpcore.client.pulp_python.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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)
    python_python_package_content_href = 'python_python_package_content_href_example' # str | 
    unset_label = pulpcore.client.pulp_python.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(python_python_package_content_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of ContentPackagesApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentPackagesApi->unset_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_package_content_href	str
unset_label	UnsetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload

PythonPythonPackageContentResponse upload(pulp_domain, x_task_diagnostics=x_task_diagnostics, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url, 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)

Synchronous Python package upload

Create a Python package.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_package_content_response import PythonPythonPackageContentResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (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)
    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 | A JSON list containing classification values for a Python package. (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 | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. (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 | A dictionary of labels and URLs for the project. (optional)
    provides_dist = None # object | A JSON list containing names of a Distutils project which is contained within this distribution. (optional)
    requires_external = None # object | A JSON list containing some dependency in the system that the distribution is to be used. (optional)
    requires_dist = None # object | A JSON list containing names of some other distutils project required by this distribution. (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 | A JSON list containing names of optional features provided by the package. (optional)
    dynamic = None # object | A JSON list containing names of other core metadata fields which are permitted to vary between sdist and bdist packages. Fields NOT marked dynamic MUST be the same between bdist and sdist. (optional)
    license_expression = 'license_expression_example' # str | Text string that is a valid SPDX license expression. (optional)
    license_file = None # object | A JSON list containing names of the paths to license-related files. (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)

    try:
        # Synchronous Python package upload
        api_response = api_instance.upload(pulp_domain, x_task_diagnostics=x_task_diagnostics, pulp_labels=pulp_labels, artifact=artifact, file=file, upload=upload, file_url=file_url, 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)
        print("The response of ContentPackagesApi->upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentPackagesApi->upload: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
pulp_labels	Dict[str, Optional[str]]	A dictionary of arbitrary key/value pairs used to describe a specific Content instance.	[optional]
artifact	str	Artifact file representing the physical content	[optional]
file	bytearray	An uploaded file that may be turned into the content unit.	[optional]
upload	str	An uncommitted upload that may be turned into the content unit.	[optional]
file_url	str	A url that Pulp can download and turn into the content unit.	[optional]
author	str	Text containing the author's name. Contact information can also be added, separated with newlines.	[optional]
author_email	str	The author's e-mail address.	[optional]
description	str	A longer description of the package that can run to several paragraphs.	[optional]
home_page	str	The URL for the package's home page.	[optional]
keywords	str	Additional keywords to be used to assist searching for the package in a larger catalog.	[optional]
license	str	Text indicating the license covering the distribution	[optional]
platform	str	A comma-separated list of platform specifications, summarizing the operating systems supported by the package.	[optional]
summary	str	A one-line summary of what the package does.	[optional]
classifiers	object	A JSON list containing classification values for a Python package.	[optional]
download_url	str	Legacy field denoting the URL from which this package can be downloaded.	[optional]
supported_platform	str	Field to specify the OS and CPU for which the binary package was compiled.	[optional]
maintainer	str	The maintainer's name at a minimum; additional contact information may be provided.	[optional]
maintainer_email	str	The maintainer's e-mail address.	[optional]
obsoletes_dist	object	A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.	[optional]
project_url	str	A browsable URL for the project and a label for it, separated by a comma.	[optional]
project_urls	object	A dictionary of labels and URLs for the project.	[optional]
provides_dist	object	A JSON list containing names of a Distutils project which is contained within this distribution.	[optional]
requires_external	object	A JSON list containing some dependency in the system that the distribution is to be used.	[optional]
requires_dist	object	A JSON list containing names of some other distutils project required by this distribution.	[optional]
requires_python	str	The Python version(s) that the distribution is guaranteed to be compatible with.	[optional]
description_content_type	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	object	A JSON list containing names of optional features provided by the package.	[optional]
dynamic	object	A JSON list containing names of other core metadata fields which are permitted to vary between sdist and bdist packages. Fields NOT marked dynamic MUST be the same between bdist and sdist.	[optional]
license_expression	str	Text string that is a valid SPDX license expression.	[optional]
license_file	object	A JSON list containing names of the paths to license-related files.	[optional]
sha256	str	The SHA256 digest of this package.	[optional] [default to '']
metadata_sha256	str	The SHA256 digest of the package's METADATA file.	[optional]

Return type

PythonPythonPackageContentResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: multipart/form-data, application/x-www-form-urlencoded
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ContentSummaryResponse

Serializer for the RepositoryVersion content summary

Properties

Name	Type	Description	Notes
added	Dict[str, object]
removed	Dict[str, object]
present	Dict[str, object]

Example

from pulpcore.client.pulp_python.models.content_summary_response import ContentSummaryResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ContentSummaryResponse from a JSON string
content_summary_response_instance = ContentSummaryResponse.from_json(json)
# print the JSON string representation of the object
print(ContentSummaryResponse.to_json())

# convert the object into a dict
content_summary_response_dict = content_summary_response_instance.to_dict()
# create an instance of ContentSummaryResponse from a dict
content_summary_response_from_dict = ContentSummaryResponse.from_dict(content_summary_response_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_python.DistributionsPypiApi

All URIs are relative to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
add_role	POST {python_python_distribution_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/distributions/python/pypi/	Create a python distribution
delete	DELETE {python_python_distribution_href}	Delete a python distribution
list	GET /api/pulp/{pulp_domain}/api/v3/distributions/python/pypi/	List python distributions
list_roles	GET {python_python_distribution_href}list_roles/	List roles
my_permissions	GET {python_python_distribution_href}my_permissions/	List user permissions
partial_update	PATCH {python_python_distribution_href}	Update a python distribution
read	GET {python_python_distribution_href}	Inspect a python distribution
remove_role	POST {python_python_distribution_href}remove_role/	Remove a role
set_label	POST {python_python_distribution_href}set_label/	Set a label
unset_label	POST {python_python_distribution_href}unset_label/	Unset a label
update	PUT {python_python_distribution_href}	Update a python distribution

add_role

NestedRoleResponse add_role(python_python_distribution_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.nested_role import NestedRole
from pulpcore.client.pulp_python.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    python_python_distribution_href = 'python_python_distribution_href_example' # str | 
    nested_role = pulpcore.client.pulp_python.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(python_python_distribution_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsPypiApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->add_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_distribution_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

AsyncOperationResponse create(pulp_domain, python_python_distribution, x_task_diagnostics=x_task_diagnostics)

Create a python distribution

Trigger an asynchronous create task

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.models.python_python_distribution import PythonPythonDistribution
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    python_python_distribution = pulpcore.client.pulp_python.PythonPythonDistribution() # PythonPythonDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a python distribution
        api_response = api_instance.create(pulp_domain, python_python_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsPypiApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
python_python_distribution	PythonPythonDistribution
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

AsyncOperationResponse delete(python_python_distribution_href, x_task_diagnostics=x_task_diagnostics)

Delete a python distribution

Trigger an asynchronous delete task

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    python_python_distribution_href = 'python_python_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a python distribution
        api_response = api_instance.delete(python_python_distribution_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsPypiApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_distribution_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedpythonPythonDistributionResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)

List python distributions

Pulp Python Distributions are used to distribute Python content from Python Repositories or Python Publications. Pulp Python Distributions should not be confused with "Python Distribution" as defined by the Python community. In Pulp usage, Python content is referred to as Python Package Content.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.paginatedpython_python_distribution_response_list import PaginatedpythonPythonDistributionResponseList
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    base_path = 'base_path_example' # str | Filter results where base_path matches value (optional)
    base_path__contains = 'base_path__contains_example' # str | Filter results where base_path contains value (optional)
    base_path__icontains = 'base_path__icontains_example' # str | Filter results where base_path contains value (optional)
    base_path__in = ['base_path__in_example'] # List[str] | Filter results where base_path is in a comma-separated list of values (optional)
    checkpoint = True # bool | Filter results where checkpoint matches value (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository = 'repository_example' # str | Filter results where repository matches value (optional)
    repository__in = ['repository__in_example'] # List[str] | Filter results where repository is in a comma-separated list of values (optional)
    with_content = 'with_content_example' # str | Filter distributions based on the content served by them (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List python distributions
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, base_path=base_path, base_path__contains=base_path__contains, base_path__icontains=base_path__icontains, base_path__in=base_path__in, checkpoint=checkpoint, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, repository=repository, repository__in=repository__in, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsPypiApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
base_path	str	Filter results where base_path matches value	[optional]
base_path__contains	str	Filter results where base_path contains value	[optional]
base_path__icontains	str	Filter results where base_path contains value	[optional]
base_path__in	List[str]	Filter results where base_path is in a comma-separated list of values	[optional]
checkpoint	bool	Filter results where checkpoint matches value	[optional]
limit	int	Number of results to return per page.	[optional]
name	str	Filter results where name matches value	[optional]
name__contains	str	Filter results where name contains value	[optional]
name__icontains	str	Filter results where name contains value	[optional]
name__iexact	str	Filter results where name matches value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
name__iregex	str	Filter results where name matches regex value	[optional]
name__istartswith	str	Filter results where name starts with value	[optional]
name__regex	str	Filter results where name matches regex value	[optional]
name__startswith	str	Filter results where name starts with value	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_label_select	str	Filter labels by search string	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
repository	str	Filter results where repository matches value	[optional]
repository__in	List[str]	Filter results where repository is in a comma-separated list of values	[optional]
with_content	str	Filter distributions based on the content served by them	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedpythonPythonDistributionResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_roles

ObjectRolesResponse list_roles(python_python_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    python_python_distribution_href = 'python_python_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(python_python_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsPypiApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_distribution_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ObjectRolesResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

my_permissions

MyPermissionsResponse my_permissions(python_python_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    python_python_distribution_href = 'python_python_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(python_python_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsPypiApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_distribution_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

MyPermissionsResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

PythonPythonDistributionResponse partial_update(python_python_distribution_href, patchedpython_python_distribution, x_task_diagnostics=x_task_diagnostics)

Update a python distribution

Update the entity partially and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.patchedpython_python_distribution import PatchedpythonPythonDistribution
from pulpcore.client.pulp_python.models.python_python_distribution_response import PythonPythonDistributionResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    python_python_distribution_href = 'python_python_distribution_href_example' # str | 
    patchedpython_python_distribution = pulpcore.client.pulp_python.PatchedpythonPythonDistribution() # PatchedpythonPythonDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a python distribution
        api_response = api_instance.partial_update(python_python_distribution_href, patchedpython_python_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsPypiApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_distribution_href	str
patchedpython_python_distribution	PatchedpythonPythonDistribution
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

PythonPythonDistributionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

PythonPythonDistributionResponse read(python_python_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a python distribution

Pulp Python Distributions are used to distribute Python content from Python Repositories or Python Publications. Pulp Python Distributions should not be confused with "Python Distribution" as defined by the Python community. In Pulp usage, Python content is referred to as Python Package Content.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_distribution_response import PythonPythonDistributionResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    python_python_distribution_href = 'python_python_distribution_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a python distribution
        api_response = api_instance.read(python_python_distribution_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of DistributionsPypiApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_distribution_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PythonPythonDistributionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_role

NestedRoleResponse remove_role(python_python_distribution_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.nested_role import NestedRole
from pulpcore.client.pulp_python.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    python_python_distribution_href = 'python_python_distribution_href_example' # str | 
    nested_role = pulpcore.client.pulp_python.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(python_python_distribution_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsPypiApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_distribution_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(python_python_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.set_label import SetLabel
from pulpcore.client.pulp_python.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    python_python_distribution_href = 'python_python_distribution_href_example' # str | 
    set_label = pulpcore.client.pulp_python.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(python_python_distribution_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsPypiApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_distribution_href	str
set_label	SetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(python_python_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.unset_label import UnsetLabel
from pulpcore.client.pulp_python.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    python_python_distribution_href = 'python_python_distribution_href_example' # str | 
    unset_label = pulpcore.client.pulp_python.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(python_python_distribution_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsPypiApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->unset_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_distribution_href	str
unset_label	UnsetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

PythonPythonDistributionResponse update(python_python_distribution_href, python_python_distribution, x_task_diagnostics=x_task_diagnostics)

Update a python distribution

Update the entity and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_distribution import PythonPythonDistribution
from pulpcore.client.pulp_python.models.python_python_distribution_response import PythonPythonDistributionResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.DistributionsPypiApi(api_client)
    python_python_distribution_href = 'python_python_distribution_href_example' # str | 
    python_python_distribution = pulpcore.client.pulp_python.PythonPythonDistribution() # PythonPythonDistribution | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a python distribution
        api_response = api_instance.update(python_python_distribution_href, python_python_distribution, x_task_diagnostics=x_task_diagnostics)
        print("The response of DistributionsPypiApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DistributionsPypiApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_distribution_href	str
python_python_distribution	PythonPythonDistribution
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

PythonPythonDistributionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ExcludePlatformsEnum

• windows - windows * macos - macos * freebsd - freebsd * linux - linux

Enum

• WINDOWS (value: 'windows')

• MACOS (value: 'macos')

• FREEBSD (value: 'freebsd')

• LINUX (value: 'linux')

[Back to Model list] [Back to API list] [Back to README]

MyPermissionsResponse

Properties

Name	Type	Description	Notes
permissions	List[str]

Example

from pulpcore.client.pulp_python.models.my_permissions_response import MyPermissionsResponse

# TODO update the JSON string below
json = "{}"
# create an instance of MyPermissionsResponse from a JSON string
my_permissions_response_instance = MyPermissionsResponse.from_json(json)
# print the JSON string representation of the object
print(MyPermissionsResponse.to_json())

# convert the object into a dict
my_permissions_response_dict = my_permissions_response_instance.to_dict()
# create an instance of MyPermissionsResponse from a dict
my_permissions_response_from_dict = MyPermissionsResponse.from_dict(my_permissions_response_dict)

[Back to Model list] [Back to API list] [Back to README]

NestedRole

Serializer to add/remove object roles to/from users/groups. This is used in conjunction with pulpcore.app.viewsets.base.RolesMixin and requires the underlying object to be passed as content_object in the context.

Properties

Name	Type	Description	Notes
users	List[str]		[optional] [default to []]
groups	List[str]		[optional] [default to []]
role	str

Example

from pulpcore.client.pulp_python.models.nested_role import NestedRole

# TODO update the JSON string below
json = "{}"
# create an instance of NestedRole from a JSON string
nested_role_instance = NestedRole.from_json(json)
# print the JSON string representation of the object
print(NestedRole.to_json())

# convert the object into a dict
nested_role_dict = nested_role_instance.to_dict()
# create an instance of NestedRole from a dict
nested_role_from_dict = NestedRole.from_dict(nested_role_dict)

[Back to Model list] [Back to API list] [Back to README]

NestedRoleResponse

Serializer to add/remove object roles to/from users/groups. This is used in conjunction with pulpcore.app.viewsets.base.RolesMixin and requires the underlying object to be passed as content_object in the context.

Properties

Name	Type	Description	Notes
users	List[str]		[optional] [default to []]
groups	List[str]		[optional] [default to []]
role	str

Example

from pulpcore.client.pulp_python.models.nested_role_response import NestedRoleResponse

# TODO update the JSON string below
json = "{}"
# create an instance of NestedRoleResponse from a JSON string
nested_role_response_instance = NestedRoleResponse.from_json(json)
# print the JSON string representation of the object
print(NestedRoleResponse.to_json())

# convert the object into a dict
nested_role_response_dict = nested_role_response_instance.to_dict()
# create an instance of NestedRoleResponse from a dict
nested_role_response_from_dict = NestedRoleResponse.from_dict(nested_role_response_dict)

[Back to Model list] [Back to API list] [Back to README]

ObjectRolesResponse

Properties

Name	Type	Description	Notes
roles	List[NestedRoleResponse]

Example

from pulpcore.client.pulp_python.models.object_roles_response import ObjectRolesResponse

# TODO update the JSON string below
json = "{}"
# create an instance of ObjectRolesResponse from a JSON string
object_roles_response_instance = ObjectRolesResponse.from_json(json)
# print the JSON string representation of the object
print(ObjectRolesResponse.to_json())

# convert the object into a dict
object_roles_response_dict = object_roles_response_instance.to_dict()
# create an instance of ObjectRolesResponse from a dict
object_roles_response_from_dict = ObjectRolesResponse.from_dict(object_roles_response_dict)

[Back to Model list] [Back to API list] [Back to README]

PackageMetadataResponse

A Serializer for a package's metadata.

Properties

Name	Type	Description	Notes
last_serial	int	Cache value from last PyPI sync
info	object	Core metadata of the package
releases	object	List of all the releases of the package
urls	object

Example

from pulpcore.client.pulp_python.models.package_metadata_response import PackageMetadataResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PackageMetadataResponse from a JSON string
package_metadata_response_instance = PackageMetadataResponse.from_json(json)
# print the JSON string representation of the object
print(PackageMetadataResponse.to_json())

# convert the object into a dict
package_metadata_response_dict = package_metadata_response_instance.to_dict()
# create an instance of PackageMetadataResponse from a dict
package_metadata_response_from_dict = PackageMetadataResponse.from_dict(package_metadata_response_dict)

[Back to Model list] [Back to API list] [Back to README]

PackageTypesEnum

• bdist_dmg - bdist_dmg * bdist_dumb - bdist_dumb * bdist_egg - bdist_egg * bdist_msi - bdist_msi * bdist_rpm - bdist_rpm * bdist_wheel - bdist_wheel * bdist_wininst - bdist_wininst * sdist - sdist

Enum

• BDIST_DMG (value: 'bdist_dmg')

• BDIST_DUMB (value: 'bdist_dumb')

• BDIST_EGG (value: 'bdist_egg')

• BDIST_MSI (value: 'bdist_msi')

• BDIST_RPM (value: 'bdist_rpm')

• BDIST_WHEEL (value: 'bdist_wheel')

• BDIST_WININST (value: 'bdist_wininst')

• SDIST (value: 'sdist')

[Back to Model list] [Back to API list] [Back to README]

PackageUploadTaskResponse

A Serializer for responding to a package upload task.

Properties

Name	Type	Description	Notes
session	str
task	str
task_start_time	datetime

Example

from pulpcore.client.pulp_python.models.package_upload_task_response import PackageUploadTaskResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PackageUploadTaskResponse from a JSON string
package_upload_task_response_instance = PackageUploadTaskResponse.from_json(json)
# print the JSON string representation of the object
print(PackageUploadTaskResponse.to_json())

# convert the object into a dict
package_upload_task_response_dict = package_upload_task_response_instance.to_dict()
# create an instance of PackageUploadTaskResponse from a dict
package_upload_task_response_from_dict = PackageUploadTaskResponse.from_dict(package_upload_task_response_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedpythonPythonDistributionResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[PythonPythonDistributionResponse]

Example

from pulpcore.client.pulp_python.models.paginatedpython_python_distribution_response_list import PaginatedpythonPythonDistributionResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedpythonPythonDistributionResponseList from a JSON string
paginatedpython_python_distribution_response_list_instance = PaginatedpythonPythonDistributionResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedpythonPythonDistributionResponseList.to_json())

# convert the object into a dict
paginatedpython_python_distribution_response_list_dict = paginatedpython_python_distribution_response_list_instance.to_dict()
# create an instance of PaginatedpythonPythonDistributionResponseList from a dict
paginatedpython_python_distribution_response_list_from_dict = PaginatedpythonPythonDistributionResponseList.from_dict(paginatedpython_python_distribution_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedpythonPythonPackageContentResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[PythonPythonPackageContentResponse]

Example

from pulpcore.client.pulp_python.models.paginatedpython_python_package_content_response_list import PaginatedpythonPythonPackageContentResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedpythonPythonPackageContentResponseList from a JSON string
paginatedpython_python_package_content_response_list_instance = PaginatedpythonPythonPackageContentResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedpythonPythonPackageContentResponseList.to_json())

# convert the object into a dict
paginatedpython_python_package_content_response_list_dict = paginatedpython_python_package_content_response_list_instance.to_dict()
# create an instance of PaginatedpythonPythonPackageContentResponseList from a dict
paginatedpython_python_package_content_response_list_from_dict = PaginatedpythonPythonPackageContentResponseList.from_dict(paginatedpython_python_package_content_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedpythonPythonPublicationResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[PythonPythonPublicationResponse]

Example

from pulpcore.client.pulp_python.models.paginatedpython_python_publication_response_list import PaginatedpythonPythonPublicationResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedpythonPythonPublicationResponseList from a JSON string
paginatedpython_python_publication_response_list_instance = PaginatedpythonPythonPublicationResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedpythonPythonPublicationResponseList.to_json())

# convert the object into a dict
paginatedpython_python_publication_response_list_dict = paginatedpython_python_publication_response_list_instance.to_dict()
# create an instance of PaginatedpythonPythonPublicationResponseList from a dict
paginatedpython_python_publication_response_list_from_dict = PaginatedpythonPythonPublicationResponseList.from_dict(paginatedpython_python_publication_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedpythonPythonRemoteResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[PythonPythonRemoteResponse]

Example

from pulpcore.client.pulp_python.models.paginatedpython_python_remote_response_list import PaginatedpythonPythonRemoteResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedpythonPythonRemoteResponseList from a JSON string
paginatedpython_python_remote_response_list_instance = PaginatedpythonPythonRemoteResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedpythonPythonRemoteResponseList.to_json())

# convert the object into a dict
paginatedpython_python_remote_response_list_dict = paginatedpython_python_remote_response_list_instance.to_dict()
# create an instance of PaginatedpythonPythonRemoteResponseList from a dict
paginatedpython_python_remote_response_list_from_dict = PaginatedpythonPythonRemoteResponseList.from_dict(paginatedpython_python_remote_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedpythonPythonRepositoryResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[PythonPythonRepositoryResponse]

Example

from pulpcore.client.pulp_python.models.paginatedpython_python_repository_response_list import PaginatedpythonPythonRepositoryResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedpythonPythonRepositoryResponseList from a JSON string
paginatedpython_python_repository_response_list_instance = PaginatedpythonPythonRepositoryResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedpythonPythonRepositoryResponseList.to_json())

# convert the object into a dict
paginatedpython_python_repository_response_list_dict = paginatedpython_python_repository_response_list_instance.to_dict()
# create an instance of PaginatedpythonPythonRepositoryResponseList from a dict
paginatedpython_python_repository_response_list_from_dict = PaginatedpythonPythonRepositoryResponseList.from_dict(paginatedpython_python_repository_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PaginatedRepositoryVersionResponseList

Properties

Name	Type	Description	Notes
count	int
next	str		[optional]
previous	str		[optional]
results	List[RepositoryVersionResponse]

Example

from pulpcore.client.pulp_python.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList

# TODO update the JSON string below
json = "{}"
# create an instance of PaginatedRepositoryVersionResponseList from a JSON string
paginated_repository_version_response_list_instance = PaginatedRepositoryVersionResponseList.from_json(json)
# print the JSON string representation of the object
print(PaginatedRepositoryVersionResponseList.to_json())

# convert the object into a dict
paginated_repository_version_response_list_dict = paginated_repository_version_response_list_instance.to_dict()
# create an instance of PaginatedRepositoryVersionResponseList from a dict
paginated_repository_version_response_list_from_dict = PaginatedRepositoryVersionResponseList.from_dict(paginated_repository_version_response_list_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedpythonPythonDistribution

Serializer for Pulp distributions for the Python type.

Properties

Name	Type	Description	Notes
base_path	str	The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. "foo" and "foo/bar")	[optional]
content_guard	str	An optional content-guard.	[optional]
hidden	bool	Whether this distribution should be shown in the content app.	[optional] [default to False]
pulp_labels	Dict[str, Optional[str]]		[optional]
name	str	A unique name. Ex, `rawhide` and `stable`.	[optional]
repository	str	The latest RepositoryVersion for this Repository will be served.	[optional]
publication	str	Publication to be served	[optional]
repository_version	str	RepositoryVersion to be served.	[optional]
allow_uploads	bool	Allow packages to be uploaded to this index.	[optional] [default to True]
remote	str	Remote that can be used to fetch content when using pull-through caching.	[optional]

Example

from pulpcore.client.pulp_python.models.patchedpython_python_distribution import PatchedpythonPythonDistribution

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedpythonPythonDistribution from a JSON string
patchedpython_python_distribution_instance = PatchedpythonPythonDistribution.from_json(json)
# print the JSON string representation of the object
print(PatchedpythonPythonDistribution.to_json())

# convert the object into a dict
patchedpython_python_distribution_dict = patchedpython_python_distribution_instance.to_dict()
# create an instance of PatchedpythonPythonDistribution from a dict
patchedpython_python_distribution_from_dict = PatchedpythonPythonDistribution.from_dict(patchedpython_python_distribution_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedpythonPythonRemote

A Serializer for PythonRemote.

Properties

Name	Type	Description	Notes
name	str	A unique name for this remote.	[optional]
url	str	The URL of an external content source.	[optional]
ca_cert	str	A PEM encoded CA certificate used to validate the server certificate presented by the remote server.	[optional]
client_cert	str	A PEM encoded client certificate used for authentication.	[optional]
client_key	str	A PEM encoded private key used for authentication.	[optional]
tls_validation	bool	If True, TLS peer validation must be performed.	[optional]
proxy_url	str	The proxy URL. Format: scheme://host:port	[optional]
proxy_username	str	The username to authenticte to the proxy.	[optional]
proxy_password	str	The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed.	[optional]
username	str	The username to be used for authentication when syncing.	[optional]
password	str	The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[optional]
policy	PolicyEnum	The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.	[optional]
total_timeout	float	aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
connect_timeout	float	aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_connect_timeout	float	aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_read_timeout	float	aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
headers	List[object]	Headers for aiohttp.Clientsession	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]
includes	List[str]	A list containing project specifiers for Python packages to include.	[optional]
excludes	List[str]	A list containing project specifiers for Python packages to exclude.	[optional]
prereleases	bool	Whether or not to include pre-release packages in the sync.	[optional]
package_types	List[PackageTypesEnum]	The package types to sync for Python content. Leave blank to get everypackage type.	[optional]
keep_latest_packages	int	The amount of latest versions of a package to keep on sync, includespre-releases if synced. Default 0 keeps all versions.	[optional] [default to 0]
exclude_platforms	List[ExcludePlatformsEnum]	List of platforms to exclude syncing Python packages for. Possible valuesinclude: windows, macos, freebsd, and linux.	[optional]

Example

from pulpcore.client.pulp_python.models.patchedpython_python_remote import PatchedpythonPythonRemote

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedpythonPythonRemote from a JSON string
patchedpython_python_remote_instance = PatchedpythonPythonRemote.from_json(json)
# print the JSON string representation of the object
print(PatchedpythonPythonRemote.to_json())

# convert the object into a dict
patchedpython_python_remote_dict = patchedpython_python_remote_instance.to_dict()
# create an instance of PatchedpythonPythonRemote from a dict
patchedpython_python_remote_from_dict = PatchedpythonPythonRemote.from_dict(patchedpython_python_remote_dict)

[Back to Model list] [Back to API list] [Back to README]

PatchedpythonPythonRepository

Serializer for Python Repositories.

Properties

Name	Type	Description	Notes
pulp_labels	Dict[str, Optional[str]]		[optional]
name	str	A unique name for this repository.	[optional]
description	str	An optional description.	[optional]
retain_repo_versions	int	Retain X versions of the repository. Default is null which retains all versions.	[optional]
remote	str	An optional remote to use by default when syncing.	[optional]
autopublish	bool	Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository.	[optional] [default to False]

Example

from pulpcore.client.pulp_python.models.patchedpython_python_repository import PatchedpythonPythonRepository

# TODO update the JSON string below
json = "{}"
# create an instance of PatchedpythonPythonRepository from a JSON string
patchedpython_python_repository_instance = PatchedpythonPythonRepository.from_json(json)
# print the JSON string representation of the object
print(PatchedpythonPythonRepository.to_json())

# convert the object into a dict
patchedpython_python_repository_dict = patchedpython_python_repository_instance.to_dict()
# create an instance of PatchedpythonPythonRepository from a dict
patchedpython_python_repository_from_dict = PatchedpythonPythonRepository.from_dict(patchedpython_python_repository_dict)

[Back to Model list] [Back to API list] [Back to README]

PolicyEnum

• immediate - When syncing, download all metadata and content now. * on_demand - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * streamed - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.

Enum

• IMMEDIATE (value: 'immediate')

• ON_DEMAND (value: 'on_demand')

• STREAMED (value: 'streamed')

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_python.PublicationsPypiApi

All URIs are relative to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
add_role	POST {python_python_publication_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/publications/python/pypi/	Create a python publication
delete	DELETE {python_python_publication_href}	Delete a python publication
list	GET /api/pulp/{pulp_domain}/api/v3/publications/python/pypi/	List python publications
list_roles	GET {python_python_publication_href}list_roles/	List roles
my_permissions	GET {python_python_publication_href}my_permissions/	List user permissions
read	GET {python_python_publication_href}	Inspect a python publication
remove_role	POST {python_python_publication_href}remove_role/	Remove a role

add_role

NestedRoleResponse add_role(python_python_publication_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.nested_role import NestedRole
from pulpcore.client.pulp_python.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PublicationsPypiApi(api_client)
    python_python_publication_href = 'python_python_publication_href_example' # str | 
    nested_role = pulpcore.client.pulp_python.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(python_python_publication_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of PublicationsPypiApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsPypiApi->add_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_publication_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

AsyncOperationResponse create(pulp_domain, python_python_publication, x_task_diagnostics=x_task_diagnostics)

Create a python publication

Dispatches a publish task, which generates metadata that will be used by pip.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.models.python_python_publication import PythonPythonPublication
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PublicationsPypiApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    python_python_publication = pulpcore.client.pulp_python.PythonPythonPublication() # PythonPythonPublication | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a python publication
        api_response = api_instance.create(pulp_domain, python_python_publication, x_task_diagnostics=x_task_diagnostics)
        print("The response of PublicationsPypiApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsPypiApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
python_python_publication	PythonPythonPublication
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

delete(python_python_publication_href, x_task_diagnostics=x_task_diagnostics)

Delete a python publication

Python Publications refer to the Python Package content in a repository version, and include metadata about that content.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

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 https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PublicationsPypiApi(api_client)
    python_python_publication_href = 'python_python_publication_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a python publication
        api_instance.delete(python_python_publication_href, x_task_diagnostics=x_task_diagnostics)
    except Exception as e:
        print("Exception when calling PublicationsPypiApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_publication_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

void (empty response body)

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedpythonPythonPublicationResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, checkpoint=checkpoint, content=content, content__in=content__in, limit=limit, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, repository=repository, repository_version=repository_version, fields=fields, exclude_fields=exclude_fields)

List python publications

Python Publications refer to the Python Package content in a repository version, and include metadata about that content.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.paginatedpython_python_publication_response_list import PaginatedpythonPythonPublicationResponseList
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PublicationsPypiApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    checkpoint = True # bool | Filter results where checkpoint matches value (optional)
    content = 'content_example' # str | Content Unit referenced by HREF/PRN (optional)
    content__in = ['content__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
    pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
    pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
    pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
    pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
    pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
    pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    repository = 'repository_example' # str | Repository referenced by HREF/PRN (optional)
    repository_version = 'repository_version_example' # str | Repository Version referenced by HREF/PRN (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List python publications
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, checkpoint=checkpoint, content=content, content__in=content__in, limit=limit, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, q=q, repository=repository, repository_version=repository_version, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsPypiApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsPypiApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
checkpoint	bool	Filter results where checkpoint matches value	[optional]
content	str	Content Unit referenced by HREF/PRN	[optional]
content__in	List[str]	Multiple values may be separated by commas.	[optional]
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_created	datetime	Filter results where pulp_created matches value	[optional]
pulp_created__gt	datetime	Filter results where pulp_created is greater than value	[optional]
pulp_created__gte	datetime	Filter results where pulp_created is greater than or equal to value	[optional]
pulp_created__isnull	bool	Filter results where pulp_created has a null value	[optional]
pulp_created__lt	datetime	Filter results where pulp_created is less than value	[optional]
pulp_created__lte	datetime	Filter results where pulp_created is less than or equal to value	[optional]
pulp_created__range	List[datetime]	Filter results where pulp_created is between two comma separated values	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
repository	str	Repository referenced by HREF/PRN	[optional]
repository_version	str	Repository Version referenced by HREF/PRN	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedpythonPythonPublicationResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_roles

ObjectRolesResponse list_roles(python_python_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PublicationsPypiApi(api_client)
    python_python_publication_href = 'python_python_publication_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(python_python_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsPypiApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsPypiApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_publication_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ObjectRolesResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

my_permissions

MyPermissionsResponse my_permissions(python_python_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PublicationsPypiApi(api_client)
    python_python_publication_href = 'python_python_publication_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(python_python_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsPypiApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsPypiApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_publication_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

MyPermissionsResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

PythonPythonPublicationResponse read(python_python_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a python publication

Python Publications refer to the Python Package content in a repository version, and include metadata about that content.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_publication_response import PythonPythonPublicationResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PublicationsPypiApi(api_client)
    python_python_publication_href = 'python_python_publication_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a python publication
        api_response = api_instance.read(python_python_publication_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PublicationsPypiApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsPypiApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_publication_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PythonPythonPublicationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_role

NestedRoleResponse remove_role(python_python_publication_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.nested_role import NestedRole
from pulpcore.client.pulp_python.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PublicationsPypiApi(api_client)
    python_python_publication_href = 'python_python_publication_href_example' # str | 
    nested_role = pulpcore.client.pulp_python.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(python_python_publication_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of PublicationsPypiApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicationsPypiApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_publication_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_python.PypiMetadataApi

All URIs are relative to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
read	GET /api/pypi/{pulp_domain}/{path}/pypi/{meta}/	Get package metadata

read

PackageMetadataResponse read(meta, path, pulp_domain, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Get package metadata

Retrieves the package's core-metadata specified by https://packaging.python.org/specifications/core-metadata/. meta must be a path in form of {package}/json/ or {package}/{version}/json/

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.package_metadata_response import PackageMetadataResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PypiMetadataApi(api_client)
    meta = 'meta_example' # str | 
    path = 'path_example' # str | 
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Get package metadata
        api_response = api_instance.read(meta, path, pulp_domain, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of PypiMetadataApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PypiMetadataApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
meta	str
path	str
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PackageMetadataResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PythonPythonDistribution

Serializer for Pulp distributions for the Python type.

Properties

Name	Type	Description	Notes
base_path	str	The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. "foo" and "foo/bar")
content_guard	str	An optional content-guard.	[optional]
hidden	bool	Whether this distribution should be shown in the content app.	[optional] [default to False]
pulp_labels	Dict[str, Optional[str]]		[optional]
name	str	A unique name. Ex, `rawhide` and `stable`.
repository	str	The latest RepositoryVersion for this Repository will be served.	[optional]
publication	str	Publication to be served	[optional]
repository_version	str	RepositoryVersion to be served.	[optional]
allow_uploads	bool	Allow packages to be uploaded to this index.	[optional] [default to True]
remote	str	Remote that can be used to fetch content when using pull-through caching.	[optional]

Example

from pulpcore.client.pulp_python.models.python_python_distribution import PythonPythonDistribution

# TODO update the JSON string below
json = "{}"
# create an instance of PythonPythonDistribution from a JSON string
python_python_distribution_instance = PythonPythonDistribution.from_json(json)
# print the JSON string representation of the object
print(PythonPythonDistribution.to_json())

# convert the object into a dict
python_python_distribution_dict = python_python_distribution_instance.to_dict()
# create an instance of PythonPythonDistribution from a dict
python_python_distribution_from_dict = PythonPythonDistribution.from_dict(python_python_distribution_dict)

[Back to Model list] [Back to API list] [Back to README]

PythonPythonDistributionResponse

Serializer for Pulp distributions for the Python type.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
base_path	str	The base (relative) path component of the published url. Avoid paths that overlap with other distribution base paths (e.g. "foo" and "foo/bar")
base_url	str		[optional] [readonly]
content_guard	str	An optional content-guard.	[optional]
no_content_change_since	str	Timestamp since when the distributed content served by this distribution has not changed. If equals to `null`, no guarantee is provided about content changes.	[optional] [readonly]
hidden	bool	Whether this distribution should be shown in the content app.	[optional] [default to False]
pulp_labels	Dict[str, Optional[str]]		[optional]
name	str	A unique name. Ex, `rawhide` and `stable`.
repository	str	The latest RepositoryVersion for this Repository will be served.	[optional]
publication	str	Publication to be served	[optional]
repository_version	str	RepositoryVersion to be served.	[optional]
allow_uploads	bool	Allow packages to be uploaded to this index.	[optional] [default to True]
remote	str	Remote that can be used to fetch content when using pull-through caching.	[optional]

Example

from pulpcore.client.pulp_python.models.python_python_distribution_response import PythonPythonDistributionResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PythonPythonDistributionResponse from a JSON string
python_python_distribution_response_instance = PythonPythonDistributionResponse.from_json(json)
# print the JSON string representation of the object
print(PythonPythonDistributionResponse.to_json())

# convert the object into a dict
python_python_distribution_response_dict = python_python_distribution_response_instance.to_dict()
# create an instance of PythonPythonDistributionResponse from a dict
python_python_distribution_response_from_dict = PythonPythonDistributionResponse.from_dict(python_python_distribution_response_dict)

[Back to Model list] [Back to API list] [Back to README]

PythonPythonPackageContentResponse

A Serializer for PythonPackageContent.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
pulp_labels	Dict[str, Optional[str]]	A dictionary of arbitrary key/value pairs used to describe a specific Content instance.	[optional]
vuln_report	str		[optional] [readonly]
artifact	str	Artifact file representing the physical content	[optional]
author	str	Text containing the author's name. Contact information can also be added, separated with newlines.	[optional]
author_email	str	The author's e-mail address.	[optional]
description	str	A longer description of the package that can run to several paragraphs.	[optional]
home_page	str	The URL for the package's home page.	[optional]
keywords	str	Additional keywords to be used to assist searching for the package in a larger catalog.	[optional]
license	str	Text indicating the license covering the distribution	[optional]
metadata_version	str	Version of the file format	[optional] [readonly]
name	str	The name of the python project.	[optional] [readonly]
platform	str	A comma-separated list of platform specifications, summarizing the operating systems supported by the package.	[optional]
summary	str	A one-line summary of what the package does.	[optional]
version	str	The packages version number.	[optional] [readonly]
classifiers	object	A JSON list containing classification values for a Python package.	[optional]
download_url	str	Legacy field denoting the URL from which this package can be downloaded.	[optional]
supported_platform	str	Field to specify the OS and CPU for which the binary package was compiled.	[optional]
maintainer	str	The maintainer's name at a minimum; additional contact information may be provided.	[optional]
maintainer_email	str	The maintainer's e-mail address.	[optional]
obsoletes_dist	object	A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.	[optional]
project_url	str	A browsable URL for the project and a label for it, separated by a comma.	[optional]
project_urls	object	A dictionary of labels and URLs for the project.	[optional]
provides_dist	object	A JSON list containing names of a Distutils project which is contained within this distribution.	[optional]
requires_external	object	A JSON list containing some dependency in the system that the distribution is to be used.	[optional]
requires_dist	object	A JSON list containing names of some other distutils project required by this distribution.	[optional]
requires_python	str	The Python version(s) that the distribution is guaranteed to be compatible with.	[optional]
description_content_type	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	object	A JSON list containing names of optional features provided by the package.	[optional]
dynamic	object	A JSON list containing names of other core metadata fields which are permitted to vary between sdist and bdist packages. Fields NOT marked dynamic MUST be the same between bdist and sdist.	[optional]
license_expression	str	Text string that is a valid SPDX license expression.	[optional]
license_file	object	A JSON list containing names of the paths to license-related files.	[optional]
filename	str	The name of the distribution package, usually of the format: {distribution}-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.{packagetype}	[optional] [readonly]
packagetype	str	The type of the distribution package (e.g. sdist, bdist_wheel, bdist_egg, etc)	[optional] [readonly]
python_version	str	The tag that indicates which Python implementation or version the package requires.	[optional] [readonly]
sha256	str	The SHA256 digest of this package.	[optional] [default to '']
metadata_sha256	str	The SHA256 digest of the package's METADATA file.	[optional]

Example

from pulpcore.client.pulp_python.models.python_python_package_content_response import PythonPythonPackageContentResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PythonPythonPackageContentResponse from a JSON string
python_python_package_content_response_instance = PythonPythonPackageContentResponse.from_json(json)
# print the JSON string representation of the object
print(PythonPythonPackageContentResponse.to_json())

# convert the object into a dict
python_python_package_content_response_dict = python_python_package_content_response_instance.to_dict()
# create an instance of PythonPythonPackageContentResponse from a dict
python_python_package_content_response_from_dict = PythonPythonPackageContentResponse.from_dict(python_python_package_content_response_dict)

[Back to Model list] [Back to API list] [Back to README]

PythonPythonPublication

A Serializer for PythonPublication.

Properties

Name	Type	Description	Notes
repository_version	str		[optional]
repository	str	A URI of the repository to be published.	[optional]

Example

from pulpcore.client.pulp_python.models.python_python_publication import PythonPythonPublication

# TODO update the JSON string below
json = "{}"
# create an instance of PythonPythonPublication from a JSON string
python_python_publication_instance = PythonPythonPublication.from_json(json)
# print the JSON string representation of the object
print(PythonPythonPublication.to_json())

# convert the object into a dict
python_python_publication_dict = python_python_publication_instance.to_dict()
# create an instance of PythonPythonPublication from a dict
python_python_publication_from_dict = PythonPythonPublication.from_dict(python_python_publication_dict)

[Back to Model list] [Back to API list] [Back to README]

PythonPythonPublicationResponse

A Serializer for PythonPublication.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
repository_version	str		[optional]
repository	str	A URI of the repository to be published.	[optional]
distributions	List[str]	This publication is currently being hosted as configured by these distributions.	[optional] [readonly]

Example

from pulpcore.client.pulp_python.models.python_python_publication_response import PythonPythonPublicationResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PythonPythonPublicationResponse from a JSON string
python_python_publication_response_instance = PythonPythonPublicationResponse.from_json(json)
# print the JSON string representation of the object
print(PythonPythonPublicationResponse.to_json())

# convert the object into a dict
python_python_publication_response_dict = python_python_publication_response_instance.to_dict()
# create an instance of PythonPythonPublicationResponse from a dict
python_python_publication_response_from_dict = PythonPythonPublicationResponse.from_dict(python_python_publication_response_dict)

[Back to Model list] [Back to API list] [Back to README]

PythonPythonRemote

A Serializer for PythonRemote.

Properties

Name	Type	Description	Notes
name	str	A unique name for this remote.
url	str	The URL of an external content source.
ca_cert	str	A PEM encoded CA certificate used to validate the server certificate presented by the remote server.	[optional]
client_cert	str	A PEM encoded client certificate used for authentication.	[optional]
client_key	str	A PEM encoded private key used for authentication.	[optional]
tls_validation	bool	If True, TLS peer validation must be performed.	[optional]
proxy_url	str	The proxy URL. Format: scheme://host:port	[optional]
proxy_username	str	The username to authenticte to the proxy.	[optional]
proxy_password	str	The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed.	[optional]
username	str	The username to be used for authentication when syncing.	[optional]
password	str	The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed.	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[optional]
policy	PolicyEnum	The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.	[optional]
total_timeout	float	aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
connect_timeout	float	aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_connect_timeout	float	aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_read_timeout	float	aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
headers	List[object]	Headers for aiohttp.Clientsession	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]
includes	List[str]	A list containing project specifiers for Python packages to include.	[optional]
excludes	List[str]	A list containing project specifiers for Python packages to exclude.	[optional]
prereleases	bool	Whether or not to include pre-release packages in the sync.	[optional]
package_types	List[PackageTypesEnum]	The package types to sync for Python content. Leave blank to get everypackage type.	[optional]
keep_latest_packages	int	The amount of latest versions of a package to keep on sync, includespre-releases if synced. Default 0 keeps all versions.	[optional] [default to 0]
exclude_platforms	List[ExcludePlatformsEnum]	List of platforms to exclude syncing Python packages for. Possible valuesinclude: windows, macos, freebsd, and linux.	[optional]

Example

from pulpcore.client.pulp_python.models.python_python_remote import PythonPythonRemote

# TODO update the JSON string below
json = "{}"
# create an instance of PythonPythonRemote from a JSON string
python_python_remote_instance = PythonPythonRemote.from_json(json)
# print the JSON string representation of the object
print(PythonPythonRemote.to_json())

# convert the object into a dict
python_python_remote_dict = python_python_remote_instance.to_dict()
# create an instance of PythonPythonRemote from a dict
python_python_remote_from_dict = PythonPythonRemote.from_dict(python_python_remote_dict)

[Back to Model list] [Back to API list] [Back to README]

PythonPythonRemoteResponseHiddenFieldsInner

Properties

Name	Type	Description	Notes
name	str
is_set	bool

Example

from pulpcore.client.pulp_python.models.python_python_remote_response_hidden_fields_inner import PythonPythonRemoteResponseHiddenFieldsInner

# TODO update the JSON string below
json = "{}"
# create an instance of PythonPythonRemoteResponseHiddenFieldsInner from a JSON string
python_python_remote_response_hidden_fields_inner_instance = PythonPythonRemoteResponseHiddenFieldsInner.from_json(json)
# print the JSON string representation of the object
print(PythonPythonRemoteResponseHiddenFieldsInner.to_json())

# convert the object into a dict
python_python_remote_response_hidden_fields_inner_dict = python_python_remote_response_hidden_fields_inner_instance.to_dict()
# create an instance of PythonPythonRemoteResponseHiddenFieldsInner from a dict
python_python_remote_response_hidden_fields_inner_from_dict = PythonPythonRemoteResponseHiddenFieldsInner.from_dict(python_python_remote_response_hidden_fields_inner_dict)

[Back to Model list] [Back to API list] [Back to README]

PythonPythonRemoteResponse

A Serializer for PythonRemote.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the most recent update of the remote.	[optional] [readonly]
name	str	A unique name for this remote.
url	str	The URL of an external content source.
ca_cert	str	A PEM encoded CA certificate used to validate the server certificate presented by the remote server.	[optional]
client_cert	str	A PEM encoded client certificate used for authentication.	[optional]
tls_validation	bool	If True, TLS peer validation must be performed.	[optional]
proxy_url	str	The proxy URL. Format: scheme://host:port	[optional]
pulp_labels	Dict[str, Optional[str]]		[optional]
download_concurrency	int	Total number of simultaneous connections. If not set then the default value will be used.	[optional]
max_retries	int	Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used.	[optional]
policy	PolicyEnum	The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.	[optional]
total_timeout	float	aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
connect_timeout	float	aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_connect_timeout	float	aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
sock_read_timeout	float	aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used.	[optional]
headers	List[object]	Headers for aiohttp.Clientsession	[optional]
rate_limit	int	Limits requests per second for each concurrent downloader	[optional]
hidden_fields	List[PythonPythonRemoteResponseHiddenFieldsInner]	List of hidden (write only) fields	[optional] [readonly]
includes	List[str]	A list containing project specifiers for Python packages to include.	[optional]
excludes	List[str]	A list containing project specifiers for Python packages to exclude.	[optional]
prereleases	bool	Whether or not to include pre-release packages in the sync.	[optional]
package_types	List[PackageTypesEnum]	The package types to sync for Python content. Leave blank to get everypackage type.	[optional]
keep_latest_packages	int	The amount of latest versions of a package to keep on sync, includespre-releases if synced. Default 0 keeps all versions.	[optional] [default to 0]
exclude_platforms	List[ExcludePlatformsEnum]	List of platforms to exclude syncing Python packages for. Possible valuesinclude: windows, macos, freebsd, and linux.	[optional]

Example

from pulpcore.client.pulp_python.models.python_python_remote_response import PythonPythonRemoteResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PythonPythonRemoteResponse from a JSON string
python_python_remote_response_instance = PythonPythonRemoteResponse.from_json(json)
# print the JSON string representation of the object
print(PythonPythonRemoteResponse.to_json())

# convert the object into a dict
python_python_remote_response_dict = python_python_remote_response_instance.to_dict()
# create an instance of PythonPythonRemoteResponse from a dict
python_python_remote_response_from_dict = PythonPythonRemoteResponse.from_dict(python_python_remote_response_dict)

[Back to Model list] [Back to API list] [Back to README]

PythonPythonRepository

Serializer for Python Repositories.

Properties

Name	Type	Description	Notes
pulp_labels	Dict[str, Optional[str]]		[optional]
name	str	A unique name for this repository.
description	str	An optional description.	[optional]
retain_repo_versions	int	Retain X versions of the repository. Default is null which retains all versions.	[optional]
remote	str	An optional remote to use by default when syncing.	[optional]
autopublish	bool	Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository.	[optional] [default to False]

Example

from pulpcore.client.pulp_python.models.python_python_repository import PythonPythonRepository

# TODO update the JSON string below
json = "{}"
# create an instance of PythonPythonRepository from a JSON string
python_python_repository_instance = PythonPythonRepository.from_json(json)
# print the JSON string representation of the object
print(PythonPythonRepository.to_json())

# convert the object into a dict
python_python_repository_dict = python_python_repository_instance.to_dict()
# create an instance of PythonPythonRepository from a dict
python_python_repository_from_dict = PythonPythonRepository.from_dict(python_python_repository_dict)

[Back to Model list] [Back to API list] [Back to README]

PythonPythonRepositoryResponse

Serializer for Python Repositories.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
versions_href	str		[optional] [readonly]
pulp_labels	Dict[str, Optional[str]]		[optional]
latest_version_href	str		[optional] [readonly]
name	str	A unique name for this repository.
description	str	An optional description.	[optional]
retain_repo_versions	int	Retain X versions of the repository. Default is null which retains all versions.	[optional]
remote	str	An optional remote to use by default when syncing.	[optional]
autopublish	bool	Whether to automatically create publications for new repository versions, and update any distributions pointing to this repository.	[optional] [default to False]

Example

from pulpcore.client.pulp_python.models.python_python_repository_response import PythonPythonRepositoryResponse

# TODO update the JSON string below
json = "{}"
# create an instance of PythonPythonRepositoryResponse from a JSON string
python_python_repository_response_instance = PythonPythonRepositoryResponse.from_json(json)
# print the JSON string representation of the object
print(PythonPythonRepositoryResponse.to_json())

# convert the object into a dict
python_python_repository_response_dict = python_python_repository_response_instance.to_dict()
# create an instance of PythonPythonRepositoryResponse from a dict
python_python_repository_response_from_dict = PythonPythonRepositoryResponse.from_dict(python_python_repository_response_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_python.RemotesPythonApi

All URIs are relative to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
add_role	POST {python_python_remote_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/remotes/python/python/	Create a python remote
delete	DELETE {python_python_remote_href}	Delete a python remote
from_bandersnatch	POST /api/pulp/{pulp_domain}/api/v3/remotes/python/python/from_bandersnatch/	Create from Bandersnatch
list	GET /api/pulp/{pulp_domain}/api/v3/remotes/python/python/	List python remotes
list_roles	GET {python_python_remote_href}list_roles/	List roles
my_permissions	GET {python_python_remote_href}my_permissions/	List user permissions
partial_update	PATCH {python_python_remote_href}	Update a python remote
read	GET {python_python_remote_href}	Inspect a python remote
remove_role	POST {python_python_remote_href}remove_role/	Remove a role
set_label	POST {python_python_remote_href}set_label/	Set a label
unset_label	POST {python_python_remote_href}unset_label/	Unset a label
update	PUT {python_python_remote_href}	Update a python remote

add_role

NestedRoleResponse add_role(python_python_remote_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.nested_role import NestedRole
from pulpcore.client.pulp_python.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    python_python_remote_href = 'python_python_remote_href_example' # str | 
    nested_role = pulpcore.client.pulp_python.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(python_python_remote_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesPythonApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->add_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_remote_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

PythonPythonRemoteResponse create(pulp_domain, python_python_remote, x_task_diagnostics=x_task_diagnostics)

Create a python remote

Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to sync from upstream repositories, and contains sync settings.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_remote import PythonPythonRemote
from pulpcore.client.pulp_python.models.python_python_remote_response import PythonPythonRemoteResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    python_python_remote = pulpcore.client.pulp_python.PythonPythonRemote() # PythonPythonRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a python remote
        api_response = api_instance.create(pulp_domain, python_python_remote, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesPythonApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
python_python_remote	PythonPythonRemote
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

PythonPythonRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

AsyncOperationResponse delete(python_python_remote_href, x_task_diagnostics=x_task_diagnostics)

Delete a python remote

Trigger an asynchronous delete task

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    python_python_remote_href = 'python_python_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a python remote
        api_response = api_instance.delete(python_python_remote_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesPythonApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_remote_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

from_bandersnatch

PythonPythonRemoteResponse from_bandersnatch(pulp_domain, config, name, x_task_diagnostics=x_task_diagnostics, policy=policy)

Create from Bandersnatch

Takes the fields specified in the Bandersnatch config and creates a Python Remote from it.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_remote_response import PythonPythonRemoteResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    config = None # bytearray | A Bandersnatch config that may be used to construct a Python Remote.
    name = 'name_example' # str | A unique name for this remote
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    policy = pulpcore.client.pulp_python.PolicyEnum() # PolicyEnum | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default.  * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. (optional)

    try:
        # Create from Bandersnatch
        api_response = api_instance.from_bandersnatch(pulp_domain, config, name, x_task_diagnostics=x_task_diagnostics, policy=policy)
        print("The response of RemotesPythonApi->from_bandersnatch:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->from_bandersnatch: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
config	bytearray	A Bandersnatch config that may be used to construct a Python Remote.
name	str	A unique name for this remote
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
policy	PolicyEnum	The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again.	[optional]

Return type

PythonPythonRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: multipart/form-data, application/x-www-form-urlencoded
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedpythonPythonRemoteResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)

List python remotes

Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to sync from upstream repositories, and contains sync settings.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.paginatedpython_python_remote_response_list import PaginatedpythonPythonRemoteResponseList
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    pulp_last_updated = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated matches value (optional)
    pulp_last_updated__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than value (optional)
    pulp_last_updated__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is greater than or equal to value (optional)
    pulp_last_updated__isnull = True # bool | Filter results where pulp_last_updated has a null value (optional)
    pulp_last_updated__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than value (optional)
    pulp_last_updated__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_last_updated is less than or equal to value (optional)
    pulp_last_updated__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_last_updated is between two comma separated values (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List python remotes
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, pulp_last_updated=pulp_last_updated, pulp_last_updated__gt=pulp_last_updated__gt, pulp_last_updated__gte=pulp_last_updated__gte, pulp_last_updated__isnull=pulp_last_updated__isnull, pulp_last_updated__lt=pulp_last_updated__lt, pulp_last_updated__lte=pulp_last_updated__lte, pulp_last_updated__range=pulp_last_updated__range, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesPythonApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
limit	int	Number of results to return per page.	[optional]
name	str	Filter results where name matches value	[optional]
name__contains	str	Filter results where name contains value	[optional]
name__icontains	str	Filter results where name contains value	[optional]
name__iexact	str	Filter results where name matches value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
name__iregex	str	Filter results where name matches regex value	[optional]
name__istartswith	str	Filter results where name starts with value	[optional]
name__regex	str	Filter results where name matches regex value	[optional]
name__startswith	str	Filter results where name starts with value	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_label_select	str	Filter labels by search string	[optional]
pulp_last_updated	datetime	Filter results where pulp_last_updated matches value	[optional]
pulp_last_updated__gt	datetime	Filter results where pulp_last_updated is greater than value	[optional]
pulp_last_updated__gte	datetime	Filter results where pulp_last_updated is greater than or equal to value	[optional]
pulp_last_updated__isnull	bool	Filter results where pulp_last_updated has a null value	[optional]
pulp_last_updated__lt	datetime	Filter results where pulp_last_updated is less than value	[optional]
pulp_last_updated__lte	datetime	Filter results where pulp_last_updated is less than or equal to value	[optional]
pulp_last_updated__range	List[datetime]	Filter results where pulp_last_updated is between two comma separated values	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedpythonPythonRemoteResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_roles

ObjectRolesResponse list_roles(python_python_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    python_python_remote_href = 'python_python_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(python_python_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesPythonApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_remote_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ObjectRolesResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

my_permissions

MyPermissionsResponse my_permissions(python_python_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    python_python_remote_href = 'python_python_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(python_python_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesPythonApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_remote_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

MyPermissionsResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

PythonPythonRemoteResponse partial_update(python_python_remote_href, patchedpython_python_remote, x_task_diagnostics=x_task_diagnostics)

Update a python remote

Update the entity partially and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.patchedpython_python_remote import PatchedpythonPythonRemote
from pulpcore.client.pulp_python.models.python_python_remote_response import PythonPythonRemoteResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    python_python_remote_href = 'python_python_remote_href_example' # str | 
    patchedpython_python_remote = pulpcore.client.pulp_python.PatchedpythonPythonRemote() # PatchedpythonPythonRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a python remote
        api_response = api_instance.partial_update(python_python_remote_href, patchedpython_python_remote, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesPythonApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_remote_href	str
patchedpython_python_remote	PatchedpythonPythonRemote
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

PythonPythonRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

PythonPythonRemoteResponse read(python_python_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a python remote

Python Remotes are representations of an external repository of Python content, eg. PyPI. Fields include upstream repository config. Python Remotes are also used to sync from upstream repositories, and contains sync settings.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_remote_response import PythonPythonRemoteResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    python_python_remote_href = 'python_python_remote_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a python remote
        api_response = api_instance.read(python_python_remote_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RemotesPythonApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_remote_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PythonPythonRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_role

NestedRoleResponse remove_role(python_python_remote_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.nested_role import NestedRole
from pulpcore.client.pulp_python.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    python_python_remote_href = 'python_python_remote_href_example' # str | 
    nested_role = pulpcore.client.pulp_python.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(python_python_remote_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesPythonApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_remote_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(python_python_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.set_label import SetLabel
from pulpcore.client.pulp_python.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    python_python_remote_href = 'python_python_remote_href_example' # str | 
    set_label = pulpcore.client.pulp_python.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(python_python_remote_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesPythonApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_remote_href	str
set_label	SetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(python_python_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.unset_label import UnsetLabel
from pulpcore.client.pulp_python.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    python_python_remote_href = 'python_python_remote_href_example' # str | 
    unset_label = pulpcore.client.pulp_python.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(python_python_remote_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesPythonApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->unset_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_remote_href	str
unset_label	UnsetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

PythonPythonRemoteResponse update(python_python_remote_href, python_python_remote, x_task_diagnostics=x_task_diagnostics)

Update a python remote

Update the entity and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_remote import PythonPythonRemote
from pulpcore.client.pulp_python.models.python_python_remote_response import PythonPythonRemoteResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RemotesPythonApi(api_client)
    python_python_remote_href = 'python_python_remote_href_example' # str | 
    python_python_remote = pulpcore.client.pulp_python.PythonPythonRemote() # PythonPythonRemote | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a python remote
        api_response = api_instance.update(python_python_remote_href, python_python_remote, x_task_diagnostics=x_task_diagnostics)
        print("The response of RemotesPythonApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RemotesPythonApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_remote_href	str
python_python_remote	PythonPythonRemote
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

PythonPythonRemoteResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Repair

Properties

Name	Type	Description	Notes
verify_checksums	bool	Will verify that the checksum of all stored files matches what saved in the database. Otherwise only the existence of the files will be checked. Enabled by default	[optional] [default to True]

Example

from pulpcore.client.pulp_python.models.repair import Repair

# TODO update the JSON string below
json = "{}"
# create an instance of Repair from a JSON string
repair_instance = Repair.from_json(json)
# print the JSON string representation of the object
print(Repair.to_json())

# convert the object into a dict
repair_dict = repair_instance.to_dict()
# create an instance of Repair from a dict
repair_from_dict = Repair.from_dict(repair_dict)

[Back to Model list] [Back to API list] [Back to README]

pulpcore.client.pulp_python.RepositoriesPythonApi

All URIs are relative to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
add_role	POST {python_python_repository_href}add_role/	Add a role
create	POST /api/pulp/{pulp_domain}/api/v3/repositories/python/python/	Create a python repository
delete	DELETE {python_python_repository_href}	Delete a python repository
list	GET /api/pulp/{pulp_domain}/api/v3/repositories/python/python/	List python repositorys
list_roles	GET {python_python_repository_href}list_roles/	List roles
modify	POST {python_python_repository_href}modify/	Modify Repository Content
my_permissions	GET {python_python_repository_href}my_permissions/	List user permissions
partial_update	PATCH {python_python_repository_href}	Update a python repository
read	GET {python_python_repository_href}	Inspect a python repository
remove_role	POST {python_python_repository_href}remove_role/	Remove a role
repair_metadata	POST {python_python_repository_href}repair_metadata/	Repair metadata
set_label	POST {python_python_repository_href}set_label/	Set a label
sync	POST {python_python_repository_href}sync/	Sync from remote
unset_label	POST {python_python_repository_href}unset_label/	Unset a label
update	PUT {python_python_repository_href}	Update a python repository

add_role

NestedRoleResponse add_role(python_python_repository_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Add a role

Add a role for this object to users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.nested_role import NestedRole
from pulpcore.client.pulp_python.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    nested_role = pulpcore.client.pulp_python.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Add a role
        api_response = api_instance.add_role(python_python_repository_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->add_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->add_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

PythonPythonRepositoryResponse create(pulp_domain, python_python_repository, x_task_diagnostics=x_task_diagnostics)

Create a python repository

PythonRepository represents a single Python repository, to which content can be synced, added, or removed.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_repository import PythonPythonRepository
from pulpcore.client.pulp_python.models.python_python_repository_response import PythonPythonRepositoryResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    python_python_repository = pulpcore.client.pulp_python.PythonPythonRepository() # PythonPythonRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Create a python repository
        api_response = api_instance.create(pulp_domain, python_python_repository, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
python_python_repository	PythonPythonRepository
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

PythonPythonRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

AsyncOperationResponse delete(python_python_repository_href, x_task_diagnostics=x_task_diagnostics)

Delete a python repository

Trigger an asynchronous delete task

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a python repository
        api_response = api_instance.delete(python_python_repository_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedpythonPythonRepositoryResponseList list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)

List python repositorys

PythonRepository represents a single Python repository, to which content can be synced, added, or removed.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.paginatedpython_python_repository_response_list import PaginatedpythonPythonRepositoryResponseList
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    pulp_domain = 'pulp_domain_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    latest_with_content = 'latest_with_content_example' # str | Content Unit referenced by HREF/PRN (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str | Filter results where name matches value (optional)
    name__contains = 'name__contains_example' # str | Filter results where name contains value (optional)
    name__icontains = 'name__icontains_example' # str | Filter results where name contains value (optional)
    name__iexact = 'name__iexact_example' # str | Filter results where name matches value (optional)
    name__in = ['name__in_example'] # List[str] | Filter results where name is in a comma-separated list of values (optional)
    name__iregex = 'name__iregex_example' # str | Filter results where name matches regex value (optional)
    name__istartswith = 'name__istartswith_example' # str | Filter results where name starts with value (optional)
    name__regex = 'name__regex_example' # str | Filter results where name matches regex value (optional)
    name__startswith = 'name__startswith_example' # str | Filter results where name starts with value (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_id__in = ['pulp_id__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_label_select = 'pulp_label_select_example' # str | Filter labels by search string (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    remote = 'remote_example' # str | Foreign Key referenced by HREF (optional)
    retain_repo_versions = 56 # int | Filter results where retain_repo_versions matches value (optional)
    retain_repo_versions__gt = 56 # int | Filter results where retain_repo_versions is greater than value (optional)
    retain_repo_versions__gte = 56 # int | Filter results where retain_repo_versions is greater than or equal to value (optional)
    retain_repo_versions__isnull = True # bool | Filter results where retain_repo_versions has a null value (optional)
    retain_repo_versions__lt = 56 # int | Filter results where retain_repo_versions is less than value (optional)
    retain_repo_versions__lte = 56 # int | Filter results where retain_repo_versions is less than or equal to value (optional)
    retain_repo_versions__ne = 56 # int | Filter results where retain_repo_versions not equal to value (optional)
    retain_repo_versions__range = [56] # List[int] | Filter results where retain_repo_versions is between two comma separated values (optional)
    with_content = 'with_content_example' # str | Content Unit referenced by HREF/PRN (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List python repositorys
        api_response = api_instance.list(pulp_domain, x_task_diagnostics=x_task_diagnostics, latest_with_content=latest_with_content, limit=limit, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, name__in=name__in, name__iregex=name__iregex, name__istartswith=name__istartswith, name__regex=name__regex, name__startswith=name__startswith, offset=offset, ordering=ordering, prn__in=prn__in, pulp_href__in=pulp_href__in, pulp_id__in=pulp_id__in, pulp_label_select=pulp_label_select, q=q, remote=remote, retain_repo_versions=retain_repo_versions, retain_repo_versions__gt=retain_repo_versions__gt, retain_repo_versions__gte=retain_repo_versions__gte, retain_repo_versions__isnull=retain_repo_versions__isnull, retain_repo_versions__lt=retain_repo_versions__lt, retain_repo_versions__lte=retain_repo_versions__lte, retain_repo_versions__ne=retain_repo_versions__ne, retain_repo_versions__range=retain_repo_versions__range, with_content=with_content, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesPythonApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
pulp_domain	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
latest_with_content	str	Content Unit referenced by HREF/PRN	[optional]
limit	int	Number of results to return per page.	[optional]
name	str	Filter results where name matches value	[optional]
name__contains	str	Filter results where name contains value	[optional]
name__icontains	str	Filter results where name contains value	[optional]
name__iexact	str	Filter results where name matches value	[optional]
name__in	List[str]	Filter results where name is in a comma-separated list of values	[optional]
name__iregex	str	Filter results where name matches regex value	[optional]
name__istartswith	str	Filter results where name starts with value	[optional]
name__regex	str	Filter results where name matches regex value	[optional]
name__startswith	str	Filter results where name starts with value	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_id__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_label_select	str	Filter labels by search string	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
remote	str	Foreign Key referenced by HREF	[optional]
retain_repo_versions	int	Filter results where retain_repo_versions matches value	[optional]
retain_repo_versions__gt	int	Filter results where retain_repo_versions is greater than value	[optional]
retain_repo_versions__gte	int	Filter results where retain_repo_versions is greater than or equal to value	[optional]
retain_repo_versions__isnull	bool	Filter results where retain_repo_versions has a null value	[optional]
retain_repo_versions__lt	int	Filter results where retain_repo_versions is less than value	[optional]
retain_repo_versions__lte	int	Filter results where retain_repo_versions is less than or equal to value	[optional]
retain_repo_versions__ne	int	Filter results where retain_repo_versions not equal to value	[optional]
retain_repo_versions__range	List[int]	Filter results where retain_repo_versions is between two comma separated values	[optional]
with_content	str	Content Unit referenced by HREF/PRN	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedpythonPythonRepositoryResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_roles

ObjectRolesResponse list_roles(python_python_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List roles

List roles assigned to this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.object_roles_response import ObjectRolesResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List roles
        api_response = api_instance.list_roles(python_python_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesPythonApi->list_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->list_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

ObjectRolesResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

modify

AsyncOperationResponse modify(python_python_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)

Modify Repository Content

Trigger an asynchronous task to create a new repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.models.repository_add_remove_content import RepositoryAddRemoveContent
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    repository_add_remove_content = pulpcore.client.pulp_python.RepositoryAddRemoveContent() # RepositoryAddRemoveContent | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Modify Repository Content
        api_response = api_instance.modify(python_python_repository_href, repository_add_remove_content, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->modify:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->modify: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
repository_add_remove_content	RepositoryAddRemoveContent
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

my_permissions

MyPermissionsResponse my_permissions(python_python_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

List user permissions

List permissions available to the current user on this object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.my_permissions_response import MyPermissionsResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List user permissions
        api_response = api_instance.my_permissions(python_python_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesPythonApi->my_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->my_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

MyPermissionsResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

PythonPythonRepositoryResponse partial_update(python_python_repository_href, patchedpython_python_repository, x_task_diagnostics=x_task_diagnostics)

Update a python repository

Update the entity partially and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.patchedpython_python_repository import PatchedpythonPythonRepository
from pulpcore.client.pulp_python.models.python_python_repository_response import PythonPythonRepositoryResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    patchedpython_python_repository = pulpcore.client.pulp_python.PatchedpythonPythonRepository() # PatchedpythonPythonRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a python repository
        api_response = api_instance.partial_update(python_python_repository_href, patchedpython_python_repository, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
patchedpython_python_repository	PatchedpythonPythonRepository
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

PythonPythonRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

PythonPythonRepositoryResponse read(python_python_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a python repository

PythonRepository represents a single Python repository, to which content can be synced, added, or removed.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_repository_response import PythonPythonRepositoryResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a python repository
        api_response = api_instance.read(python_python_repository_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesPythonApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PythonPythonRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_role

NestedRoleResponse remove_role(python_python_repository_href, nested_role, x_task_diagnostics=x_task_diagnostics)

Remove a role

Remove a role for this object from users/groups.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.nested_role import NestedRole
from pulpcore.client.pulp_python.models.nested_role_response import NestedRoleResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    nested_role = pulpcore.client.pulp_python.NestedRole() # NestedRole | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Remove a role
        api_response = api_instance.remove_role(python_python_repository_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->remove_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->remove_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
nested_role	NestedRole
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

NestedRoleResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repair_metadata

AsyncOperationResponse repair_metadata(python_python_repository_href, x_task_diagnostics=x_task_diagnostics)

Repair metadata

Trigger an asynchronous task to repair Python metadata. This task will repair metadata of all packages for the specified Repository, without creating a new RepositoryVersion.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Repair metadata
        api_response = api_instance.repair_metadata(python_python_repository_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->repair_metadata:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->repair_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_label

SetLabelResponse set_label(python_python_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)

Set a label

Set a single pulp_label on the object to a specific value or null.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.set_label import SetLabel
from pulpcore.client.pulp_python.models.set_label_response import SetLabelResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    set_label = pulpcore.client.pulp_python.SetLabel() # SetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Set a label
        api_response = api_instance.set_label(python_python_repository_href, set_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->set_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->set_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
set_label	SetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

SetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sync

AsyncOperationResponse sync(python_python_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)

Sync from remote

Trigger an asynchronous task to sync python content. The sync task will retrieve Python content from the specified Remote and update the specified Respository, creating a new RepositoryVersion.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.models.repository_sync_url import RepositorySyncURL
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    repository_sync_url = pulpcore.client.pulp_python.RepositorySyncURL() # RepositorySyncURL | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Sync from remote
        api_response = api_instance.sync(python_python_repository_href, repository_sync_url, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->sync:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->sync: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
repository_sync_url	RepositorySyncURL
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unset_label

UnsetLabelResponse unset_label(python_python_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)

Unset a label

Unset a single pulp_label on the object.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.unset_label import UnsetLabel
from pulpcore.client.pulp_python.models.unset_label_response import UnsetLabelResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    unset_label = pulpcore.client.pulp_python.UnsetLabel() # UnsetLabel | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Unset a label
        api_response = api_instance.unset_label(python_python_repository_href, unset_label, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->unset_label:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->unset_label: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
unset_label	UnsetLabel
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

UnsetLabelResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

PythonPythonRepositoryResponse update(python_python_repository_href, python_python_repository, x_task_diagnostics=x_task_diagnostics)

Update a python repository

Update the entity and trigger an asynchronous task if necessary

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.python_python_repository import PythonPythonRepository
from pulpcore.client.pulp_python.models.python_python_repository_response import PythonPythonRepositoryResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    python_python_repository = pulpcore.client.pulp_python.PythonPythonRepository() # PythonPythonRepository | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Update a python repository
        api_response = api_instance.update(python_python_repository_href, python_python_repository, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
python_python_repository	PythonPythonRepository
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

PythonPythonRepositoryResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pulpcore.client.pulp_python.RepositoriesPythonVersionsApi

All URIs are relative to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com

Method	HTTP request	Description
delete	DELETE {python_python_repository_version_href}	Delete a repository version
list	GET {python_python_repository_href}versions/	List repository versions
read	GET {python_python_repository_version_href}	Inspect a repository version
repair	POST {python_python_repository_version_href}repair/

delete

AsyncOperationResponse delete(python_python_repository_version_href, x_task_diagnostics=x_task_diagnostics)

Delete a repository version

Trigger an asynchronous task to delete a repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonVersionsApi(api_client)
    python_python_repository_version_href = 'python_python_repository_version_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        # Delete a repository version
        api_response = api_instance.delete(python_python_repository_version_href, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonVersionsApi->delete:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonVersionsApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_version_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedRepositoryVersionResponseList list(python_python_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)

List repository versions

PythonRepositoryVersion represents a single Python repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.paginated_repository_version_response_list import PaginatedRepositoryVersionResponseList
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonVersionsApi(api_client)
    python_python_repository_href = 'python_python_repository_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    content = 'content_example' # str | Content Unit referenced by HREF/PRN (optional)
    content__in = ['content__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    number = 56 # int | Filter results where number matches value (optional)
    number__gt = 56 # int | Filter results where number is greater than value (optional)
    number__gte = 56 # int | Filter results where number is greater than or equal to value (optional)
    number__lt = 56 # int | Filter results where number is less than value (optional)
    number__lte = 56 # int | Filter results where number is less than or equal to value (optional)
    number__range = [56] # List[int] | Filter results where number is between two comma separated values (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    ordering = ['ordering_example'] # List[str] | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending) (optional)
    prn__in = ['prn__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    pulp_created = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created matches value (optional)
    pulp_created__gt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than value (optional)
    pulp_created__gte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is greater than or equal to value (optional)
    pulp_created__isnull = True # bool | Filter results where pulp_created has a null value (optional)
    pulp_created__lt = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than value (optional)
    pulp_created__lte = '2013-10-20T19:20:30+01:00' # datetime | Filter results where pulp_created is less than or equal to value (optional)
    pulp_created__range = ['2013-10-20T19:20:30+01:00'] # List[datetime] | Filter results where pulp_created is between two comma separated values (optional)
    pulp_href__in = ['pulp_href__in_example'] # List[str] | Multiple values may be separated by commas. (optional)
    q = 'q_example' # str | Filter results by using NOT, AND and OR operations on other filters (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # List repository versions
        api_response = api_instance.list(python_python_repository_href, x_task_diagnostics=x_task_diagnostics, content=content, content__in=content__in, limit=limit, number=number, number__gt=number__gt, number__gte=number__gte, number__lt=number__lt, number__lte=number__lte, number__range=number__range, offset=offset, ordering=ordering, prn__in=prn__in, pulp_created=pulp_created, pulp_created__gt=pulp_created__gt, pulp_created__gte=pulp_created__gte, pulp_created__isnull=pulp_created__isnull, pulp_created__lt=pulp_created__lt, pulp_created__lte=pulp_created__lte, pulp_created__range=pulp_created__range, pulp_href__in=pulp_href__in, q=q, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesPythonVersionsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonVersionsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
content	str	Content Unit referenced by HREF/PRN	[optional]
content__in	List[str]	Multiple values may be separated by commas.	[optional]
limit	int	Number of results to return per page.	[optional]
number	int	Filter results where number matches value	[optional]
number__gt	int	Filter results where number is greater than value	[optional]
number__gte	int	Filter results where number is greater than or equal to value	[optional]
number__lt	int	Filter results where number is less than value	[optional]
number__lte	int	Filter results where number is less than or equal to value	[optional]
number__range	List[int]	Filter results where number is between two comma separated values	[optional]
offset	int	The initial index from which to return the results.	[optional]
ordering	List[str]	Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `content_ids` - Content ids * `-content_ids` - Content ids (descending) * `pk` - Pk * `-pk` - Pk (descending)	[optional]
prn__in	List[str]	Multiple values may be separated by commas.	[optional]
pulp_created	datetime	Filter results where pulp_created matches value	[optional]
pulp_created__gt	datetime	Filter results where pulp_created is greater than value	[optional]
pulp_created__gte	datetime	Filter results where pulp_created is greater than or equal to value	[optional]
pulp_created__isnull	bool	Filter results where pulp_created has a null value	[optional]
pulp_created__lt	datetime	Filter results where pulp_created is less than value	[optional]
pulp_created__lte	datetime	Filter results where pulp_created is less than or equal to value	[optional]
pulp_created__range	List[datetime]	Filter results where pulp_created is between two comma separated values	[optional]
pulp_href__in	List[str]	Multiple values may be separated by commas.	[optional]
q	str	Filter results by using NOT, AND and OR operations on other filters	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

PaginatedRepositoryVersionResponseList

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

RepositoryVersionResponse read(python_python_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)

Inspect a repository version

PythonRepositoryVersion represents a single Python repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.repository_version_response import RepositoryVersionResponse
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonVersionsApi(api_client)
    python_python_repository_version_href = 'python_python_repository_version_href_example' # str | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
    fields = ['fields_example'] # List[str] | A list of fields to include in the response. (optional)
    exclude_fields = ['exclude_fields_example'] # List[str] | A list of fields to exclude from the response. (optional)

    try:
        # Inspect a repository version
        api_response = api_instance.read(python_python_repository_version_href, x_task_diagnostics=x_task_diagnostics, fields=fields, exclude_fields=exclude_fields)
        print("The response of RepositoriesPythonVersionsApi->read:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonVersionsApi->read: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_version_href	str
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]
fields	List[str]	A list of fields to include in the response.	[optional]
exclude_fields	List[str]	A list of fields to exclude from the response.	[optional]

Return type

RepositoryVersionResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

repair

AsyncOperationResponse repair(python_python_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)

Trigger an asynchronous task to repair a repository version.

Example

• OAuth Authentication (json_header_remote_authentication):
• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):

import pulpcore.client.pulp_python
from pulpcore.client.pulp_python.models.async_operation_response import AsyncOperationResponse
from pulpcore.client.pulp_python.models.repair import Repair
from pulpcore.client.pulp_python.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_python.Configuration(
    host = "https://env-ephemeral-lzycvt.apps.crc-eph.r9lp.p1.openshiftapps.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.RepositoriesPythonVersionsApi(api_client)
    python_python_repository_version_href = 'python_python_repository_version_href_example' # str | 
    repair = pulpcore.client.pulp_python.Repair() # Repair | 
    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)

    try:
        api_response = api_instance.repair(python_python_repository_version_href, repair, x_task_diagnostics=x_task_diagnostics)
        print("The response of RepositoriesPythonVersionsApi->repair:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RepositoriesPythonVersionsApi->repair: %s\n" % e)

Parameters

Name	Type	Description	Notes
python_python_repository_version_href	str
repair	Repair
x_task_diagnostics	List[str]	List of profilers to use on tasks.	[optional]

Return type

AsyncOperationResponse

Authorization

json_header_remote_authentication, basicAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
202		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RepositoryAddRemoveContent

Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ref_name attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.

Properties

Name	Type	Description	Notes
add_content_units	List[str]	A list of content units to add to a new repository version. This content is added after remove_content_units are removed.	[optional]
remove_content_units	List[str]	A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added.	[optional]
base_version	str	A repository version whose content will be used as the initial set of content for the new repository version	[optional]

Example

from pulpcore.client.pulp_python.models.repository_add_remove_content import RepositoryAddRemoveContent

# TODO update the JSON string below
json = "{}"
# create an instance of RepositoryAddRemoveContent from a JSON string
repository_add_remove_content_instance = RepositoryAddRemoveContent.from_json(json)
# print the JSON string representation of the object
print(RepositoryAddRemoveContent.to_json())

# convert the object into a dict
repository_add_remove_content_dict = repository_add_remove_content_instance.to_dict()
# create an instance of RepositoryAddRemoveContent from a dict
repository_add_remove_content_from_dict = RepositoryAddRemoveContent.from_dict(repository_add_remove_content_dict)

[Back to Model list] [Back to API list] [Back to README]

RepositorySyncURL

A mixin for validating unknown serializers' fields.

Properties

Name	Type	Description	Notes
remote	str	A remote to sync from. This will override a remote set on repository.	[optional]
mirror	bool	If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only.	[optional] [default to False]

Example

from pulpcore.client.pulp_python.models.repository_sync_url import RepositorySyncURL

# TODO update the JSON string below
json = "{}"
# create an instance of RepositorySyncURL from a JSON string
repository_sync_url_instance = RepositorySyncURL.from_json(json)
# print the JSON string representation of the object
print(RepositorySyncURL.to_json())

# convert the object into a dict
repository_sync_url_dict = repository_sync_url_instance.to_dict()
# create an instance of RepositorySyncURL from a dict
repository_sync_url_from_dict = RepositorySyncURL.from_dict(repository_sync_url_dict)

[Back to Model list] [Back to API list] [Back to README]

RepositoryVersionResponse

Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the 'pulp_href` field. The class provides a default for the ref_name attribute in the ModelSerializers's ``Meta`` class. This ensures that the OpenAPI definitions of plugins are namespaced properly.

Properties

Name	Type	Description	Notes
pulp_href	str		[optional] [readonly]
prn	str	The Pulp Resource Name (PRN).	[optional] [readonly]
pulp_created	datetime	Timestamp of creation.	[optional] [readonly]
pulp_last_updated	datetime	Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.	[optional] [readonly]
number	int		[optional] [readonly]
repository	str		[optional] [readonly]
base_version	str	A repository version whose content was used as the initial set of content for this repository version	[optional]
content_summary	ContentSummaryResponse	Various count summaries of the content in the version and the HREF to view them.	[optional] [readonly]
vuln_report	str		[optional] [readonly]

Example

from pulpcore.client.pulp_python.models.repository_version_response import RepositoryVersionResponse

# TODO update the JSON string below
json = "{}"
# create an instance of RepositoryVersionResponse from a JSON string
repository_version_response_instance = RepositoryVersionResponse.from_json(json)
# print the JSON string representation of the object
print(RepositoryVersionResponse.to_json())

# convert the object into a dict
repository_version_response_dict = repository_version_response_instance.to_dict()
# create an instance of RepositoryVersionResponse from a dict
repository_version_response_from_dict = RepositoryVersionResponse.from_dict(repository_version_response_dict)

[Back to Model list] [Back to API list] [Back to README]

SetLabel

Serializer for synchronously setting a label.

Properties

Name	Type	Description	Notes
key	str
value	str

Example

from pulpcore.client.pulp_python.models.set_label import SetLabel

# TODO update the JSON string below
json = "{}"
# create an instance of SetLabel from a JSON string
set_label_instance = SetLabel.from_json(json)
# print the JSON string representation of the object
print(SetLabel.to_json())

# convert the object into a dict
set_label_dict = set_label_instance.to_dict()
# create an instance of SetLabel from a dict
set_label_from_dict = SetLabel.from_dict(set_label_dict)

[Back to Model list] [Back to API list] [Back to README]

SetLabelResponse

Serializer for synchronously setting a label.

Properties

Name	Type	Description	Notes
key	str
value	str

Example

from pulpcore.client.pulp_python.models.set_label_response import SetLabelResponse

# TODO update the JSON string below
json = "{}"
# create an instance of SetLabelResponse from a JSON string
set_label_response_instance = SetLabelResponse.from_json(json)
# print the JSON string representation of the object
print(SetLabelResponse.to_json())

# convert the object into a dict
set_label_response_dict = set_label_response_instance.to_dict()
# create an instance of SetLabelResponse from a dict
set_label_response_from_dict = SetLabelResponse.from_dict(set_label_response_dict)

[Back to Model list] [Back to API list] [Back to README]

SummaryResponse

A Serializer for summary information of an index.

Properties

Name	Type	Description	Notes
projects	int	Number of Python projects in index
releases	int	Number of Python distribution releases in index
files	int	Number of files for all distributions in index

Example

from pulpcore.client.pulp_python.models.summary_response import SummaryResponse

# TODO update the JSON string below
json = "{}"
# create an instance of SummaryResponse from a JSON string
summary_response_instance = SummaryResponse.from_json(json)
# print the JSON string representation of the object
print(SummaryResponse.to_json())

# convert the object into a dict
summary_response_dict = summary_response_instance.to_dict()
# create an instance of SummaryResponse from a dict
summary_response_from_dict = SummaryResponse.from_dict(summary_response_dict)

[Back to Model list] [Back to API list] [Back to README]

UnsetLabel

Serializer for synchronously UNsetting a label.

Properties

Name	Type	Description	Notes
key	str

Example

from pulpcore.client.pulp_python.models.unset_label import UnsetLabel

# TODO update the JSON string below
json = "{}"
# create an instance of UnsetLabel from a JSON string
unset_label_instance = UnsetLabel.from_json(json)
# print the JSON string representation of the object
print(UnsetLabel.to_json())

# convert the object into a dict
unset_label_dict = unset_label_instance.to_dict()
# create an instance of UnsetLabel from a dict
unset_label_from_dict = UnsetLabel.from_dict(unset_label_dict)

[Back to Model list] [Back to API list] [Back to README]

UnsetLabelResponse

Serializer for synchronously UNsetting a label.

Properties

Name	Type	Description	Notes
key	str
value	str		[optional] [readonly]

Example

from pulpcore.client.pulp_python.models.unset_label_response import UnsetLabelResponse

# TODO update the JSON string below
json = "{}"
# create an instance of UnsetLabelResponse from a JSON string
unset_label_response_instance = UnsetLabelResponse.from_json(json)
# print the JSON string representation of the object
print(UnsetLabelResponse.to_json())

# convert the object into a dict
unset_label_response_dict = unset_label_response_instance.to_dict()
# create an instance of UnsetLabelResponse from a dict
unset_label_response_from_dict = UnsetLabelResponse.from_dict(unset_label_response_dict)

[Back to Model list] [Back to API list] [Back to README]