# PulpPythonClient::PublicationsPypiApi All URIs are relative to *http://pulp* Method | HTTP request | Description ------------- | ------------- | ------------- [**create**](PublicationsPypiApi.md#create) | **POST** /pulp/api/v3/publications/python/pypi/ | Create a python publication [**delete**](PublicationsPypiApi.md#delete) | **DELETE** {python_python_publication_href} | Delete a python publication [**list**](PublicationsPypiApi.md#list) | **GET** /pulp/api/v3/publications/python/pypi/ | List python publications [**read**](PublicationsPypiApi.md#read) | **GET** {python_python_publication_href} | Inspect a python publication ## create > AsyncOperationResponse create(python_python_publication) Create a python publication Dispatches a publish task, which generates metadata that will be used by pip. ### 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::PublicationsPypiApi.new python_python_publication = PulpPythonClient::PythonPythonPublication.new # PythonPythonPublication | begin #Create a python publication result = api_instance.create(python_python_publication) p result rescue PulpPythonClient::ApiError => e puts "Exception when calling PublicationsPypiApi->create: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **python_python_publication** | [**PythonPythonPublication**](PythonPythonPublication.md)| | ### Return type [**AsyncOperationResponse**](AsyncOperationResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json ## delete > delete(python_python_publication_href) Delete a python publication Python Publications refer to the Python Package content in a repository version, and include metadata about that content. ### 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::PublicationsPypiApi.new python_python_publication_href = 'python_python_publication_href_example' # String | begin #Delete a python publication api_instance.delete(python_python_publication_href) rescue PulpPythonClient::ApiError => e puts "Exception when calling PublicationsPypiApi->delete: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **python_python_publication_href** | **String**| | ### Return type nil (empty response body) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## list > PaginatedpythonPythonPublicationResponseList list(opts) List python publications Python Publications refer to the Python Package content in a repository version, and include metadata about that content. ### 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::PublicationsPypiApi.new opts = { content: 'content_example', # String | Content Unit referenced by HREF content__in: 'content__in_example', # String | Content Unit referenced by HREF limit: 56, # Integer | Number of results to return per page. offset: 56, # Integer | The initial index from which to return the results. ordering: 'ordering_example', # String | Which field to use when ordering the results. pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array | Filter results where pulp_created is between two comma separated values repository_version: 'repository_version_example', # String | Repository Version referenced by HREF 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 #List python publications result = api_instance.list(opts) p result rescue PulpPythonClient::ApiError => e puts "Exception when calling PublicationsPypiApi->list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **content** | **String**| Content Unit referenced by HREF | [optional] **content__in** | **String**| Content Unit referenced by HREF | [optional] **limit** | **Integer**| Number of results to return per page. | [optional] **offset** | **Integer**| The initial index from which to return the results. | [optional] **ordering** | **String**| Which field to use when ordering the results. | [optional] **pulp_created** | **DateTime**| ISO 8601 formatted dates are supported | [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__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** | [**Array<DateTime>**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional] **repository_version** | [**String**](.md)| Repository Version referenced by HREF | [optional] **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 [**PaginatedpythonPythonPublicationResponseList**](PaginatedpythonPythonPublicationResponseList.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## read > PythonPythonPublicationResponse read(python_python_publication_href, opts) Inspect a python publication Python Publications refer to the Python Package content in a repository version, and include metadata about that content. ### 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::PublicationsPypiApi.new python_python_publication_href = 'python_python_publication_href_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 #Inspect a python publication result = api_instance.read(python_python_publication_href, opts) p result rescue PulpPythonClient::ApiError => e puts "Exception when calling PublicationsPypiApi->read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **python_python_publication_href** | **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 [**PythonPythonPublicationResponse**](PythonPythonPublicationResponse.md) ### Authorization [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json