crc-pulp-service-client 20250819.1__tar.gz

crc_pulp_service_client-20250819.1/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: crc-pulp_service-client
+Version: 20250819.1
+Summary: Pulp 3 API
+Home-page: 
+Author: Pulp Team
+Author-email: pulp-list@redhat.com
+License: GPLv2+
+Keywords: pulp,pulpcore,client,Pulp 3 API
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=1.25.3
+Requires-Dist: python-dateutil<2.10.0,>=2.8.1
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+    Fetch, Upload, Organize, and Distribute Software Packages
+    

crc_pulp_service_client-20250819.1/README.md

@@ -0,0 +1,191 @@
+# crc-pulp_service-client
+Fetch, Upload, Organize, and Distribute Software Packages
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: v3
+- Package version: 20250819.1
+- Generator version: 7.10.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+For more information, please visit [https://pulpproject.org](https://pulpproject.org)
+
+## Requirements.
+
+Python 3.8+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+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:
+```python
+import crc-pulp_service-client
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import crc-pulp_service-client
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import crc-pulp_service-client
+from crc-pulp_service-client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://env-ephemeral-pkrsh0.apps.crc-eph.r9lp.p1.openshiftapps.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = crc-pulp_service-client.Configuration(
+    host = "https://env-ephemeral-pkrsh0.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 = crc-pulp_service-client.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 crc-pulp_service-client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = crc-pulp_service-client.ApiCreateDomainApi(api_client)
+    domain = crc-pulp_service-client.Domain() # Domain | 
+    x_task_diagnostics = ['x_task_diagnostics_example'] # List[str] | List of profilers to use on tasks. (optional)
+
+    try:
+        # Create domain
+        api_response = api_instance.post(domain, x_task_diagnostics=x_task_diagnostics)
+        print("The response of ApiCreateDomainApi->post:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling ApiCreateDomainApi->post: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://env-ephemeral-pkrsh0.apps.crc-eph.r9lp.p1.openshiftapps.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ApiCreateDomainApi* | [**post**](docs/ApiCreateDomainApi.md#post) | **POST** /api/pulp/create-domain/ | Create domain
+*ApiDebugAuthHeaderApi* | [**get**](docs/ApiDebugAuthHeaderApi.md#get) | **GET** /api/pulp/debug_auth_header/ | 
+*ApiTestTasksApi* | [**get**](docs/ApiTestTasksApi.md#get) | **GET** /api/pulp/test/tasks/ | 
+*ContentRpmpackagesApi* | [**create**](docs/ContentRpmpackagesApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/content/rpm/rpmpackages/ | Create a package
+*ContentRpmpackagesApi* | [**list**](docs/ContentRpmpackagesApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/content/rpm/rpmpackages/ | List packages
+*ContentRpmpackagesApi* | [**read**](docs/ContentRpmpackagesApi.md#read) | **GET** {rpm_package_href} | Inspect a package
+*ContentRpmpackagesApi* | [**set_label**](docs/ContentRpmpackagesApi.md#set_label) | **POST** {rpm_package_href}set_label/ | Set a label
+*ContentRpmpackagesApi* | [**unset_label**](docs/ContentRpmpackagesApi.md#unset_label) | **POST** {rpm_package_href}unset_label/ | Unset a label
+*ContentguardsFeatureApi* | [**add_role**](docs/ContentguardsFeatureApi.md#add_role) | **POST** {service_feature_content_guard_href}add_role/ | Add a role
+*ContentguardsFeatureApi* | [**create**](docs/ContentguardsFeatureApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/contentguards/service/feature/ | Create a feature content guard
+*ContentguardsFeatureApi* | [**delete**](docs/ContentguardsFeatureApi.md#delete) | **DELETE** {service_feature_content_guard_href} | Delete a feature content guard
+*ContentguardsFeatureApi* | [**list**](docs/ContentguardsFeatureApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/contentguards/service/feature/ | List feature content guards
+*ContentguardsFeatureApi* | [**list_roles**](docs/ContentguardsFeatureApi.md#list_roles) | **GET** {service_feature_content_guard_href}list_roles/ | List roles
+*ContentguardsFeatureApi* | [**my_permissions**](docs/ContentguardsFeatureApi.md#my_permissions) | **GET** {service_feature_content_guard_href}my_permissions/ | List user permissions
+*ContentguardsFeatureApi* | [**partial_update**](docs/ContentguardsFeatureApi.md#partial_update) | **PATCH** {service_feature_content_guard_href} | Update a feature content guard
+*ContentguardsFeatureApi* | [**read**](docs/ContentguardsFeatureApi.md#read) | **GET** {service_feature_content_guard_href} | Inspect a feature content guard
+*ContentguardsFeatureApi* | [**remove_role**](docs/ContentguardsFeatureApi.md#remove_role) | **POST** {service_feature_content_guard_href}remove_role/ | Remove a role
+*ContentguardsFeatureApi* | [**update**](docs/ContentguardsFeatureApi.md#update) | **PUT** {service_feature_content_guard_href} | Update a feature content guard
+*TasksApi* | [**admin_tasks**](docs/TasksApi.md#admin_tasks) | **GET** /api/pulp/admin/tasks/ | 
+*VulnReportApi* | [**create**](docs/VulnReportApi.md#create) | **POST** /api/pulp/{pulp_domain}/api/v3/vuln_report/ | Generate vulnerability report
+*VulnReportApi* | [**delete**](docs/VulnReportApi.md#delete) | **DELETE** {service_vulnerability_report_href} | Delete a vulnerability report
+*VulnReportApi* | [**list**](docs/VulnReportApi.md#list) | **GET** /api/pulp/{pulp_domain}/api/v3/vuln_report/ | List vulnerability reports
+*VulnReportApi* | [**read**](docs/VulnReportApi.md#read) | **GET** {service_vulnerability_report_href} | Inspect a vulnerability report
+
+
+## Documentation For Models
+
+ - [AsyncOperationResponse](docs/AsyncOperationResponse.md)
+ - [Domain](docs/Domain.md)
+ - [DomainResponse](docs/DomainResponse.md)
+ - [MyPermissionsResponse](docs/MyPermissionsResponse.md)
+ - [NestedRole](docs/NestedRole.md)
+ - [NestedRoleResponse](docs/NestedRoleResponse.md)
+ - [ObjectRolesResponse](docs/ObjectRolesResponse.md)
+ - [PaginatedTaskResponseList](docs/PaginatedTaskResponseList.md)
+ - [PaginatedrpmPackageResponseList](docs/PaginatedrpmPackageResponseList.md)
+ - [PaginatedserviceFeatureContentGuardResponseList](docs/PaginatedserviceFeatureContentGuardResponseList.md)
+ - [PaginatedserviceVulnerabilityReportResponseList](docs/PaginatedserviceVulnerabilityReportResponseList.md)
+ - [PatchedserviceFeatureContentGuard](docs/PatchedserviceFeatureContentGuard.md)
+ - [ProgressReportResponse](docs/ProgressReportResponse.md)
+ - [RpmPackageResponse](docs/RpmPackageResponse.md)
+ - [ServiceFeatureContentGuard](docs/ServiceFeatureContentGuard.md)
+ - [ServiceFeatureContentGuardResponse](docs/ServiceFeatureContentGuardResponse.md)
+ - [ServiceVulnerabilityReportResponse](docs/ServiceVulnerabilityReportResponse.md)
+ - [SetLabel](docs/SetLabel.md)
+ - [SetLabelResponse](docs/SetLabelResponse.md)
+ - [StorageClassEnum](docs/StorageClassEnum.md)
+ - [TaskResponse](docs/TaskResponse.md)
+ - [UnsetLabel](docs/UnsetLabel.md)
+ - [UnsetLabelResponse](docs/UnsetLabelResponse.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="basicAuth"></a>
+### basicAuth
+
+- **Type**: HTTP basic authentication
+
+<a id="cookieAuth"></a>
+### cookieAuth
+
+- **Type**: API key
+- **API key parameter name**: sessionid
+- **Location**: 
+
+<a id="json_header_remote_authentication"></a>
+### json_header_remote_authentication
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+ - **api.console**: grant_access_to_pulp
+
+
+## Author
+
+pulp-list@redhat.com
+
+

crc_pulp_service_client-20250819.1/crc-pulp_service-client/__init__.py

@@ -0,0 +1,2 @@
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)

crc_pulp_service_client-20250819.1/crc-pulp_service-client/api/__init__.py

@@ -0,0 +1,11 @@
+# flake8: noqa
+
+# import apis into api package
+from crc-pulp_service-client.api.api_create_domain_api import ApiCreateDomainApi
+from crc-pulp_service-client.api.api_debug_auth_header_api import ApiDebugAuthHeaderApi
+from crc-pulp_service-client.api.api_test_tasks_api import ApiTestTasksApi
+from crc-pulp_service-client.api.content_rpmpackages_api import ContentRpmpackagesApi
+from crc-pulp_service-client.api.contentguards_feature_api import ContentguardsFeatureApi
+from crc-pulp_service-client.api.tasks_api import TasksApi
+from crc-pulp_service-client.api.vuln_report_api import VulnReportApi
+

crc_pulp_service_client-20250819.1/crc-pulp_service-client/api/api_create_domain_api.py

@@ -0,0 +1,335 @@
+# coding: utf-8
+
+"""
+    Pulp 3 API
+
+    Fetch, Upload, Organize, and Distribute Software Packages
+
+    The version of the OpenAPI document: v3
+    Contact: pulp-list@redhat.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictStr
+from typing import List, Optional
+from typing_extensions import Annotated
+from crc-pulp_service-client.models.domain import Domain
+from crc-pulp_service-client.models.domain_response import DomainResponse
+
+from crc-pulp_service-client.api_client import ApiClient, RequestSerialized
+from crc-pulp_service-client.api_response import ApiResponse
+from crc-pulp_service-client.rest import RESTResponseType
+
+
+class ApiCreateDomainApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def post(
+        self,
+        domain: Domain,
+        x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> DomainResponse:
+        """Create domain
+
+        Create a new domain for from S3 template domain, self-service path
+
+        :param domain: (required)
+        :type domain: Domain
+        :param x_task_diagnostics: List of profilers to use on tasks.
+        :type x_task_diagnostics: List[str]
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_serialize(
+            domain=domain,
+            x_task_diagnostics=x_task_diagnostics,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "DomainResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def post_with_http_info(
+        self,
+        domain: Domain,
+        x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[DomainResponse]:
+        """Create domain
+
+        Create a new domain for from S3 template domain, self-service path
+
+        :param domain: (required)
+        :type domain: Domain
+        :param x_task_diagnostics: List of profilers to use on tasks.
+        :type x_task_diagnostics: List[str]
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_serialize(
+            domain=domain,
+            x_task_diagnostics=x_task_diagnostics,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "DomainResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def post_without_preload_content(
+        self,
+        domain: Domain,
+        x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Create domain
+
+        Create a new domain for from S3 template domain, self-service path
+
+        :param domain: (required)
+        :type domain: Domain
+        :param x_task_diagnostics: List of profilers to use on tasks.
+        :type x_task_diagnostics: List[str]
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._post_serialize(
+            domain=domain,
+            x_task_diagnostics=x_task_diagnostics,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "DomainResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _post_serialize(
+        self,
+        domain,
+        x_task_diagnostics,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+            'X-Task-Diagnostics': 'csv',
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        if x_task_diagnostics is not None:
+            _header_params['X-Task-Diagnostics'] = x_task_diagnostics
+        # process the form parameters
+        # process the body parameter
+        if domain is not None:
+            _body_params = domain
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json', 
+                        'application/x-www-form-urlencoded', 
+                        'multipart/form-data'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'json_header_remote_authentication', 
+            'basicAuth', 
+            'cookieAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/api/pulp/create-domain/',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+