pulp_python_client 3.0.0b9.dev01590786394

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of pulp_python_client might be problematic. Click here for more details.

Files changed (99) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +175 -0
  4. data/Rakefile +10 -0
  5. data/docs/AsyncOperationResponse.md +17 -0
  6. data/docs/ContentPackagesApi.md +262 -0
  7. data/docs/ContentSummary.md +21 -0
  8. data/docs/DistributionsPypiApi.md +364 -0
  9. data/docs/InlineResponse200.md +23 -0
  10. data/docs/InlineResponse2001.md +23 -0
  11. data/docs/InlineResponse2002.md +23 -0
  12. data/docs/InlineResponse2003.md +23 -0
  13. data/docs/InlineResponse2004.md +23 -0
  14. data/docs/InlineResponse2005.md +23 -0
  15. data/docs/ProjectSpecifier.md +19 -0
  16. data/docs/PublicationsPypiApi.md +253 -0
  17. data/docs/PythonPythonDistribution.md +29 -0
  18. data/docs/PythonPythonDistributionRead.md +29 -0
  19. data/docs/PythonPythonPackageContentRead.md +69 -0
  20. data/docs/PythonPythonPublication.md +25 -0
  21. data/docs/PythonPythonPublicationRead.md +25 -0
  22. data/docs/PythonPythonRemote.md +49 -0
  23. data/docs/PythonPythonRemoteRead.md +49 -0
  24. data/docs/PythonPythonRepository.md +27 -0
  25. data/docs/PythonPythonRepositoryRead.md +27 -0
  26. data/docs/RemotesPythonApi.md +368 -0
  27. data/docs/RepositoriesPythonApi.md +468 -0
  28. data/docs/RepositoriesPythonVersionsApi.md +269 -0
  29. data/docs/RepositoryAddRemoveContent.md +21 -0
  30. data/docs/RepositorySyncURL.md +19 -0
  31. data/docs/RepositoryVersion.md +25 -0
  32. data/docs/RepositoryVersionRead.md +25 -0
  33. data/git_push.sh +58 -0
  34. data/lib/pulp_python_client.rb +67 -0
  35. data/lib/pulp_python_client/api/content_packages_api.rb +349 -0
  36. data/lib/pulp_python_client/api/distributions_pypi_api.rb +445 -0
  37. data/lib/pulp_python_client/api/publications_pypi_api.rb +306 -0
  38. data/lib/pulp_python_client/api/remotes_python_api.rb +451 -0
  39. data/lib/pulp_python_client/api/repositories_python_api.rb +573 -0
  40. data/lib/pulp_python_client/api/repositories_python_versions_api.rb +336 -0
  41. data/lib/pulp_python_client/api_client.rb +402 -0
  42. data/lib/pulp_python_client/api_error.rb +57 -0
  43. data/lib/pulp_python_client/configuration.rb +243 -0
  44. data/lib/pulp_python_client/models/async_operation_response.rb +212 -0
  45. data/lib/pulp_python_client/models/content_summary.rb +246 -0
  46. data/lib/pulp_python_client/models/inline_response200.rb +247 -0
  47. data/lib/pulp_python_client/models/inline_response2001.rb +247 -0
  48. data/lib/pulp_python_client/models/inline_response2002.rb +247 -0
  49. data/lib/pulp_python_client/models/inline_response2003.rb +247 -0
  50. data/lib/pulp_python_client/models/inline_response2004.rb +247 -0
  51. data/lib/pulp_python_client/models/inline_response2005.rb +247 -0
  52. data/lib/pulp_python_client/models/project_specifier.rb +242 -0
  53. data/lib/pulp_python_client/models/python_python_distribution.rb +331 -0
  54. data/lib/pulp_python_client/models/python_python_distribution_read.rb +331 -0
  55. data/lib/pulp_python_client/models/python_python_package_content_read.rb +550 -0
  56. data/lib/pulp_python_client/models/python_python_publication.rb +247 -0
  57. data/lib/pulp_python_client/models/python_python_publication_read.rb +247 -0
  58. data/lib/pulp_python_client/models/python_python_remote.rb +565 -0
  59. data/lib/pulp_python_client/models/python_python_remote_read.rb +565 -0
  60. data/lib/pulp_python_client/models/python_python_repository.rb +294 -0
  61. data/lib/pulp_python_client/models/python_python_repository_read.rb +294 -0
  62. data/lib/pulp_python_client/models/repository_add_remove_content.rb +231 -0
  63. data/lib/pulp_python_client/models/repository_sync_url.rb +224 -0
  64. data/lib/pulp_python_client/models/repository_version.rb +244 -0
  65. data/lib/pulp_python_client/models/repository_version_read.rb +244 -0
  66. data/lib/pulp_python_client/version.rb +15 -0
  67. data/pulp_python_client.gemspec +39 -0
  68. data/spec/api/content_packages_api_spec.rb +114 -0
  69. data/spec/api/distributions_pypi_api_spec.rb +121 -0
  70. data/spec/api/publications_pypi_api_spec.rb +96 -0
  71. data/spec/api/remotes_python_api_spec.rb +123 -0
  72. data/spec/api/repositories_python_api_spec.rb +143 -0
  73. data/spec/api/repositories_python_versions_api_spec.rb +103 -0
  74. data/spec/api_client_spec.rb +188 -0
  75. data/spec/configuration_spec.rb +42 -0
  76. data/spec/models/async_operation_response_spec.rb +41 -0
  77. data/spec/models/content_summary_spec.rb +53 -0
  78. data/spec/models/inline_response2001_spec.rb +59 -0
  79. data/spec/models/inline_response2002_spec.rb +59 -0
  80. data/spec/models/inline_response2003_spec.rb +59 -0
  81. data/spec/models/inline_response2004_spec.rb +59 -0
  82. data/spec/models/inline_response2005_spec.rb +59 -0
  83. data/spec/models/inline_response200_spec.rb +59 -0
  84. data/spec/models/project_specifier_spec.rb +47 -0
  85. data/spec/models/python_python_distribution_read_spec.rb +77 -0
  86. data/spec/models/python_python_distribution_spec.rb +77 -0
  87. data/spec/models/python_python_package_content_read_spec.rb +197 -0
  88. data/spec/models/python_python_publication_read_spec.rb +65 -0
  89. data/spec/models/python_python_publication_spec.rb +65 -0
  90. data/spec/models/python_python_remote_read_spec.rb +141 -0
  91. data/spec/models/python_python_remote_spec.rb +141 -0
  92. data/spec/models/python_python_repository_read_spec.rb +71 -0
  93. data/spec/models/python_python_repository_spec.rb +71 -0
  94. data/spec/models/repository_add_remove_content_spec.rb +53 -0
  95. data/spec/models/repository_sync_url_spec.rb +47 -0
  96. data/spec/models/repository_version_read_spec.rb +65 -0
  97. data/spec/models/repository_version_spec.rb +65 -0
  98. data/spec/spec_helper.rb +111 -0
  99. metadata +225 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 6393445dfeb114e6a7853768daf77251572c3fbf0d1ced3853484b957d9147dd
4
+ data.tar.gz: bebaa31d0805b62100686b5dc6b009b6466327bf936fcd6d6eb823d5ab494b8e
5
+ SHA512:
6
+ metadata.gz: 2248342acee75de46799915e8f130c9df35e0db3cacc03c95834893922de58d3b8cba9a366a34a0944c87f6f571470a5244a29125696d3420fbc2958ffbcefb7
7
+ data.tar.gz: 5b79d705d8097c8187d19de3093f45774fab2f189fe487023ae01a9ac2ffc4e7add76cd8f2a07a8b3e26c3d1214aca214b13a49fe7062ee5766cf868bf21123b
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
9
+ end
@@ -0,0 +1,175 @@
1
+ # pulp_python_client
2
+
3
+ PulpPythonClient - the Ruby gem for the Pulp 3 API
4
+
5
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+
7
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
+
9
+ - API version: v3
10
+ - Package version: 3.0.0b9.dev01590786394
11
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build pulp_python_client.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./pulp_python_client-3.0.0b9.dev01590786394.gem
27
+ ```
28
+
29
+ (for development, run `gem install --dev ./pulp_python_client-3.0.0b9.dev01590786394.gem` to install the development dependencies)
30
+
31
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
+
33
+ Finally add this to the Gemfile:
34
+
35
+ gem 'pulp_python_client', '~> 3.0.0b9.dev01590786394'
36
+
37
+ ### Install from Git
38
+
39
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
40
+
41
+ gem 'pulp_python_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
42
+
43
+ ### Include the Ruby code directly
44
+
45
+ Include the Ruby code directly using `-I` as follows:
46
+
47
+ ```shell
48
+ ruby -Ilib script.rb
49
+ ```
50
+
51
+ ## Getting Started
52
+
53
+ Please follow the [installation](#installation) procedure and then run the following code:
54
+
55
+ ```ruby
56
+ # Load the gem
57
+ require 'pulp_python_client'
58
+
59
+ # Setup authorization
60
+ PulpPythonClient.configure do |config|
61
+ # Configure HTTP basic authorization: Basic
62
+ config.username = 'YOUR_USERNAME'
63
+ config.password = 'YOUR_PASSWORD'
64
+ end
65
+
66
+ api_instance = PulpPythonClient::ContentPackagesApi.new
67
+ relative_path = 'relative_path_example' # String | Path where the artifact is located relative to distributions base_path
68
+ filename = 'filename_example' # String | The name of the distribution package, usually of the format: {distribution}-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.{packagetype}
69
+ opts = {
70
+ artifact: 'artifact_example', # String | Artifact file representing the physical content
71
+ file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
72
+ repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
73
+ summary: 'summary_example', # String | A one-line summary of what the package does.
74
+ description: 'description_example', # String | A longer description of the package that can run to several paragraphs.
75
+ keywords: 'keywords_example', # String | Additional keywords to be used to assist searching for the package in a larger catalog.
76
+ home_page: 'home_page_example', # String | The URL for the package's home page.
77
+ download_url: 'download_url_example', # String | Legacy field denoting the URL from which this package can be downloaded.
78
+ author: 'author_example', # String | Text containing the author's name. Contact information can also be added, separated with newlines.
79
+ author_email: 'author_email_example', # String | The author's e-mail address.
80
+ maintainer: 'maintainer_example', # String | The maintainer's name at a minimum; additional contact information may be provided.
81
+ maintainer_email: 'maintainer_email_example', # String | The maintainer's e-mail address.
82
+ license: 'license_example', # String | Text indicating the license covering the distribution
83
+ requires_python: 'requires_python_example', # String | The Python version(s) that the distribution is guaranteed to be compatible with.
84
+ project_url: 'project_url_example', # String | A browsable URL for the project and a label for it, separated by a comma.
85
+ platform: 'platform_example', # String | A comma-separated list of platform specifications, summarizing the operating systems supported by the package.
86
+ supported_platform: 'supported_platform_example', # String | Field to specify the OS and CPU for which the binary package was compiled.
87
+ requires_dist: 'requires_dist_example', # String | A JSON list containing names of some other distutils project required by this distribution.
88
+ provides_dist: 'provides_dist_example', # String | A JSON list containing names of a Distutils project which is contained within this distribution.
89
+ obsoletes_dist: 'obsoletes_dist_example', # String | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.
90
+ requires_external: 'requires_external_example', # String | A JSON list containing some dependency in the system that the distribution is to be used.
91
+ classifiers: 'classifiers_example' # String | A JSON list containing classification values for a Python package.
92
+ }
93
+
94
+ begin
95
+ #Create a python package content
96
+ result = api_instance.create(relative_path, filename, opts)
97
+ p result
98
+ rescue PulpPythonClient::ApiError => e
99
+ puts "Exception when calling ContentPackagesApi->create: #{e}"
100
+ end
101
+
102
+ ```
103
+
104
+ ## Documentation for API Endpoints
105
+
106
+ All URIs are relative to *http://pulp*
107
+
108
+ Class | Method | HTTP request | Description
109
+ ------------ | ------------- | ------------- | -------------
110
+ *PulpPythonClient::ContentPackagesApi* | [**create**](docs/ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/python/packages/ | Create a python package content
111
+ *PulpPythonClient::ContentPackagesApi* | [**list**](docs/ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/python/packages/ | List python package contents
112
+ *PulpPythonClient::ContentPackagesApi* | [**read**](docs/ContentPackagesApi.md#read) | **GET** {python_package_content_href} | Inspect a python package content
113
+ *PulpPythonClient::DistributionsPypiApi* | [**create**](docs/DistributionsPypiApi.md#create) | **POST** /pulp/api/v3/distributions/python/pypi/ | Create a python distribution
114
+ *PulpPythonClient::DistributionsPypiApi* | [**delete**](docs/DistributionsPypiApi.md#delete) | **DELETE** {python_distribution_href} | Delete a python distribution
115
+ *PulpPythonClient::DistributionsPypiApi* | [**list**](docs/DistributionsPypiApi.md#list) | **GET** /pulp/api/v3/distributions/python/pypi/ | List python distributions
116
+ *PulpPythonClient::DistributionsPypiApi* | [**partial_update**](docs/DistributionsPypiApi.md#partial_update) | **PATCH** {python_distribution_href} | Partially update a python distribution
117
+ *PulpPythonClient::DistributionsPypiApi* | [**read**](docs/DistributionsPypiApi.md#read) | **GET** {python_distribution_href} | Inspect a python distribution
118
+ *PulpPythonClient::DistributionsPypiApi* | [**update**](docs/DistributionsPypiApi.md#update) | **PUT** {python_distribution_href} | Update a python distribution
119
+ *PulpPythonClient::PublicationsPypiApi* | [**create**](docs/PublicationsPypiApi.md#create) | **POST** /pulp/api/v3/publications/python/pypi/ | Create a python publication
120
+ *PulpPythonClient::PublicationsPypiApi* | [**delete**](docs/PublicationsPypiApi.md#delete) | **DELETE** {python_publication_href} | Delete a python publication
121
+ *PulpPythonClient::PublicationsPypiApi* | [**list**](docs/PublicationsPypiApi.md#list) | **GET** /pulp/api/v3/publications/python/pypi/ | List python publications
122
+ *PulpPythonClient::PublicationsPypiApi* | [**read**](docs/PublicationsPypiApi.md#read) | **GET** {python_publication_href} | Inspect a python publication
123
+ *PulpPythonClient::RemotesPythonApi* | [**create**](docs/RemotesPythonApi.md#create) | **POST** /pulp/api/v3/remotes/python/python/ | Create a python remote
124
+ *PulpPythonClient::RemotesPythonApi* | [**delete**](docs/RemotesPythonApi.md#delete) | **DELETE** {python_remote_href} | Delete a python remote
125
+ *PulpPythonClient::RemotesPythonApi* | [**list**](docs/RemotesPythonApi.md#list) | **GET** /pulp/api/v3/remotes/python/python/ | List python remotes
126
+ *PulpPythonClient::RemotesPythonApi* | [**partial_update**](docs/RemotesPythonApi.md#partial_update) | **PATCH** {python_remote_href} | Partially update a python remote
127
+ *PulpPythonClient::RemotesPythonApi* | [**read**](docs/RemotesPythonApi.md#read) | **GET** {python_remote_href} | Inspect a python remote
128
+ *PulpPythonClient::RemotesPythonApi* | [**update**](docs/RemotesPythonApi.md#update) | **PUT** {python_remote_href} | Update a python remote
129
+ *PulpPythonClient::RepositoriesPythonApi* | [**create**](docs/RepositoriesPythonApi.md#create) | **POST** /pulp/api/v3/repositories/python/python/ | Create a python repository
130
+ *PulpPythonClient::RepositoriesPythonApi* | [**delete**](docs/RepositoriesPythonApi.md#delete) | **DELETE** {python_repository_href} | Delete a python repository
131
+ *PulpPythonClient::RepositoriesPythonApi* | [**list**](docs/RepositoriesPythonApi.md#list) | **GET** /pulp/api/v3/repositories/python/python/ | List python repositorys
132
+ *PulpPythonClient::RepositoriesPythonApi* | [**modify**](docs/RepositoriesPythonApi.md#modify) | **POST** {python_repository_href}modify/ | Modify Repository Content
133
+ *PulpPythonClient::RepositoriesPythonApi* | [**partial_update**](docs/RepositoriesPythonApi.md#partial_update) | **PATCH** {python_repository_href} | Partially update a python repository
134
+ *PulpPythonClient::RepositoriesPythonApi* | [**read**](docs/RepositoriesPythonApi.md#read) | **GET** {python_repository_href} | Inspect a python repository
135
+ *PulpPythonClient::RepositoriesPythonApi* | [**sync**](docs/RepositoriesPythonApi.md#sync) | **POST** {python_repository_href}sync/ | Sync from remote
136
+ *PulpPythonClient::RepositoriesPythonApi* | [**update**](docs/RepositoriesPythonApi.md#update) | **PUT** {python_repository_href} | Update a python repository
137
+ *PulpPythonClient::RepositoriesPythonVersionsApi* | [**delete**](docs/RepositoriesPythonVersionsApi.md#delete) | **DELETE** {python_repository_version_href} | Delete a repository version
138
+ *PulpPythonClient::RepositoriesPythonVersionsApi* | [**list**](docs/RepositoriesPythonVersionsApi.md#list) | **GET** {python_repository_href}versions/ | List repository versions
139
+ *PulpPythonClient::RepositoriesPythonVersionsApi* | [**read**](docs/RepositoriesPythonVersionsApi.md#read) | **GET** {python_repository_version_href} | Inspect a repository version
140
+ *PulpPythonClient::RepositoriesPythonVersionsApi* | [**repair**](docs/RepositoriesPythonVersionsApi.md#repair) | **POST** {python_repository_version_href}repair/ |
141
+
142
+
143
+ ## Documentation for Models
144
+
145
+ - [PulpPythonClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
146
+ - [PulpPythonClient::ContentSummary](docs/ContentSummary.md)
147
+ - [PulpPythonClient::InlineResponse200](docs/InlineResponse200.md)
148
+ - [PulpPythonClient::InlineResponse2001](docs/InlineResponse2001.md)
149
+ - [PulpPythonClient::InlineResponse2002](docs/InlineResponse2002.md)
150
+ - [PulpPythonClient::InlineResponse2003](docs/InlineResponse2003.md)
151
+ - [PulpPythonClient::InlineResponse2004](docs/InlineResponse2004.md)
152
+ - [PulpPythonClient::InlineResponse2005](docs/InlineResponse2005.md)
153
+ - [PulpPythonClient::ProjectSpecifier](docs/ProjectSpecifier.md)
154
+ - [PulpPythonClient::PythonPythonDistribution](docs/PythonPythonDistribution.md)
155
+ - [PulpPythonClient::PythonPythonDistributionRead](docs/PythonPythonDistributionRead.md)
156
+ - [PulpPythonClient::PythonPythonPackageContentRead](docs/PythonPythonPackageContentRead.md)
157
+ - [PulpPythonClient::PythonPythonPublication](docs/PythonPythonPublication.md)
158
+ - [PulpPythonClient::PythonPythonPublicationRead](docs/PythonPythonPublicationRead.md)
159
+ - [PulpPythonClient::PythonPythonRemote](docs/PythonPythonRemote.md)
160
+ - [PulpPythonClient::PythonPythonRemoteRead](docs/PythonPythonRemoteRead.md)
161
+ - [PulpPythonClient::PythonPythonRepository](docs/PythonPythonRepository.md)
162
+ - [PulpPythonClient::PythonPythonRepositoryRead](docs/PythonPythonRepositoryRead.md)
163
+ - [PulpPythonClient::RepositoryAddRemoveContent](docs/RepositoryAddRemoveContent.md)
164
+ - [PulpPythonClient::RepositorySyncURL](docs/RepositorySyncURL.md)
165
+ - [PulpPythonClient::RepositoryVersion](docs/RepositoryVersion.md)
166
+ - [PulpPythonClient::RepositoryVersionRead](docs/RepositoryVersionRead.md)
167
+
168
+
169
+ ## Documentation for Authorization
170
+
171
+
172
+ ### Basic
173
+
174
+ - **Type**: HTTP basic authentication
175
+
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ begin
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ task default: :spec
8
+ rescue LoadError
9
+ # no rspec available
10
+ end
@@ -0,0 +1,17 @@
1
+ # PulpPythonClient::AsyncOperationResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **task** | **String** | The href of the task. |
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'PulpPythonClient'
13
+
14
+ instance = PulpPythonClient::AsyncOperationResponse.new(task: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,262 @@
1
+ # PulpPythonClient::ContentPackagesApi
2
+
3
+ All URIs are relative to *http://pulp*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create**](ContentPackagesApi.md#create) | **POST** /pulp/api/v3/content/python/packages/ | Create a python package content
8
+ [**list**](ContentPackagesApi.md#list) | **GET** /pulp/api/v3/content/python/packages/ | List python package contents
9
+ [**read**](ContentPackagesApi.md#read) | **GET** {python_package_content_href} | Inspect a python package content
10
+
11
+
12
+
13
+ ## create
14
+
15
+ > AsyncOperationResponse create(relative_path, filename, opts)
16
+
17
+ Create a python package content
18
+
19
+ Trigger an asynchronous task to create content,optionally create new repository version.
20
+
21
+ ### Example
22
+
23
+ ```ruby
24
+ # load the gem
25
+ require 'pulp_python_client'
26
+ # setup authorization
27
+ PulpPythonClient.configure do |config|
28
+ # Configure HTTP basic authorization: Basic
29
+ config.username = 'YOUR USERNAME'
30
+ config.password = 'YOUR PASSWORD'
31
+ end
32
+
33
+ api_instance = PulpPythonClient::ContentPackagesApi.new
34
+ relative_path = 'relative_path_example' # String | Path where the artifact is located relative to distributions base_path
35
+ filename = 'filename_example' # String | The name of the distribution package, usually of the format: {distribution}-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.{packagetype}
36
+ opts = {
37
+ artifact: 'artifact_example', # String | Artifact file representing the physical content
38
+ file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
39
+ repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
40
+ summary: 'summary_example', # String | A one-line summary of what the package does.
41
+ description: 'description_example', # String | A longer description of the package that can run to several paragraphs.
42
+ keywords: 'keywords_example', # String | Additional keywords to be used to assist searching for the package in a larger catalog.
43
+ home_page: 'home_page_example', # String | The URL for the package's home page.
44
+ download_url: 'download_url_example', # String | Legacy field denoting the URL from which this package can be downloaded.
45
+ author: 'author_example', # String | Text containing the author's name. Contact information can also be added, separated with newlines.
46
+ author_email: 'author_email_example', # String | The author's e-mail address.
47
+ maintainer: 'maintainer_example', # String | The maintainer's name at a minimum; additional contact information may be provided.
48
+ maintainer_email: 'maintainer_email_example', # String | The maintainer's e-mail address.
49
+ license: 'license_example', # String | Text indicating the license covering the distribution
50
+ requires_python: 'requires_python_example', # String | The Python version(s) that the distribution is guaranteed to be compatible with.
51
+ project_url: 'project_url_example', # String | A browsable URL for the project and a label for it, separated by a comma.
52
+ platform: 'platform_example', # String | A comma-separated list of platform specifications, summarizing the operating systems supported by the package.
53
+ supported_platform: 'supported_platform_example', # String | Field to specify the OS and CPU for which the binary package was compiled.
54
+ requires_dist: 'requires_dist_example', # String | A JSON list containing names of some other distutils project required by this distribution.
55
+ provides_dist: 'provides_dist_example', # String | A JSON list containing names of a Distutils project which is contained within this distribution.
56
+ obsoletes_dist: 'obsoletes_dist_example', # String | A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time.
57
+ requires_external: 'requires_external_example', # String | A JSON list containing some dependency in the system that the distribution is to be used.
58
+ classifiers: 'classifiers_example' # String | A JSON list containing classification values for a Python package.
59
+ }
60
+
61
+ begin
62
+ #Create a python package content
63
+ result = api_instance.create(relative_path, filename, opts)
64
+ p result
65
+ rescue PulpPythonClient::ApiError => e
66
+ puts "Exception when calling ContentPackagesApi->create: #{e}"
67
+ end
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+
73
+ Name | Type | Description | Notes
74
+ ------------- | ------------- | ------------- | -------------
75
+ **relative_path** | **String**| Path where the artifact is located relative to distributions base_path |
76
+ **filename** | **String**| The name of the distribution package, usually of the format: {distribution}-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.{packagetype} |
77
+ **artifact** | **String**| Artifact file representing the physical content | [optional]
78
+ **file** | **File**| An uploaded file that may be turned into the artifact of the content unit. | [optional]
79
+ **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional]
80
+ **summary** | **String**| A one-line summary of what the package does. | [optional]
81
+ **description** | **String**| A longer description of the package that can run to several paragraphs. | [optional]
82
+ **keywords** | **String**| Additional keywords to be used to assist searching for the package in a larger catalog. | [optional]
83
+ **home_page** | **String**| The URL for the package's home page. | [optional]
84
+ **download_url** | **String**| Legacy field denoting the URL from which this package can be downloaded. | [optional]
85
+ **author** | **String**| Text containing the author's name. Contact information can also be added, separated with newlines. | [optional]
86
+ **author_email** | **String**| The author's e-mail address. | [optional]
87
+ **maintainer** | **String**| The maintainer's name at a minimum; additional contact information may be provided. | [optional]
88
+ **maintainer_email** | **String**| The maintainer's e-mail address. | [optional]
89
+ **license** | **String**| Text indicating the license covering the distribution | [optional]
90
+ **requires_python** | **String**| The Python version(s) that the distribution is guaranteed to be compatible with. | [optional]
91
+ **project_url** | **String**| A browsable URL for the project and a label for it, separated by a comma. | [optional]
92
+ **platform** | **String**| A comma-separated list of platform specifications, summarizing the operating systems supported by the package. | [optional]
93
+ **supported_platform** | **String**| Field to specify the OS and CPU for which the binary package was compiled. | [optional]
94
+ **requires_dist** | **String**| A JSON list containing names of some other distutils project required by this distribution. | [optional]
95
+ **provides_dist** | **String**| A JSON list containing names of a Distutils project which is contained within this distribution. | [optional]
96
+ **obsoletes_dist** | **String**| A JSON list containing names of a distutils project's distribution which this distribution renders obsolete, meaning that the two projects should not be installed at the same time. | [optional]
97
+ **requires_external** | **String**| A JSON list containing some dependency in the system that the distribution is to be used. | [optional]
98
+ **classifiers** | **String**| A JSON list containing classification values for a Python package. | [optional]
99
+
100
+ ### Return type
101
+
102
+ [**AsyncOperationResponse**](AsyncOperationResponse.md)
103
+
104
+ ### Authorization
105
+
106
+ [Basic](../README.md#Basic)
107
+
108
+ ### HTTP request headers
109
+
110
+ - **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
111
+ - **Accept**: application/json
112
+
113
+
114
+ ## list
115
+
116
+ > InlineResponse200 list(opts)
117
+
118
+ List python package contents
119
+
120
+ PythonPackageContent represents each individually installable Python package. In the Python ecosystem, this is called a Python Distribution, sometimes (ambiguously) refered to as a package. In Pulp Python, we refer to it as PythonPackageContent. Each PythonPackageContent corresponds to a single filename, for example `pulpcore-3.0.0rc1-py3-none-any.whl` or `pulpcore-3.0.0rc1.tar.gz`.
121
+
122
+ ### Example
123
+
124
+ ```ruby
125
+ # load the gem
126
+ require 'pulp_python_client'
127
+ # setup authorization
128
+ PulpPythonClient.configure do |config|
129
+ # Configure HTTP basic authorization: Basic
130
+ config.username = 'YOUR USERNAME'
131
+ config.password = 'YOUR PASSWORD'
132
+ end
133
+
134
+ api_instance = PulpPythonClient::ContentPackagesApi.new
135
+ opts = {
136
+ ordering: 'ordering_example', # String | Which field to use when ordering the results.
137
+ name: 'name_example', # String | Filter results where name matches value
138
+ name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
139
+ author: 'author_example', # String | Filter results where author matches value
140
+ author__in: 'author__in_example', # String | Filter results where author is in a comma-separated list of values
141
+ packagetype: 'packagetype_example', # String | Filter results where packagetype matches value
142
+ packagetype__in: 'packagetype__in_example', # String | Filter results where packagetype is in a comma-separated list of values
143
+ filename: 'filename_example', # String | Filter results where filename matches value
144
+ filename__in: 'filename__in_example', # String | Filter results where filename is in a comma-separated list of values
145
+ filename__contains: 'filename__contains_example', # String | Filter results where filename contains value
146
+ keywords__in: 'keywords__in_example', # String | Filter results where keywords is in a comma-separated list of values
147
+ keywords__contains: 'keywords__contains_example', # String | Filter results where keywords contains value
148
+ repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
149
+ repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
150
+ repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
151
+ limit: 56, # Integer | Number of results to return per page.
152
+ offset: 56, # Integer | The initial index from which to return the results.
153
+ fields: 'fields_example', # String | A list of fields to include in the response.
154
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
155
+ }
156
+
157
+ begin
158
+ #List python package contents
159
+ result = api_instance.list(opts)
160
+ p result
161
+ rescue PulpPythonClient::ApiError => e
162
+ puts "Exception when calling ContentPackagesApi->list: #{e}"
163
+ end
164
+ ```
165
+
166
+ ### Parameters
167
+
168
+
169
+ Name | Type | Description | Notes
170
+ ------------- | ------------- | ------------- | -------------
171
+ **ordering** | **String**| Which field to use when ordering the results. | [optional]
172
+ **name** | **String**| Filter results where name matches value | [optional]
173
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional]
174
+ **author** | **String**| Filter results where author matches value | [optional]
175
+ **author__in** | **String**| Filter results where author is in a comma-separated list of values | [optional]
176
+ **packagetype** | **String**| Filter results where packagetype matches value | [optional]
177
+ **packagetype__in** | **String**| Filter results where packagetype is in a comma-separated list of values | [optional]
178
+ **filename** | **String**| Filter results where filename matches value | [optional]
179
+ **filename__in** | **String**| Filter results where filename is in a comma-separated list of values | [optional]
180
+ **filename__contains** | **String**| Filter results where filename contains value | [optional]
181
+ **keywords__in** | **String**| Filter results where keywords is in a comma-separated list of values | [optional]
182
+ **keywords__contains** | **String**| Filter results where keywords contains value | [optional]
183
+ **repository_version** | **String**| Repository Version referenced by HREF | [optional]
184
+ **repository_version_added** | **String**| Repository Version referenced by HREF | [optional]
185
+ **repository_version_removed** | **String**| Repository Version referenced by HREF | [optional]
186
+ **limit** | **Integer**| Number of results to return per page. | [optional]
187
+ **offset** | **Integer**| The initial index from which to return the results. | [optional]
188
+ **fields** | **String**| A list of fields to include in the response. | [optional]
189
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
190
+
191
+ ### Return type
192
+
193
+ [**InlineResponse200**](InlineResponse200.md)
194
+
195
+ ### Authorization
196
+
197
+ [Basic](../README.md#Basic)
198
+
199
+ ### HTTP request headers
200
+
201
+ - **Content-Type**: Not defined
202
+ - **Accept**: application/json
203
+
204
+
205
+ ## read
206
+
207
+ > PythonPythonPackageContentRead read(python_package_content_href, opts)
208
+
209
+ Inspect a python package content
210
+
211
+ PythonPackageContent represents each individually installable Python package. In the Python ecosystem, this is called a Python Distribution, sometimes (ambiguously) refered to as a package. In Pulp Python, we refer to it as PythonPackageContent. Each PythonPackageContent corresponds to a single filename, for example `pulpcore-3.0.0rc1-py3-none-any.whl` or `pulpcore-3.0.0rc1.tar.gz`.
212
+
213
+ ### Example
214
+
215
+ ```ruby
216
+ # load the gem
217
+ require 'pulp_python_client'
218
+ # setup authorization
219
+ PulpPythonClient.configure do |config|
220
+ # Configure HTTP basic authorization: Basic
221
+ config.username = 'YOUR USERNAME'
222
+ config.password = 'YOUR PASSWORD'
223
+ end
224
+
225
+ api_instance = PulpPythonClient::ContentPackagesApi.new
226
+ python_package_content_href = 'python_package_content_href_example' # String | URI of Python Package Content. e.g.: /pulp/api/v3/content/python/packages/1/
227
+ opts = {
228
+ fields: 'fields_example', # String | A list of fields to include in the response.
229
+ exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
230
+ }
231
+
232
+ begin
233
+ #Inspect a python package content
234
+ result = api_instance.read(python_package_content_href, opts)
235
+ p result
236
+ rescue PulpPythonClient::ApiError => e
237
+ puts "Exception when calling ContentPackagesApi->read: #{e}"
238
+ end
239
+ ```
240
+
241
+ ### Parameters
242
+
243
+
244
+ Name | Type | Description | Notes
245
+ ------------- | ------------- | ------------- | -------------
246
+ **python_package_content_href** | **String**| URI of Python Package Content. e.g.: /pulp/api/v3/content/python/packages/1/ |
247
+ **fields** | **String**| A list of fields to include in the response. | [optional]
248
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional]
249
+
250
+ ### Return type
251
+
252
+ [**PythonPythonPackageContentRead**](PythonPythonPackageContentRead.md)
253
+
254
+ ### Authorization
255
+
256
+ [Basic](../README.md#Basic)
257
+
258
+ ### HTTP request headers
259
+
260
+ - **Content-Type**: Not defined
261
+ - **Accept**: application/json
262
+