pulp-gem-client 0.7.5

Pulp 3 API

pulp_gem-client

Fetch, Upload, Organize, and Distribute Software Packages

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

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

Requirements.

Python 3.9+

Installation & Usage

pip install

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

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

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

Then import the package:

import pulpcore.client.pulp_gem

Setuptools

Install via Setuptools.

python setup.py install --user

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

Then import the package:

import pulpcore.client.pulp_gem

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

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

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

# Configure HTTP basic authorization: basicAuth
configuration = pulpcore.client.pulp_gem.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_gem.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_gem.ContentGemApi(api_client)
    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 should be turned into the artifact of the content unit. (optional)

    try:
        # Create a gem content
        api_response = api_instance.create(x_task_diagnostics=x_task_diagnostics, repository=repository, pulp_labels=pulp_labels, artifact=artifact, file=file)
        print("The response of ContentGemApi->create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContentGemApi->create: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ContentGemApi	create	POST /pulp/api/v3/content/gem/gem/	Create a gem content
ContentGemApi	list	GET /pulp/api/v3/content/gem/gem/	List gem contents
ContentGemApi	read	GET {gem_gem_content_href}	Inspect a gem content
ContentGemApi	set_label	POST {gem_gem_content_href}set_label/	Set a label
ContentGemApi	unset_label	POST {gem_gem_content_href}unset_label/	Unset a label
DistributionsGemApi	add_role	POST {gem_gem_distribution_href}add_role/	Add a role
DistributionsGemApi	create	POST /pulp/api/v3/distributions/gem/gem/	Create a gem distribution
DistributionsGemApi	delete	DELETE {gem_gem_distribution_href}	Delete a gem distribution
DistributionsGemApi	list	GET /pulp/api/v3/distributions/gem/gem/	List gem distributions
DistributionsGemApi	list_roles	GET {gem_gem_distribution_href}list_roles/	List roles
DistributionsGemApi	my_permissions	GET {gem_gem_distribution_href}my_permissions/	List user permissions
DistributionsGemApi	partial_update	PATCH {gem_gem_distribution_href}	Update a gem distribution
DistributionsGemApi	read	GET {gem_gem_distribution_href}	Inspect a gem distribution
DistributionsGemApi	remove_role	POST {gem_gem_distribution_href}remove_role/	Remove a role
DistributionsGemApi	set_label	POST {gem_gem_distribution_href}set_label/	Set a label
DistributionsGemApi	unset_label	POST {gem_gem_distribution_href}unset_label/	Unset a label
DistributionsGemApi	update	PUT {gem_gem_distribution_href}	Update a gem distribution
PublicationsGemApi	add_role	POST {gem_gem_publication_href}add_role/	Add a role
PublicationsGemApi	create	POST /pulp/api/v3/publications/gem/gem/	Create a gem publication
PublicationsGemApi	delete	DELETE {gem_gem_publication_href}	Delete a gem publication
PublicationsGemApi	list	GET /pulp/api/v3/publications/gem/gem/	List gem publications
PublicationsGemApi	list_roles	GET {gem_gem_publication_href}list_roles/	List roles
PublicationsGemApi	my_permissions	GET {gem_gem_publication_href}my_permissions/	List user permissions
PublicationsGemApi	read	GET {gem_gem_publication_href}	Inspect a gem publication
PublicationsGemApi	remove_role	POST {gem_gem_publication_href}remove_role/	Remove a role
RemotesGemApi	add_role	POST {gem_gem_remote_href}add_role/	Add a role
RemotesGemApi	create	POST /pulp/api/v3/remotes/gem/gem/	Create a gem remote
RemotesGemApi	delete	DELETE {gem_gem_remote_href}	Delete a gem remote
RemotesGemApi	list	GET /pulp/api/v3/remotes/gem/gem/	List gem remotes
RemotesGemApi	list_roles	GET {gem_gem_remote_href}list_roles/	List roles
RemotesGemApi	my_permissions	GET {gem_gem_remote_href}my_permissions/	List user permissions
RemotesGemApi	partial_update	PATCH {gem_gem_remote_href}	Update a gem remote
RemotesGemApi	read	GET {gem_gem_remote_href}	Inspect a gem remote
RemotesGemApi	remove_role	POST {gem_gem_remote_href}remove_role/	Remove a role
RemotesGemApi	set_label	POST {gem_gem_remote_href}set_label/	Set a label
RemotesGemApi	unset_label	POST {gem_gem_remote_href}unset_label/	Unset a label
RemotesGemApi	update	PUT {gem_gem_remote_href}	Update a gem remote
RepositoriesGemApi	add_role	POST {gem_gem_repository_href}add_role/	Add a role
RepositoriesGemApi	create	POST /pulp/api/v3/repositories/gem/gem/	Create a gem repository
RepositoriesGemApi	delete	DELETE {gem_gem_repository_href}	Delete a gem repository
RepositoriesGemApi	list	GET /pulp/api/v3/repositories/gem/gem/	List gem repositorys
RepositoriesGemApi	list_roles	GET {gem_gem_repository_href}list_roles/	List roles
RepositoriesGemApi	modify	POST {gem_gem_repository_href}modify/	Modify Repository Content
RepositoriesGemApi	my_permissions	GET {gem_gem_repository_href}my_permissions/	List user permissions
RepositoriesGemApi	partial_update	PATCH {gem_gem_repository_href}	Update a gem repository
RepositoriesGemApi	read	GET {gem_gem_repository_href}	Inspect a gem repository
RepositoriesGemApi	remove_role	POST {gem_gem_repository_href}remove_role/	Remove a role
RepositoriesGemApi	set_label	POST {gem_gem_repository_href}set_label/	Set a label
RepositoriesGemApi	sync	POST {gem_gem_repository_href}sync/	Sync from a remote
RepositoriesGemApi	unset_label	POST {gem_gem_repository_href}unset_label/	Unset a label
RepositoriesGemApi	update	PUT {gem_gem_repository_href}	Update a gem repository
RepositoriesGemVersionsApi	delete	DELETE {gem_gem_repository_version_href}	Delete a repository version
RepositoriesGemVersionsApi	list	GET {gem_gem_repository_href}versions/	List repository versions
RepositoriesGemVersionsApi	read	GET {gem_gem_repository_version_href}	Inspect a repository version
RepositoriesGemVersionsApi	repair	POST {gem_gem_repository_version_href}repair/

Documentation For Models

• AsyncOperationResponse
• ContentSummaryResponse
• GemGemContentResponse
• GemGemDistribution
• GemGemDistributionResponse
• GemGemPublication
• GemGemPublicationResponse
• GemGemRemote
• GemGemRemoteResponse
• GemGemRemoteResponseHiddenFieldsInner
• GemGemRepository
• GemGemRepositoryResponse
• MyPermissionsResponse
• NestedRole
• NestedRoleResponse
• ObjectRolesResponse
• PaginatedRepositoryVersionResponseList
• PaginatedgemGemContentResponseList
• PaginatedgemGemDistributionResponseList
• PaginatedgemGemPublicationResponseList
• PaginatedgemGemRemoteResponseList
• PaginatedgemGemRepositoryResponseList
• PatchedgemGemDistribution
• PatchedgemGemRemote
• PatchedgemGemRepository
• PolicyEnum
• Repair
• RepositoryAddRemoveContent
• RepositorySyncURL
• RepositoryVersionResponse
• SetLabel
• SetLabelResponse
• UnsetLabel
• UnsetLabelResponse

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

cookieAuth

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

Author

[e-mail]