pulp_python_client 3.3.0 → 3.4.0

data/build/lib/pulpcore/client/pulp_python/rest.py

@@ -0,0 +1,292 @@
+# coding: utf-8
+
+"""
+    Pulp 3 API
+
+    Fetch, Upload, Organize, and Distribute Software Packages  # noqa: E501
+
+    The version of the OpenAPI document: v3
+    Contact: pulp-list@redhat.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import absolute_import
+
+import io
+import json
+import logging
+import re
+import ssl
+
+import certifi
+# python 2 and python 3 compatibility library
+import six
+from six.moves.urllib.parse import urlencode
+import urllib3
+
+from pulpcore.client.pulp_python.exceptions import ApiException, ApiValueError
+
+
+logger = logging.getLogger(__name__)
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp):
+        self.urllib3_response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = resp.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.urllib3_response.getheaders()
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.urllib3_response.getheader(name, default)
+
+
+class RESTClientObject(object):
+
+    def __init__(self, configuration, pools_size=4, maxsize=None):
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # maxsize is the number of requests to host that are allowed in parallel  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        # ca_certs
+        if configuration.ssl_ca_cert:
+            ca_certs = configuration.ssl_ca_cert
+        else:
+            # if not set certificate file, use Mozilla's root certificates.
+            ca_certs = certifi.where()
+
+        addition_pool_args = {}
+        if configuration.assert_hostname is not None:
+            addition_pool_args['assert_hostname'] = configuration.assert_hostname  # noqa: E501
+
+        if configuration.retries is not None:
+            addition_pool_args['retries'] = configuration.retries
+
+        if maxsize is None:
+            if configuration.connection_pool_maxsize is not None:
+                maxsize = configuration.connection_pool_maxsize
+            else:
+                maxsize = 4
+
+        # https pool manager
+        if configuration.proxy:
+            self.pool_manager = urllib3.ProxyManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=ca_certs,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                proxy_url=configuration.proxy,
+                proxy_headers=configuration.proxy_headers,
+                **addition_pool_args
+            )
+        else:
+            self.pool_manager = urllib3.PoolManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=ca_certs,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                **addition_pool_args
+            )
+
+    def request(self, method, url, query_params=None, headers=None,
+                body=None, post_params=None, _preload_content=True,
+                _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param query_params: query parameters in the url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :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.
+        """
+        method = method.upper()
+        assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT',
+                          'PATCH', 'OPTIONS']
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, ) if six.PY3 else (int, long)):  # noqa: E501,F821
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (isinstance(_request_timeout, tuple) and
+                  len(_request_timeout) == 2):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0], read=_request_timeout[1])
+
+        if 'Content-Type' not in headers:
+            headers['Content-Type'] = 'application/json'
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+                if query_params:
+                    url += '?' + urlencode(query_params)
+                if re.search('json', headers['Content-Type'], re.IGNORECASE):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'application/x-www-form-urlencoded':  # noqa: E501
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                # Pass a `string` parameter directly in the body to support
+                # other content types than Json when `body` argument is
+                # provided in serialized form
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    request_body = body
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(method, url,
+                                              fields=query_params,
+                                              preload_content=_preload_content,
+                                              timeout=timeout,
+                                              headers=headers)
+        except urllib3.exceptions.SSLError as e:
+            msg = "{0}\n{1}".format(type(e).__name__, str(e))
+            raise ApiException(status=0, reason=msg)
+
+        if _preload_content:
+            r = RESTResponse(r)
+
+            # log response body
+            logger.debug("response body: %s", r.data)
+
+        if not 200 <= r.status <= 299:
+            raise ApiException(http_resp=r)
+
+        return r
+
+    def GET(self, url, headers=None, query_params=None, _preload_content=True,
+            _request_timeout=None):
+        return self.request("GET", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def HEAD(self, url, headers=None, query_params=None, _preload_content=True,
+             _request_timeout=None):
+        return self.request("HEAD", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def OPTIONS(self, url, headers=None, query_params=None, post_params=None,
+                body=None, _preload_content=True, _request_timeout=None):
+        return self.request("OPTIONS", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def DELETE(self, url, headers=None, query_params=None, body=None,
+               _preload_content=True, _request_timeout=None):
+        return self.request("DELETE", url,
+                            headers=headers,
+                            query_params=query_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def POST(self, url, headers=None, query_params=None, post_params=None,
+             body=None, _preload_content=True, _request_timeout=None):
+        return self.request("POST", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def PUT(self, url, headers=None, query_params=None, post_params=None,
+            body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PUT", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def PATCH(self, url, headers=None, query_params=None, post_params=None,
+              body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PATCH", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)

data/docs/ContentPackagesApi.md

@@ -36,8 +36,10 @@ opts = {
   artifact: 'artifact_example', # String | Artifact file representing the physical content
   file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
   repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
+  sha256: '', # String | The SHA256 digest of this package.
   summary: 'summary_example', # String | A one-line summary of what the package does.
   description: 'description_example', # String | A longer description of the package that can run to several paragraphs.
+  description_content_type: 'description_content_type_example', # String | A string stating the markup syntax (if any) used in the distribution’s description, so that tools can intelligently render the description.
   keywords: 'keywords_example', # String | Additional keywords to be used to assist searching for the package in a larger catalog.
   home_page: 'home_page_example', # String | The URL for the package's home page.
   download_url: 'download_url_example', # String | Legacy field denoting the URL from which this package can be downloaded.
@@ -48,6 +50,7 @@ opts = {
   license: 'license_example', # String | Text indicating the license covering the distribution
   requires_python: 'requires_python_example', # String | The Python version(s) that the distribution is guaranteed to be compatible with.
   project_url: 'project_url_example', # String | A browsable URL for the project and a label for it, separated by a comma.
+  project_urls: nil, # Object | A dictionary of labels and URLs for the project.
   platform: 'platform_example', # String | A comma-separated list of platform specifications, summarizing the operating systems supported by the package.
   supported_platform: 'supported_platform_example', # String | Field to specify the OS and CPU for which the binary package was compiled. 
   requires_dist: nil, # Object | A JSON list containing names of some other distutils project required by this distribution.
@@ -75,8 +78,10 @@ Name | Type | Description  | Notes
  **artifact** | **String**| Artifact file representing the physical content | [optional] 
  **file** | **File**| An uploaded file that may be turned into the artifact of the content unit. | [optional] 
  **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional] 
+ **sha256** | **String**| The SHA256 digest of this package. | [optional] [default to '']
  **summary** | **String**| A one-line summary of what the package does. | [optional] 
  **description** | **String**| A longer description of the package that can run to several paragraphs. | [optional] 
+ **description_content_type** | **String**| A string stating the markup syntax (if any) used in the distribution’s description, so that tools can intelligently render the description. | [optional] 
  **keywords** | **String**| Additional keywords to be used to assist searching for the package in a larger catalog. | [optional] 
  **home_page** | **String**| The URL for the package's home page. | [optional] 
  **download_url** | **String**| Legacy field denoting the URL from which this package can be downloaded. | [optional] 
@@ -87,6 +92,7 @@ Name | Type | Description  | Notes
  **license** | **String**| Text indicating the license covering the distribution | [optional] 
  **requires_python** | **String**| The Python version(s) that the distribution is guaranteed to be compatible with. | [optional] 
  **project_url** | **String**| A browsable URL for the project and a label for it, separated by a comma. | [optional] 
+ **project_urls** | [**Object**](Object.md)| A dictionary of labels and URLs for the project. | [optional] 
  **platform** | **String**| A comma-separated list of platform specifications, summarizing the operating systems supported by the package. | [optional] 
  **supported_platform** | **String**| Field to specify the OS and CPU for which the binary package was compiled.  | [optional] 
  **requires_dist** | [**Object**](Object.md)| A JSON list containing names of some other distutils project required by this distribution. | [optional] 

data/docs/DistributionsPypiApi.md

@@ -125,7 +125,7 @@ Name | Type | Description  | Notes
 
 List python distributions
 
- Pulp Python Distributions are used to distribute Python Publications.  Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is refered to as Python Package Content.
+ 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
 
@@ -263,7 +263,7 @@ Name | Type | Description  | Notes
 
 Inspect a python distribution
 
- Pulp Python Distributions are used to distribute Python Publications.  Pulp Python Distributions should not be confused with \"Python Distribution\" as defined by the Python community. In Pulp usage, Python content is refered to as Python Package Content.
+ 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
 

data/docs/PackageMetadataResponse.md

@@ -0,0 +1,23 @@
+# PulpPythonClient::PackageMetadataResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_serial** | **Integer** | Cache value from last PyPI sync | 
+**info** | [**Object**](.md) | Core metadata of the package | 
+**releases** | [**Object**](.md) | List of all the releases of the package | 
+**urls** | [**Object**](.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PackageMetadataResponse.new(last_serial: null,
+                                 info: null,
+                                 releases: null,
+                                 urls: null)
+```
+
+

data/docs/PackageUpload.md

@@ -0,0 +1,21 @@
+# PulpPythonClient::PackageUpload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **File** | A Python package release file to upload to the index. | 
+**action** | **String** | Defaults to `file_upload`, don't change it or request will fail! | [optional] [default to 'file_upload']
+**sha256_digest** | **String** | SHA256 of package to validate upload integrity. | 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PackageUpload.new(content: null,
+                                 action: null,
+                                 sha256_digest: null)
+```
+
+

data/docs/PackageUploadTaskResponse.md

@@ -0,0 +1,21 @@
+# PulpPythonClient::PackageUploadTaskResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**session** | **String** |  | 
+**task** | **String** |  | 
+**task_start_time** | **DateTime** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpPythonClient'
+
+instance = PulpPythonClient::PackageUploadTaskResponse.new(session: null,
+                                 task: null,
+                                 task_start_time: null)
+```
+
+

data/docs/PatchedpythonPythonDistribution.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] 
 **repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
 **publication** | **String** | Publication to be served | [optional] 
+**allow_uploads** | **Boolean** | Allow packages to be uploaded to this index. | [optional] [default to true]
 
 ## Code Sample
 
@@ -21,7 +22,8 @@ instance = PulpPythonClient::PatchedpythonPythonDistribution.new(base_path: null
                                  pulp_labels: null,
                                  name: null,
                                  repository: null,
-                                 publication: null)
+                                 publication: null,
+                                 allow_uploads: null)
 ```
 
 

data/docs/PatchedpythonPythonRemote.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **password** | **String** | The password to be used for authentication when syncing. | [optional] 
 **pulp_labels** | [**Object**](.md) |  | [optional] 
 **download_concurrency** | **Integer** | Total number of simultaneous connections. | [optional] 
-**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default. | [optional] 
+**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default. | [optional] 
 **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. | [optional] 
 **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. | [optional] 
 **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. | [optional] 

data/docs/PublicationsPypiApi.md

@@ -17,7 +17,7 @@ Method | HTTP request | Description
 
 Create a python publication
 
-Trigger an asynchronous task to publish python content.
+ Dispatches a publish task, which generates metadata that will be used by pip.
 
 ### Example
 

data/docs/PypiApi.md

@@ -0,0 +1,62 @@
+# PulpPythonClient::PypiApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**read**](PypiApi.md#read) | **GET** /pypi/{path}/ | Get index summary
+
+
+
+## read
+
+> SummaryResponse read(path, opts)
+
+Get index summary
+
+Gets package summary stats of index.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+
+api_instance = PulpPythonClient::PypiApi.new
+path = 'path_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Get index summary
+  result = api_instance.read(path, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PypiApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**SummaryResponse**](SummaryResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PypiLegacyApi.md

@@ -0,0 +1,70 @@
+# PulpPythonClient::PypiLegacyApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](PypiLegacyApi.md#create) | **POST** /pypi/{path}/legacy/ | Upload a package
+
+
+
+## create
+
+> PackageUploadTaskResponse create(path, content, sha256_digest, opts)
+
+Upload a package
+
+Upload package to the index.  This is the endpoint that tools like Twine and Poetry use for their upload commands.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+# setup authorization
+PulpPythonClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpPythonClient::PypiLegacyApi.new
+path = 'path_example' # String | 
+content = File.new('/path/to/file') # File | A Python package release file to upload to the index.
+sha256_digest = 'sha256_digest_example' # String | SHA256 of package to validate upload integrity.
+opts = {
+  action: 'file_upload' # String | Defaults to `file_upload`, don't change it or request will fail!
+}
+
+begin
+  #Upload a package
+  result = api_instance.create(path, content, sha256_digest, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PypiLegacyApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**|  | 
+ **content** | **File**| A Python package release file to upload to the index. | 
+ **sha256_digest** | **String**| SHA256 of package to validate upload integrity. | 
+ **action** | **String**| Defaults to `file_upload`, don't change it or request will fail! | [optional] [default to 'file_upload']
+
+### Return type
+
+[**PackageUploadTaskResponse**](PackageUploadTaskResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+

data/docs/PypiMetadataApi.md

@@ -0,0 +1,64 @@
+# PulpPythonClient::PypiMetadataApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**read**](PypiMetadataApi.md#read) | **GET** /pypi/{path}/pypi/{meta}/ | Get package metadata
+
+
+
+## read
+
+> PackageMetadataResponse read(meta, path, opts)
+
+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
+
+```ruby
+# load the gem
+require 'pulp_python_client'
+
+api_instance = PulpPythonClient::PypiMetadataApi.new
+meta = 'meta_example' # String | 
+path = 'path_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Get package metadata
+  result = api_instance.read(meta, path, opts)
+  p result
+rescue PulpPythonClient::ApiError => e
+  puts "Exception when calling PypiMetadataApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **meta** | **String**|  | 
+ **path** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PackageMetadataResponse**](PackageMetadataResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+