Skip to main content

Pulp 3 API

Project description

pulp_rpm-client

Fetch, Upload, Organize, and Distribute Software Packages

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

  • API version: v3
  • Package version: 3.35.1
  • 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_rpm

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_rpm

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pulpcore.client.pulp_rpm
from pulpcore.client.pulp_rpm.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_rpm.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_rpm.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_rpm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_rpm.AcsRpmApi(api_client)
    rpm_rpm_alternate_content_source_href = 'rpm_rpm_alternate_content_source_href_example' # str | 
    nested_role = pulpcore.client.pulp_rpm.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(rpm_rpm_alternate_content_source_href, nested_role, x_task_diagnostics=x_task_diagnostics)
        print("The response of AcsRpmApi->add_role:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AcsRpmApi->add_role: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AcsRpmApi add_role POST {rpm_rpm_alternate_content_source_href}add_role/ Add a role
AcsRpmApi create POST /pulp/api/v3/acs/rpm/rpm/ Create a rpm alternate content source
AcsRpmApi delete DELETE {rpm_rpm_alternate_content_source_href} Delete a rpm alternate content source
AcsRpmApi list GET /pulp/api/v3/acs/rpm/rpm/ List rpm alternate content sources
AcsRpmApi list_roles GET {rpm_rpm_alternate_content_source_href}list_roles/ List roles
AcsRpmApi my_permissions GET {rpm_rpm_alternate_content_source_href}my_permissions/ List user permissions
AcsRpmApi partial_update PATCH {rpm_rpm_alternate_content_source_href} Update a rpm alternate content source
AcsRpmApi read GET {rpm_rpm_alternate_content_source_href} Inspect a rpm alternate content source
AcsRpmApi refresh POST {rpm_rpm_alternate_content_source_href}refresh/
AcsRpmApi remove_role POST {rpm_rpm_alternate_content_source_href}remove_role/ Remove a role
AcsRpmApi update PUT {rpm_rpm_alternate_content_source_href} Update a rpm alternate content source
ContentAdvisoriesApi create POST /pulp/api/v3/content/rpm/advisories/ Create an update record
ContentAdvisoriesApi list GET /pulp/api/v3/content/rpm/advisories/ List update records
ContentAdvisoriesApi read GET {rpm_update_record_href} Inspect an update record
ContentAdvisoriesApi set_label POST {rpm_update_record_href}set_label/ Set a label
ContentAdvisoriesApi unset_label POST {rpm_update_record_href}unset_label/ Unset a label
ContentDistributionTreesApi list GET /pulp/api/v3/content/rpm/distribution_trees/ List distribution trees
ContentDistributionTreesApi read GET {rpm_distribution_tree_href} Inspect a distribution tree
ContentDistributionTreesApi set_label POST {rpm_distribution_tree_href}set_label/ Set a label
ContentDistributionTreesApi unset_label POST {rpm_distribution_tree_href}unset_label/ Unset a label
ContentModulemdDefaultsApi create POST /pulp/api/v3/content/rpm/modulemd_defaults/ Create a modulemd defaults
ContentModulemdDefaultsApi list GET /pulp/api/v3/content/rpm/modulemd_defaults/ List modulemd defaultss
ContentModulemdDefaultsApi read GET {rpm_modulemd_defaults_href} Inspect a modulemd defaults
ContentModulemdDefaultsApi set_label POST {rpm_modulemd_defaults_href}set_label/ Set a label
ContentModulemdDefaultsApi unset_label POST {rpm_modulemd_defaults_href}unset_label/ Unset a label
ContentModulemdObsoletesApi create POST /pulp/api/v3/content/rpm/modulemd_obsoletes/ Create a modulemd obsolete
ContentModulemdObsoletesApi list GET /pulp/api/v3/content/rpm/modulemd_obsoletes/ List modulemd obsoletes
ContentModulemdObsoletesApi read GET {rpm_modulemd_obsolete_href} Inspect a modulemd obsolete
ContentModulemdObsoletesApi set_label POST {rpm_modulemd_obsolete_href}set_label/ Set a label
ContentModulemdObsoletesApi unset_label POST {rpm_modulemd_obsolete_href}unset_label/ Unset a label
ContentModulemdsApi create POST /pulp/api/v3/content/rpm/modulemds/ Create a modulemd
ContentModulemdsApi list GET /pulp/api/v3/content/rpm/modulemds/ List modulemds
ContentModulemdsApi read GET {rpm_modulemd_href} Inspect a modulemd
ContentModulemdsApi set_label POST {rpm_modulemd_href}set_label/ Set a label
ContentModulemdsApi unset_label POST {rpm_modulemd_href}unset_label/ Unset a label
ContentPackagecategoriesApi list GET /pulp/api/v3/content/rpm/packagecategories/ List package categorys
ContentPackagecategoriesApi read GET {rpm_package_category_href} Inspect a package category
ContentPackagecategoriesApi set_label POST {rpm_package_category_href}set_label/ Set a label
ContentPackagecategoriesApi unset_label POST {rpm_package_category_href}unset_label/ Unset a label
ContentPackageenvironmentsApi list GET /pulp/api/v3/content/rpm/packageenvironments/ List package environments
ContentPackageenvironmentsApi read GET {rpm_package_environment_href} Inspect a package environment
ContentPackageenvironmentsApi set_label POST {rpm_package_environment_href}set_label/ Set a label
ContentPackageenvironmentsApi unset_label POST {rpm_package_environment_href}unset_label/ Unset a label
ContentPackagegroupsApi list GET /pulp/api/v3/content/rpm/packagegroups/ List package groups
ContentPackagegroupsApi read GET {rpm_package_group_href} Inspect a package group
ContentPackagegroupsApi set_label POST {rpm_package_group_href}set_label/ Set a label
ContentPackagegroupsApi unset_label POST {rpm_package_group_href}unset_label/ Unset a label
ContentPackagelangpacksApi list GET /pulp/api/v3/content/rpm/packagelangpacks/ List package langpackss
ContentPackagelangpacksApi read GET {rpm_package_langpacks_href} Inspect a package langpacks
ContentPackagelangpacksApi set_label POST {rpm_package_langpacks_href}set_label/ Set a label
ContentPackagelangpacksApi unset_label POST {rpm_package_langpacks_href}unset_label/ Unset a label
ContentPackagesApi create POST /pulp/api/v3/content/rpm/packages/ Create a package
ContentPackagesApi list GET /pulp/api/v3/content/rpm/packages/ List packages
ContentPackagesApi read GET {rpm_package_href} Inspect a package
ContentPackagesApi set_label POST {rpm_package_href}set_label/ Set a label
ContentPackagesApi unset_label POST {rpm_package_href}unset_label/ Unset a label
ContentPackagesApi upload POST /pulp/api/v3/content/rpm/packages/upload/ Upload an RPM package synchronously.
ContentRepoMetadataFilesApi list GET /pulp/api/v3/content/rpm/repo_metadata_files/ List repo metadata files
ContentRepoMetadataFilesApi read GET {rpm_repo_metadata_file_href} Inspect a repo metadata file
ContentRepoMetadataFilesApi set_label POST {rpm_repo_metadata_file_href}set_label/ Set a label
ContentRepoMetadataFilesApi unset_label POST {rpm_repo_metadata_file_href}unset_label/ Unset a label
DistributionsRpmApi add_role POST {rpm_rpm_distribution_href}add_role/ Add a role
DistributionsRpmApi create POST /pulp/api/v3/distributions/rpm/rpm/ Create a rpm distribution
DistributionsRpmApi delete DELETE {rpm_rpm_distribution_href} Delete a rpm distribution
DistributionsRpmApi list GET /pulp/api/v3/distributions/rpm/rpm/ List rpm distributions
DistributionsRpmApi list_roles GET {rpm_rpm_distribution_href}list_roles/ List roles
DistributionsRpmApi my_permissions GET {rpm_rpm_distribution_href}my_permissions/ List user permissions
DistributionsRpmApi partial_update PATCH {rpm_rpm_distribution_href} Update a rpm distribution
DistributionsRpmApi read GET {rpm_rpm_distribution_href} Inspect a rpm distribution
DistributionsRpmApi remove_role POST {rpm_rpm_distribution_href}remove_role/ Remove a role
DistributionsRpmApi set_label POST {rpm_rpm_distribution_href}set_label/ Set a label
DistributionsRpmApi unset_label POST {rpm_rpm_distribution_href}unset_label/ Unset a label
DistributionsRpmApi update PUT {rpm_rpm_distribution_href} Update a rpm distribution
PublicationsRpmApi add_role POST {rpm_rpm_publication_href}add_role/ Add a role
PublicationsRpmApi create POST /pulp/api/v3/publications/rpm/rpm/ Create a rpm publication
PublicationsRpmApi delete DELETE {rpm_rpm_publication_href} Delete a rpm publication
PublicationsRpmApi list GET /pulp/api/v3/publications/rpm/rpm/ List rpm publications
PublicationsRpmApi list_roles GET {rpm_rpm_publication_href}list_roles/ List roles
PublicationsRpmApi my_permissions GET {rpm_rpm_publication_href}my_permissions/ List user permissions
PublicationsRpmApi read GET {rpm_rpm_publication_href} Inspect a rpm publication
PublicationsRpmApi remove_role POST {rpm_rpm_publication_href}remove_role/ Remove a role
RemotesRpmApi add_role POST {rpm_rpm_remote_href}add_role/ Add a role
RemotesRpmApi create POST /pulp/api/v3/remotes/rpm/rpm/ Create a rpm remote
RemotesRpmApi delete DELETE {rpm_rpm_remote_href} Delete a rpm remote
RemotesRpmApi list GET /pulp/api/v3/remotes/rpm/rpm/ List rpm remotes
RemotesRpmApi list_roles GET {rpm_rpm_remote_href}list_roles/ List roles
RemotesRpmApi my_permissions GET {rpm_rpm_remote_href}my_permissions/ List user permissions
RemotesRpmApi partial_update PATCH {rpm_rpm_remote_href} Update a rpm remote
RemotesRpmApi read GET {rpm_rpm_remote_href} Inspect a rpm remote
RemotesRpmApi remove_role POST {rpm_rpm_remote_href}remove_role/ Remove a role
RemotesRpmApi set_label POST {rpm_rpm_remote_href}set_label/ Set a label
RemotesRpmApi unset_label POST {rpm_rpm_remote_href}unset_label/ Unset a label
RemotesRpmApi update PUT {rpm_rpm_remote_href} Update a rpm remote
RemotesUlnApi add_role POST {rpm_uln_remote_href}add_role/ Add a role
RemotesUlnApi create POST /pulp/api/v3/remotes/rpm/uln/ Create an uln remote
RemotesUlnApi delete DELETE {rpm_uln_remote_href} Delete an uln remote
RemotesUlnApi list GET /pulp/api/v3/remotes/rpm/uln/ List uln remotes
RemotesUlnApi list_roles GET {rpm_uln_remote_href}list_roles/ List roles
RemotesUlnApi my_permissions GET {rpm_uln_remote_href}my_permissions/ List user permissions
RemotesUlnApi partial_update PATCH {rpm_uln_remote_href} Update an uln remote
RemotesUlnApi read GET {rpm_uln_remote_href} Inspect an uln remote
RemotesUlnApi remove_role POST {rpm_uln_remote_href}remove_role/ Remove a role
RemotesUlnApi set_label POST {rpm_uln_remote_href}set_label/ Set a label
RemotesUlnApi unset_label POST {rpm_uln_remote_href}unset_label/ Unset a label
RemotesUlnApi update PUT {rpm_uln_remote_href} Update an uln remote
RepositoriesRpmApi add_role POST {rpm_rpm_repository_href}add_role/ Add a role
RepositoriesRpmApi create POST /pulp/api/v3/repositories/rpm/rpm/ Create a rpm repository
RepositoriesRpmApi delete DELETE {rpm_rpm_repository_href} Delete a rpm repository
RepositoriesRpmApi list GET /pulp/api/v3/repositories/rpm/rpm/ List rpm repositorys
RepositoriesRpmApi list_roles GET {rpm_rpm_repository_href}list_roles/ List roles
RepositoriesRpmApi modify POST {rpm_rpm_repository_href}modify/ Modify Repository Content
RepositoriesRpmApi my_permissions GET {rpm_rpm_repository_href}my_permissions/ List user permissions
RepositoriesRpmApi partial_update PATCH {rpm_rpm_repository_href} Update a rpm repository
RepositoriesRpmApi read GET {rpm_rpm_repository_href} Inspect a rpm repository
RepositoriesRpmApi remove_role POST {rpm_rpm_repository_href}remove_role/ Remove a role
RepositoriesRpmApi set_label POST {rpm_rpm_repository_href}set_label/ Set a label
RepositoriesRpmApi sync POST {rpm_rpm_repository_href}sync/ Sync from remote
RepositoriesRpmApi unset_label POST {rpm_rpm_repository_href}unset_label/ Unset a label
RepositoriesRpmApi update PUT {rpm_rpm_repository_href} Update a rpm repository
RepositoriesRpmVersionsApi delete DELETE {rpm_rpm_repository_version_href} Delete a repository version
RepositoriesRpmVersionsApi list GET {rpm_rpm_repository_href}versions/ List repository versions
RepositoriesRpmVersionsApi read GET {rpm_rpm_repository_version_href} Inspect a repository version
RepositoriesRpmVersionsApi repair POST {rpm_rpm_repository_version_href}repair/
RpmCompsApi rpm_comps_upload POST /pulp/api/v3/rpm/comps/ Upload comps.xml
RpmCopyApi copy_content POST /pulp/api/v3/rpm/copy/ Copy content
RpmPruneApi prune_packages POST /pulp/api/v3/rpm/prune/

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

cookieAuth

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

Author

pulp-list@redhat.com

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulp_rpm_client-3.35.1.tar.gz (151.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pulp_rpm_client-3.35.1-py3-none-any.whl (281.5 kB view details)

Uploaded Python 3

File details

Details for the file pulp_rpm_client-3.35.1.tar.gz.

File metadata

  • Download URL: pulp_rpm_client-3.35.1.tar.gz
  • Upload date:
  • Size: 151.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pulp_rpm_client-3.35.1.tar.gz
Algorithm Hash digest
SHA256 a7ee1ceb79f6713bd392ddd4a7750fc2dfbe9485052a6041af3d36c9168ef3ec
MD5 e65dceba057e1f6f8ac1bde631aaf31c
BLAKE2b-256 aabb35c54c7bfc12b061db722f6299dba5cd6f221f9071a296eb4e430d006b6d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pulp_rpm_client-3.35.1.tar.gz:

Publisher: publish.yml on pulp/pulp_rpm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pulp_rpm_client-3.35.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pulp_rpm_client-3.35.1-py3-none-any.whl
Algorithm Hash digest
SHA256 50ad5451be75ee9858b4c0204a34c7abde92070a66c07cdc51d9ae30ce14baf4
MD5 61346ab38c3bd8097961588ae61e3488
BLAKE2b-256 9414abde194324082ff1cce4baa3e3e779680ea7ab637cd496bf8bb6f832cc55

See more details on using hashes here.

Provenance

The following attestation bundles were made for pulp_rpm_client-3.35.1-py3-none-any.whl:

Publisher: publish.yml on pulp/pulp_rpm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page