Contents

# PulpPythonClient::PypiApi

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

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'
# setup authorization
PulpPythonClient.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = PulpPythonClient::PypiApi.new
path = 'path_example' # String | 
opts = {
  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
  exclude_fields: ['exclude_fields_example'] # Array<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** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
 **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 

### Return type

[**SummaryResponse**](SummaryResponse.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
pulp_python_client-3.12.6	docs/PypiApi.md
pulp_python_client-3.12.5	docs/PypiApi.md
pulp_python_client-3.12.4	docs/PypiApi.md
pulp_python_client-3.12.3	docs/PypiApi.md
pulp_python_client-3.12.2	docs/PypiApi.md