apiverve-cuidgenerator 1.2.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2026 APIVerve and EvlarSoft LLC
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,295 @@
1
+ Metadata-Version: 2.4
2
+ Name: apiverve-cuidgenerator
3
+ Version: 1.2.3
4
+ Summary: Cuid Generator creates collision-resistant unique identifiers (CUIDs) on demand for distributed applications. Pass an optional count to receive an array of unique ID strings, with paid plans adding structural format and sortability details.
5
+ Author-email: APIVerve <hello@apiverve.com>
6
+ License: MIT
7
+ Project-URL: Homepage, https://apiverve.com/marketplace/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=homepage
8
+ Project-URL: Documentation, https://docs.apiverve.com/ref/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=docs
9
+ Project-URL: Repository, https://github.com/apiverve/cuidgenerator-api
10
+ Project-URL: Twitter, https://twitter.com/apivervehq
11
+ Keywords: cuid,cuid generator,collision resistant id,unique identifier,sortable id
12
+ Classifier: Development Status :: 5 - Production/Stable
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Topic :: Internet :: WWW/HTTP
17
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
18
+ Classifier: Natural Language :: English
19
+ Requires-Python: >=3.9
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Requires-Dist: requests>=2.25.0
23
+ Dynamic: license-file
24
+
25
+ Cuid Generator API
26
+ ============
27
+
28
+ Cuid Generator creates collision-resistant unique identifiers (CUIDs) on demand for distributed applications. Pass an optional count to receive an array of unique ID strings, with paid plans adding structural format and sortability details.
29
+
30
+
31
+ [![PyPI version](https://img.shields.io/pypi/v/apiverve-cuidgenerator.svg)](https://pypi.org/project/apiverve-cuidgenerator/)
32
+
33
+ This is a Python wrapper for the [Cuid Generator API](https://apiverve.com/marketplace/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=readme)
34
+
35
+ ---
36
+
37
+ ## Installation
38
+
39
+ Using `pip`:
40
+
41
+ ```bash
42
+ pip install apiverve-cuidgenerator
43
+ ```
44
+
45
+ Using `pip3`:
46
+
47
+ ```bash
48
+ pip3 install apiverve-cuidgenerator
49
+ ```
50
+
51
+ ---
52
+
53
+ ## Configuration
54
+
55
+ Before using the Cuid Generator API client, you have to setup your account and obtain your API Key.
56
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=pypi&utm_medium=referral&utm_content=readme)
57
+
58
+ ---
59
+
60
+ ## Quick Start
61
+
62
+ Here's a simple example to get you started quickly:
63
+
64
+ ```python
65
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
66
+
67
+ # Initialize the client with your APIVerve API key
68
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
69
+
70
+ query = { "count": 1 }
71
+
72
+ try:
73
+ # Make the API call
74
+ result = api.execute(query)
75
+
76
+ # Print the result
77
+ print(result)
78
+ except Exception as e:
79
+ print(f"Error: {e}")
80
+ ```
81
+
82
+ ---
83
+
84
+ ## Usage
85
+
86
+ The Cuid Generator API documentation is found here: [https://docs.apiverve.com/ref/cuidgenerator](https://docs.apiverve.com/ref/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=readme).
87
+ You can find parameters, example responses, and status codes documented here.
88
+
89
+ ### Setup
90
+
91
+ ```python
92
+ # Import the client module
93
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
94
+
95
+ # Initialize the client with your APIVerve API key
96
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
97
+ ```
98
+
99
+ ---
100
+
101
+ ## Perform Request
102
+
103
+ Using the API client, you can perform requests to the API.
104
+
105
+ ###### Define Query
106
+
107
+ ```python
108
+ query = { "count": 1 }
109
+ ```
110
+
111
+ ###### Simple Request
112
+
113
+ ```python
114
+ # Make a request to the API
115
+ result = api.execute(query)
116
+
117
+ # Print the result
118
+ print(result)
119
+ ```
120
+
121
+ ###### Example Response
122
+
123
+ ```json
124
+ {
125
+ "status": "ok",
126
+ "error": null,
127
+ "data": {
128
+ "cuids": [
129
+ "cmj95ed27000000145v116use",
130
+ "cmj95ed2700010014uuounuyc",
131
+ "cmj95ed27000200147pwbz35y",
132
+ "cmj95ed27000300142h9ivqrz",
133
+ "cmj95ed27000400149ingh73n",
134
+ "cmj95ed2700050014mg9alsah",
135
+ "cmj95ed27000600149utx0fy3",
136
+ "cmj95ed270007001467kspfhp",
137
+ "cmj95ed2700080014n7ykgwxf",
138
+ "cmj95ed2700090014rrnfehcn"
139
+ ],
140
+ "count": 10,
141
+ "format": "c + timestamp + counter + fingerprint + random",
142
+ "collision_resistant": true,
143
+ "sortable": true
144
+ }
145
+ }
146
+ ```
147
+
148
+ ---
149
+
150
+ ## Error Handling
151
+
152
+ The API client provides comprehensive error handling through the `CuidgeneratorAPIClientError` exception. Here are some examples:
153
+
154
+ ### Basic Error Handling
155
+
156
+ ```python
157
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient, CuidgeneratorAPIClientError
158
+
159
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
160
+
161
+ query = { "count": 1 }
162
+
163
+ try:
164
+ result = api.execute(query)
165
+ print("Success!")
166
+ print(result)
167
+ except CuidgeneratorAPIClientError as e:
168
+ print(f"API Error: {e.message}")
169
+ if e.status_code:
170
+ print(f"Status Code: {e.status_code}")
171
+ if e.response:
172
+ print(f"Response: {e.response}")
173
+ ```
174
+
175
+ ### Handling Specific Error Types
176
+
177
+ ```python
178
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient, CuidgeneratorAPIClientError
179
+
180
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
181
+
182
+ query = { "count": 1 }
183
+
184
+ try:
185
+ result = api.execute(query)
186
+
187
+ # Check for successful response
188
+ if result.get('status') == 'success':
189
+ print("Request successful!")
190
+ print(result.get('data'))
191
+ else:
192
+ print(f"API returned an error: {result.get('error')}")
193
+
194
+ except CuidgeneratorAPIClientError as e:
195
+ # Handle API client errors
196
+ if e.status_code == 401:
197
+ print("Unauthorized: Invalid API key")
198
+ elif e.status_code == 429:
199
+ print("Rate limit exceeded")
200
+ elif e.status_code >= 500:
201
+ print("Server error - please try again later")
202
+ else:
203
+ print(f"API error: {e.message}")
204
+ except Exception as e:
205
+ # Handle unexpected errors
206
+ print(f"Unexpected error: {str(e)}")
207
+ ```
208
+
209
+ ### Using Context Manager (Recommended)
210
+
211
+ The client supports the context manager protocol for automatic resource cleanup:
212
+
213
+ ```python
214
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient, CuidgeneratorAPIClientError
215
+
216
+ query = { "count": 1 }
217
+
218
+ # Using context manager ensures proper cleanup
219
+ with CuidgeneratorAPIClient("[YOUR_API_KEY]") as api:
220
+ try:
221
+ result = api.execute(query)
222
+ print(result)
223
+ except CuidgeneratorAPIClientError as e:
224
+ print(f"Error: {e.message}")
225
+ # Session is automatically closed here
226
+ ```
227
+
228
+ ---
229
+
230
+ ## Advanced Features
231
+
232
+ ### Debug Mode
233
+
234
+ Enable debug logging to see detailed request and response information:
235
+
236
+ ```python
237
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
238
+
239
+ # Enable debug mode
240
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]", debug=True)
241
+
242
+ query = { "count": 1 }
243
+
244
+ # Debug information will be printed to console
245
+ result = api.execute(query)
246
+ ```
247
+
248
+ ### Manual Session Management
249
+
250
+ If you need to manually manage the session lifecycle:
251
+
252
+ ```python
253
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
254
+
255
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
256
+
257
+ query = { "count": 1 }
258
+
259
+ try:
260
+ result = api.execute(query)
261
+ print(result)
262
+ finally:
263
+ # Manually close the session when done
264
+ api.close()
265
+ ```
266
+
267
+ ---
268
+
269
+ ## Customer Support
270
+
271
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=pypi&utm_medium=referral&utm_content=readme).
272
+
273
+ ---
274
+
275
+ ## Updates
276
+ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
277
+
278
+ ---
279
+
280
+ ## Legal
281
+
282
+ All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=pypi&utm_medium=referral&utm_content=readme) and all legal documents and agreements.
283
+
284
+ ---
285
+
286
+ ## License
287
+ Licensed under the MIT License (MIT)
288
+
289
+ Copyright (&copy;) 2026 APIVerve, and EvlarSoft LLC
290
+
291
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
292
+
293
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
294
+
295
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,271 @@
1
+ Cuid Generator API
2
+ ============
3
+
4
+ Cuid Generator creates collision-resistant unique identifiers (CUIDs) on demand for distributed applications. Pass an optional count to receive an array of unique ID strings, with paid plans adding structural format and sortability details.
5
+
6
+
7
+ [![PyPI version](https://img.shields.io/pypi/v/apiverve-cuidgenerator.svg)](https://pypi.org/project/apiverve-cuidgenerator/)
8
+
9
+ This is a Python wrapper for the [Cuid Generator API](https://apiverve.com/marketplace/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=readme)
10
+
11
+ ---
12
+
13
+ ## Installation
14
+
15
+ Using `pip`:
16
+
17
+ ```bash
18
+ pip install apiverve-cuidgenerator
19
+ ```
20
+
21
+ Using `pip3`:
22
+
23
+ ```bash
24
+ pip3 install apiverve-cuidgenerator
25
+ ```
26
+
27
+ ---
28
+
29
+ ## Configuration
30
+
31
+ Before using the Cuid Generator API client, you have to setup your account and obtain your API Key.
32
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=pypi&utm_medium=referral&utm_content=readme)
33
+
34
+ ---
35
+
36
+ ## Quick Start
37
+
38
+ Here's a simple example to get you started quickly:
39
+
40
+ ```python
41
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
42
+
43
+ # Initialize the client with your APIVerve API key
44
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
45
+
46
+ query = { "count": 1 }
47
+
48
+ try:
49
+ # Make the API call
50
+ result = api.execute(query)
51
+
52
+ # Print the result
53
+ print(result)
54
+ except Exception as e:
55
+ print(f"Error: {e}")
56
+ ```
57
+
58
+ ---
59
+
60
+ ## Usage
61
+
62
+ The Cuid Generator API documentation is found here: [https://docs.apiverve.com/ref/cuidgenerator](https://docs.apiverve.com/ref/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=readme).
63
+ You can find parameters, example responses, and status codes documented here.
64
+
65
+ ### Setup
66
+
67
+ ```python
68
+ # Import the client module
69
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
70
+
71
+ # Initialize the client with your APIVerve API key
72
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
73
+ ```
74
+
75
+ ---
76
+
77
+ ## Perform Request
78
+
79
+ Using the API client, you can perform requests to the API.
80
+
81
+ ###### Define Query
82
+
83
+ ```python
84
+ query = { "count": 1 }
85
+ ```
86
+
87
+ ###### Simple Request
88
+
89
+ ```python
90
+ # Make a request to the API
91
+ result = api.execute(query)
92
+
93
+ # Print the result
94
+ print(result)
95
+ ```
96
+
97
+ ###### Example Response
98
+
99
+ ```json
100
+ {
101
+ "status": "ok",
102
+ "error": null,
103
+ "data": {
104
+ "cuids": [
105
+ "cmj95ed27000000145v116use",
106
+ "cmj95ed2700010014uuounuyc",
107
+ "cmj95ed27000200147pwbz35y",
108
+ "cmj95ed27000300142h9ivqrz",
109
+ "cmj95ed27000400149ingh73n",
110
+ "cmj95ed2700050014mg9alsah",
111
+ "cmj95ed27000600149utx0fy3",
112
+ "cmj95ed270007001467kspfhp",
113
+ "cmj95ed2700080014n7ykgwxf",
114
+ "cmj95ed2700090014rrnfehcn"
115
+ ],
116
+ "count": 10,
117
+ "format": "c + timestamp + counter + fingerprint + random",
118
+ "collision_resistant": true,
119
+ "sortable": true
120
+ }
121
+ }
122
+ ```
123
+
124
+ ---
125
+
126
+ ## Error Handling
127
+
128
+ The API client provides comprehensive error handling through the `CuidgeneratorAPIClientError` exception. Here are some examples:
129
+
130
+ ### Basic Error Handling
131
+
132
+ ```python
133
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient, CuidgeneratorAPIClientError
134
+
135
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
136
+
137
+ query = { "count": 1 }
138
+
139
+ try:
140
+ result = api.execute(query)
141
+ print("Success!")
142
+ print(result)
143
+ except CuidgeneratorAPIClientError as e:
144
+ print(f"API Error: {e.message}")
145
+ if e.status_code:
146
+ print(f"Status Code: {e.status_code}")
147
+ if e.response:
148
+ print(f"Response: {e.response}")
149
+ ```
150
+
151
+ ### Handling Specific Error Types
152
+
153
+ ```python
154
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient, CuidgeneratorAPIClientError
155
+
156
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
157
+
158
+ query = { "count": 1 }
159
+
160
+ try:
161
+ result = api.execute(query)
162
+
163
+ # Check for successful response
164
+ if result.get('status') == 'success':
165
+ print("Request successful!")
166
+ print(result.get('data'))
167
+ else:
168
+ print(f"API returned an error: {result.get('error')}")
169
+
170
+ except CuidgeneratorAPIClientError as e:
171
+ # Handle API client errors
172
+ if e.status_code == 401:
173
+ print("Unauthorized: Invalid API key")
174
+ elif e.status_code == 429:
175
+ print("Rate limit exceeded")
176
+ elif e.status_code >= 500:
177
+ print("Server error - please try again later")
178
+ else:
179
+ print(f"API error: {e.message}")
180
+ except Exception as e:
181
+ # Handle unexpected errors
182
+ print(f"Unexpected error: {str(e)}")
183
+ ```
184
+
185
+ ### Using Context Manager (Recommended)
186
+
187
+ The client supports the context manager protocol for automatic resource cleanup:
188
+
189
+ ```python
190
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient, CuidgeneratorAPIClientError
191
+
192
+ query = { "count": 1 }
193
+
194
+ # Using context manager ensures proper cleanup
195
+ with CuidgeneratorAPIClient("[YOUR_API_KEY]") as api:
196
+ try:
197
+ result = api.execute(query)
198
+ print(result)
199
+ except CuidgeneratorAPIClientError as e:
200
+ print(f"Error: {e.message}")
201
+ # Session is automatically closed here
202
+ ```
203
+
204
+ ---
205
+
206
+ ## Advanced Features
207
+
208
+ ### Debug Mode
209
+
210
+ Enable debug logging to see detailed request and response information:
211
+
212
+ ```python
213
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
214
+
215
+ # Enable debug mode
216
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]", debug=True)
217
+
218
+ query = { "count": 1 }
219
+
220
+ # Debug information will be printed to console
221
+ result = api.execute(query)
222
+ ```
223
+
224
+ ### Manual Session Management
225
+
226
+ If you need to manually manage the session lifecycle:
227
+
228
+ ```python
229
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
230
+
231
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
232
+
233
+ query = { "count": 1 }
234
+
235
+ try:
236
+ result = api.execute(query)
237
+ print(result)
238
+ finally:
239
+ # Manually close the session when done
240
+ api.close()
241
+ ```
242
+
243
+ ---
244
+
245
+ ## Customer Support
246
+
247
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=pypi&utm_medium=referral&utm_content=readme).
248
+
249
+ ---
250
+
251
+ ## Updates
252
+ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
253
+
254
+ ---
255
+
256
+ ## Legal
257
+
258
+ All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=pypi&utm_medium=referral&utm_content=readme) and all legal documents and agreements.
259
+
260
+ ---
261
+
262
+ ## License
263
+ Licensed under the MIT License (MIT)
264
+
265
+ Copyright (&copy;) 2026 APIVerve, and EvlarSoft LLC
266
+
267
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
268
+
269
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
270
+
271
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,29 @@
1
+ [project]
2
+ name = "apiverve-cuidgenerator"
3
+ version = "1.2.3"
4
+ authors = [
5
+ { name="APIVerve", email="hello@apiverve.com" },
6
+ ]
7
+ description = "Cuid Generator creates collision-resistant unique identifiers (CUIDs) on demand for distributed applications. Pass an optional count to receive an array of unique ID strings, with paid plans adding structural format and sortability details."
8
+ keywords = ["cuid", "cuid generator", "collision resistant id", "unique identifier", "sortable id"]
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ license = {text = "MIT"}
12
+ dependencies = [
13
+ "requests>=2.25.0"
14
+ ]
15
+ classifiers = [
16
+ "Development Status :: 5 - Production/Stable",
17
+ "Programming Language :: Python :: 3",
18
+ "Operating System :: OS Independent",
19
+ "Intended Audience :: Developers",
20
+ "Topic :: Internet :: WWW/HTTP",
21
+ "Topic :: Software Development :: Libraries :: Python Modules",
22
+ "Natural Language :: English",
23
+ ]
24
+
25
+ [project.urls]
26
+ Homepage = "https://apiverve.com/marketplace/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=homepage"
27
+ Documentation = "https://docs.apiverve.com/ref/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=docs"
28
+ Repository = "https://github.com/apiverve/cuidgenerator-api"
29
+ Twitter = "https://twitter.com/apivervehq"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,3 @@
1
+ from .apiClient import CuidgeneratorAPIClient, CuidgeneratorAPIClientError
2
+
3
+ __all__ = ['CuidgeneratorAPIClient', 'CuidgeneratorAPIClientError']
@@ -0,0 +1,250 @@
1
+ import re
2
+ from typing import Dict, Optional, Any, List
3
+ from dataclasses import dataclass
4
+ import requests
5
+
6
+
7
+ class CuidgeneratorAPIClientError(Exception):
8
+ """Custom exception for API client errors"""
9
+ def __init__(self, message: str, status_code: Optional[int] = None, response: Optional[Dict] = None):
10
+ self.message = message
11
+ self.status_code = status_code
12
+ self.response = response
13
+ super().__init__(self.message)
14
+
15
+
16
+ class ValidationError(CuidgeneratorAPIClientError):
17
+ """Custom exception for parameter validation errors"""
18
+ def __init__(self, errors: List[str]):
19
+ self.errors = errors
20
+ message = f"Validation failed: {' '.join(errors)}"
21
+ super().__init__(message)
22
+
23
+
24
+ class CuidgeneratorAPIClient:
25
+ # Validation rules for parameters (generated from schema)
26
+ VALIDATION_RULES = {
27
+ "count": {"type": "integer", "required": False, "min": 1, "max": 100, "default": 1}
28
+ }
29
+
30
+ # Format validation patterns
31
+ FORMAT_PATTERNS = {
32
+ 'email': r'^[^\s@]+@[^\s@]+\.[^\s@]+$',
33
+ 'url': r'^https?://.+',
34
+ 'ip': r'^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$',
35
+ 'date': r'^\d{4}-\d{2}-\d{2}$',
36
+ 'hexColor': r'^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$'
37
+ }
38
+
39
+ def __init__(self, api_key: str, secure: bool = True, debug: bool = False):
40
+ """
41
+ Initialize the CuidgeneratorAPIClient with the API key and optional settings
42
+
43
+ :param api_key: Your APIVerve API key
44
+ :param secure: Deprecated. Always set to True
45
+ :param debug: Enable debug logging (default: False)
46
+ :raises CuidgeneratorAPIClientError: If API key is invalid
47
+ """
48
+
49
+ self._validate_api_key(api_key)
50
+
51
+ self.api_key = api_key
52
+ self.secure = secure
53
+ self.debug = debug
54
+ self.base_url = 'https://api.apiverve.com/v1/cuidgenerator'
55
+ self.headers = {
56
+ 'x-api-key': self.api_key,
57
+ 'auth-mode': 'pypi-package'
58
+ }
59
+
60
+ # Create a session for connection pooling
61
+ self.session = requests.Session()
62
+ self.session.headers.update(self.headers)
63
+
64
+ def _validate_api_key(self, api_key: str) -> None:
65
+ """
66
+ Validate the API key format
67
+
68
+ :param api_key: API key to validate
69
+ :raises CuidgeneratorAPIClientError: If API key is invalid
70
+ """
71
+ if not api_key or not api_key.strip():
72
+ raise CuidgeneratorAPIClientError(
73
+ "API key is required. Get your API key at: https://apiverve.com"
74
+ )
75
+
76
+ # Check format (GUID, prefixed keys like apv_xxx, or alphanumeric)
77
+ if not re.match(r'^[a-zA-Z0-9_-]+$', api_key):
78
+ raise CuidgeneratorAPIClientError(
79
+ "Invalid API key format. API key should only contain letters, numbers, hyphens, and underscores. "
80
+ "Get your API key at: https://apiverve.com"
81
+ )
82
+
83
+ def _log(self, message: str) -> None:
84
+ """
85
+ Log a debug message if debug mode is enabled
86
+
87
+ :param message: Message to log
88
+ """
89
+ if self.debug:
90
+ print(f"[CuidgeneratorAPIClient DEBUG] {message}")
91
+
92
+ def _validate_params(self, params: Optional[Dict[str, Any]]) -> None:
93
+ """
94
+ Validate parameters against schema rules
95
+
96
+ :param params: Parameters to validate
97
+ :raises ValidationError: If validation fails
98
+ """
99
+ if not self.VALIDATION_RULES:
100
+ return
101
+
102
+ errors = []
103
+ params = params or {}
104
+
105
+ for param_name, rules in self.VALIDATION_RULES.items():
106
+ value = params.get(param_name)
107
+
108
+ # Check required
109
+ if rules.get('required') and (value is None or value == ''):
110
+ errors.append(f"Required parameter [{param_name}] is missing.")
111
+ continue
112
+
113
+ # Skip validation if value is not provided and not required
114
+ if value is None:
115
+ continue
116
+
117
+ param_type = rules.get('type', 'string')
118
+
119
+ # Type validation
120
+ if param_type in ('integer', 'number'):
121
+ try:
122
+ num_value = float(value) if param_type == 'number' else int(value)
123
+
124
+ # Min/max validation
125
+ if 'min' in rules and num_value < rules['min']:
126
+ errors.append(f"Parameter [{param_name}] must be at least {rules['min']}.")
127
+ if 'max' in rules and num_value > rules['max']:
128
+ errors.append(f"Parameter [{param_name}] must be at most {rules['max']}.")
129
+ except (ValueError, TypeError):
130
+ errors.append(f"Parameter [{param_name}] must be a valid {param_type}.")
131
+ continue
132
+
133
+ elif param_type == 'string':
134
+ if not isinstance(value, str):
135
+ errors.append(f"Parameter [{param_name}] must be a string.")
136
+ continue
137
+
138
+ # Length validation
139
+ if 'minLength' in rules and len(value) < rules['minLength']:
140
+ errors.append(f"Parameter [{param_name}] must be at least {rules['minLength']} characters.")
141
+ if 'maxLength' in rules and len(value) > rules['maxLength']:
142
+ errors.append(f"Parameter [{param_name}] must be at most {rules['maxLength']} characters.")
143
+
144
+ # Format validation
145
+ if 'format' in rules and rules['format'] in self.FORMAT_PATTERNS:
146
+ pattern = self.FORMAT_PATTERNS[rules['format']]
147
+ if not re.match(pattern, value, re.IGNORECASE):
148
+ errors.append(f"Parameter [{param_name}] must be a valid {rules['format']}.")
149
+
150
+ elif param_type == 'boolean':
151
+ if not isinstance(value, bool) and value not in ('true', 'false', True, False):
152
+ errors.append(f"Parameter [{param_name}] must be a boolean.")
153
+
154
+ elif param_type == 'array':
155
+ if not isinstance(value, list):
156
+ errors.append(f"Parameter [{param_name}] must be an array.")
157
+
158
+ # Enum validation
159
+ if 'enum' in rules and value not in rules['enum']:
160
+ errors.append(f"Parameter [{param_name}] must be one of: {', '.join(map(str, rules['enum']))}.")
161
+
162
+ if errors:
163
+ raise ValidationError(errors)
164
+
165
+ def execute(self, params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]: # Returns CuidGeneratorData in 'data' field
166
+ """
167
+ Execute the API request
168
+
169
+ :param params: API parameters (optional)
170
+ :return: API response as a dictionary
171
+ :raises CuidgeneratorAPIClientError: If the request fails or returns an error
172
+ :raises ValidationError: If parameter validation fails
173
+ """
174
+
175
+ # Validate parameters against schema rules
176
+ self._validate_params(params)
177
+
178
+ method = "GET"
179
+
180
+ self._log(f"Making {method} request to {self.base_url}")
181
+ if params:
182
+ self._log(f"Parameters: {params}")
183
+
184
+ try:
185
+ if method.upper() == 'POST':
186
+ self._log("Sending POST request with JSON body")
187
+ response = self.session.post(self.base_url, json=params, timeout=30)
188
+ else:
189
+ self._log("Sending GET request with query parameters")
190
+ response = self.session.get(self.base_url, params=params, timeout=30)
191
+
192
+ self._log(f"Response status code: {response.status_code}")
193
+
194
+ # Try to parse JSON response
195
+ try:
196
+ response_data = response.json()
197
+ except ValueError as e:
198
+ raise CuidgeneratorAPIClientError(
199
+ f"Invalid JSON response from API: {str(e)}",
200
+ status_code=response.status_code
201
+ )
202
+
203
+ # Check for API-level errors in the response
204
+ if response_data.get('status') == 'error':
205
+ error_message = response_data.get('error', 'Unknown API error')
206
+ self._log(f"API returned error: {error_message}")
207
+ raise CuidgeneratorAPIClientError(
208
+ error_message,
209
+ status_code=response.status_code,
210
+ response=response_data
211
+ )
212
+
213
+ # Check HTTP status code
214
+ if not response.ok:
215
+ error_message = response_data.get('error', f"HTTP {response.status_code} error")
216
+ self._log(f"HTTP error: {error_message}")
217
+ raise CuidgeneratorAPIClientError(
218
+ error_message,
219
+ status_code=response.status_code,
220
+ response=response_data
221
+ )
222
+
223
+ self._log("Request successful")
224
+ return response_data
225
+
226
+ except requests.exceptions.Timeout as e:
227
+ self._log(f"Request timeout: {str(e)}")
228
+ raise CuidgeneratorAPIClientError(f"Request timeout: {str(e)}")
229
+ except requests.exceptions.ConnectionError as e:
230
+ self._log(f"Connection error: {str(e)}")
231
+ raise CuidgeneratorAPIClientError(f"Connection error: {str(e)}")
232
+ except requests.exceptions.RequestException as e:
233
+ self._log(f"Request exception: {str(e)}")
234
+ raise CuidgeneratorAPIClientError(f"Request failed: {str(e)}")
235
+
236
+
237
+ def close(self) -> None:
238
+ """
239
+ Close the session and release resources
240
+ """
241
+ self._log("Closing session")
242
+ self.session.close()
243
+
244
+ def __enter__(self):
245
+ """Context manager entry"""
246
+ return self
247
+
248
+ def __exit__(self, exc_type, exc_val, exc_tb):
249
+ """Context manager exit"""
250
+ self.close()
@@ -0,0 +1,3 @@
1
+ class CuidgeneratorCuidGeneratorAPIError(Exception):
2
+ """A custom exception for API errors"""
3
+ pass
@@ -0,0 +1,26 @@
1
+ from setuptools import setup, find_packages
2
+
3
+ import os
4
+ lib_folder = os.path.dirname(os.path.realpath(__file__))
5
+ requirements_file = os.path.join(lib_folder, 'requirements.txt')
6
+ install_requires = ["requests >= 2.25.1", "setuptools >= 56.0.0"]
7
+ if os.path.exists(requirements_file):
8
+ with open(requirements_file, 'r') as f:
9
+ install_requires = f.read().splitlines()
10
+
11
+ setup(
12
+ name='apiverve_cuidgenerator',
13
+ version='1.2.3',
14
+ packages=find_packages(),
15
+ include_package_data=True,
16
+ install_requires=install_requires,
17
+ description='Cuid Generator creates collision-resistant unique identifiers (CUIDs) on demand for distributed applications. Pass an optional count to receive an array of unique ID strings, with paid plans adding structural format and sortability details.',
18
+ author='APIVerve',
19
+ author_email='hello@apiverve.com',
20
+ url='https://apiverve.com/marketplace/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=homepage',
21
+ classifiers=[
22
+ 'Programming Language :: Python :: 3',
23
+ 'Operating System :: OS Independent',
24
+ ],
25
+ python_requires='>=3.6',
26
+ )
@@ -0,0 +1,21 @@
1
+ from setuptools import setup, find_packages
2
+
3
+ setup(
4
+ name='apiverve_cuidgenerator',
5
+ version='1.2.3',
6
+ packages=find_packages(),
7
+ include_package_data=True,
8
+ install_requires=[
9
+ 'requests',
10
+ 'setuptools'
11
+ ],
12
+ description='Cuid Generator creates collision-resistant unique identifiers (CUIDs) on demand for distributed applications. Pass an optional count to receive an array of unique ID strings, with paid plans adding structural format and sortability details.',
13
+ author='APIVerve',
14
+ author_email='hello@apiverve.com',
15
+ url='https://apiverve.com/marketplace/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=homepage',
16
+ classifiers=[
17
+ 'Programming Language :: Python :: 3',
18
+ 'Operating System :: OS Independent',
19
+ ],
20
+ python_requires='>=3.6',
21
+ )
@@ -0,0 +1 @@
1
+ # Initialize test module
@@ -0,0 +1,19 @@
1
+ import unittest
2
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
3
+
4
+ class TestClient(unittest.TestCase):
5
+
6
+ def setUp(self):
7
+ self.api_key = 'test_api_key'
8
+ self.client = CuidgeneratorAPIClient(self.api_key)
9
+
10
+ def test_get(self):
11
+ # Assuming there's an endpoint 'test_endpoint' for testing purposes
12
+ try:
13
+ response = self.client.get('test_endpoint')
14
+ self.assertIsInstance(response, dict)
15
+ except Exception as e:
16
+ self.fail(f"GET request failed with exception {e}")
17
+
18
+ if __name__ == '__main__':
19
+ unittest.main()
@@ -0,0 +1,295 @@
1
+ Metadata-Version: 2.4
2
+ Name: apiverve-cuidgenerator
3
+ Version: 1.2.3
4
+ Summary: Cuid Generator creates collision-resistant unique identifiers (CUIDs) on demand for distributed applications. Pass an optional count to receive an array of unique ID strings, with paid plans adding structural format and sortability details.
5
+ Author-email: APIVerve <hello@apiverve.com>
6
+ License: MIT
7
+ Project-URL: Homepage, https://apiverve.com/marketplace/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=homepage
8
+ Project-URL: Documentation, https://docs.apiverve.com/ref/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=docs
9
+ Project-URL: Repository, https://github.com/apiverve/cuidgenerator-api
10
+ Project-URL: Twitter, https://twitter.com/apivervehq
11
+ Keywords: cuid,cuid generator,collision resistant id,unique identifier,sortable id
12
+ Classifier: Development Status :: 5 - Production/Stable
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Topic :: Internet :: WWW/HTTP
17
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
18
+ Classifier: Natural Language :: English
19
+ Requires-Python: >=3.9
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Requires-Dist: requests>=2.25.0
23
+ Dynamic: license-file
24
+
25
+ Cuid Generator API
26
+ ============
27
+
28
+ Cuid Generator creates collision-resistant unique identifiers (CUIDs) on demand for distributed applications. Pass an optional count to receive an array of unique ID strings, with paid plans adding structural format and sortability details.
29
+
30
+
31
+ [![PyPI version](https://img.shields.io/pypi/v/apiverve-cuidgenerator.svg)](https://pypi.org/project/apiverve-cuidgenerator/)
32
+
33
+ This is a Python wrapper for the [Cuid Generator API](https://apiverve.com/marketplace/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=readme)
34
+
35
+ ---
36
+
37
+ ## Installation
38
+
39
+ Using `pip`:
40
+
41
+ ```bash
42
+ pip install apiverve-cuidgenerator
43
+ ```
44
+
45
+ Using `pip3`:
46
+
47
+ ```bash
48
+ pip3 install apiverve-cuidgenerator
49
+ ```
50
+
51
+ ---
52
+
53
+ ## Configuration
54
+
55
+ Before using the Cuid Generator API client, you have to setup your account and obtain your API Key.
56
+ You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=pypi&utm_medium=referral&utm_content=readme)
57
+
58
+ ---
59
+
60
+ ## Quick Start
61
+
62
+ Here's a simple example to get you started quickly:
63
+
64
+ ```python
65
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
66
+
67
+ # Initialize the client with your APIVerve API key
68
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
69
+
70
+ query = { "count": 1 }
71
+
72
+ try:
73
+ # Make the API call
74
+ result = api.execute(query)
75
+
76
+ # Print the result
77
+ print(result)
78
+ except Exception as e:
79
+ print(f"Error: {e}")
80
+ ```
81
+
82
+ ---
83
+
84
+ ## Usage
85
+
86
+ The Cuid Generator API documentation is found here: [https://docs.apiverve.com/ref/cuidgenerator](https://docs.apiverve.com/ref/cuidgenerator?utm_source=pypi&utm_medium=referral&utm_content=readme).
87
+ You can find parameters, example responses, and status codes documented here.
88
+
89
+ ### Setup
90
+
91
+ ```python
92
+ # Import the client module
93
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
94
+
95
+ # Initialize the client with your APIVerve API key
96
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
97
+ ```
98
+
99
+ ---
100
+
101
+ ## Perform Request
102
+
103
+ Using the API client, you can perform requests to the API.
104
+
105
+ ###### Define Query
106
+
107
+ ```python
108
+ query = { "count": 1 }
109
+ ```
110
+
111
+ ###### Simple Request
112
+
113
+ ```python
114
+ # Make a request to the API
115
+ result = api.execute(query)
116
+
117
+ # Print the result
118
+ print(result)
119
+ ```
120
+
121
+ ###### Example Response
122
+
123
+ ```json
124
+ {
125
+ "status": "ok",
126
+ "error": null,
127
+ "data": {
128
+ "cuids": [
129
+ "cmj95ed27000000145v116use",
130
+ "cmj95ed2700010014uuounuyc",
131
+ "cmj95ed27000200147pwbz35y",
132
+ "cmj95ed27000300142h9ivqrz",
133
+ "cmj95ed27000400149ingh73n",
134
+ "cmj95ed2700050014mg9alsah",
135
+ "cmj95ed27000600149utx0fy3",
136
+ "cmj95ed270007001467kspfhp",
137
+ "cmj95ed2700080014n7ykgwxf",
138
+ "cmj95ed2700090014rrnfehcn"
139
+ ],
140
+ "count": 10,
141
+ "format": "c + timestamp + counter + fingerprint + random",
142
+ "collision_resistant": true,
143
+ "sortable": true
144
+ }
145
+ }
146
+ ```
147
+
148
+ ---
149
+
150
+ ## Error Handling
151
+
152
+ The API client provides comprehensive error handling through the `CuidgeneratorAPIClientError` exception. Here are some examples:
153
+
154
+ ### Basic Error Handling
155
+
156
+ ```python
157
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient, CuidgeneratorAPIClientError
158
+
159
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
160
+
161
+ query = { "count": 1 }
162
+
163
+ try:
164
+ result = api.execute(query)
165
+ print("Success!")
166
+ print(result)
167
+ except CuidgeneratorAPIClientError as e:
168
+ print(f"API Error: {e.message}")
169
+ if e.status_code:
170
+ print(f"Status Code: {e.status_code}")
171
+ if e.response:
172
+ print(f"Response: {e.response}")
173
+ ```
174
+
175
+ ### Handling Specific Error Types
176
+
177
+ ```python
178
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient, CuidgeneratorAPIClientError
179
+
180
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
181
+
182
+ query = { "count": 1 }
183
+
184
+ try:
185
+ result = api.execute(query)
186
+
187
+ # Check for successful response
188
+ if result.get('status') == 'success':
189
+ print("Request successful!")
190
+ print(result.get('data'))
191
+ else:
192
+ print(f"API returned an error: {result.get('error')}")
193
+
194
+ except CuidgeneratorAPIClientError as e:
195
+ # Handle API client errors
196
+ if e.status_code == 401:
197
+ print("Unauthorized: Invalid API key")
198
+ elif e.status_code == 429:
199
+ print("Rate limit exceeded")
200
+ elif e.status_code >= 500:
201
+ print("Server error - please try again later")
202
+ else:
203
+ print(f"API error: {e.message}")
204
+ except Exception as e:
205
+ # Handle unexpected errors
206
+ print(f"Unexpected error: {str(e)}")
207
+ ```
208
+
209
+ ### Using Context Manager (Recommended)
210
+
211
+ The client supports the context manager protocol for automatic resource cleanup:
212
+
213
+ ```python
214
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient, CuidgeneratorAPIClientError
215
+
216
+ query = { "count": 1 }
217
+
218
+ # Using context manager ensures proper cleanup
219
+ with CuidgeneratorAPIClient("[YOUR_API_KEY]") as api:
220
+ try:
221
+ result = api.execute(query)
222
+ print(result)
223
+ except CuidgeneratorAPIClientError as e:
224
+ print(f"Error: {e.message}")
225
+ # Session is automatically closed here
226
+ ```
227
+
228
+ ---
229
+
230
+ ## Advanced Features
231
+
232
+ ### Debug Mode
233
+
234
+ Enable debug logging to see detailed request and response information:
235
+
236
+ ```python
237
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
238
+
239
+ # Enable debug mode
240
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]", debug=True)
241
+
242
+ query = { "count": 1 }
243
+
244
+ # Debug information will be printed to console
245
+ result = api.execute(query)
246
+ ```
247
+
248
+ ### Manual Session Management
249
+
250
+ If you need to manually manage the session lifecycle:
251
+
252
+ ```python
253
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
254
+
255
+ api = CuidgeneratorAPIClient("[YOUR_API_KEY]")
256
+
257
+ query = { "count": 1 }
258
+
259
+ try:
260
+ result = api.execute(query)
261
+ print(result)
262
+ finally:
263
+ # Manually close the session when done
264
+ api.close()
265
+ ```
266
+
267
+ ---
268
+
269
+ ## Customer Support
270
+
271
+ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=pypi&utm_medium=referral&utm_content=readme).
272
+
273
+ ---
274
+
275
+ ## Updates
276
+ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
277
+
278
+ ---
279
+
280
+ ## Legal
281
+
282
+ All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=pypi&utm_medium=referral&utm_content=readme) and all legal documents and agreements.
283
+
284
+ ---
285
+
286
+ ## License
287
+ Licensed under the MIT License (MIT)
288
+
289
+ Copyright (&copy;) 2026 APIVerve, and EvlarSoft LLC
290
+
291
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
292
+
293
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
294
+
295
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,16 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/apiverve_cuidgenerator/__init__.py
5
+ src/apiverve_cuidgenerator/apiClient.py
6
+ src/apiverve_cuidgenerator/exceptions.py
7
+ src/apiverve_cuidgenerator/setup.py
8
+ src/apiverve_cuidgenerator/setup_dep.py
9
+ src/apiverve_cuidgenerator.egg-info/PKG-INFO
10
+ src/apiverve_cuidgenerator.egg-info/SOURCES.txt
11
+ src/apiverve_cuidgenerator.egg-info/dependency_links.txt
12
+ src/apiverve_cuidgenerator.egg-info/requires.txt
13
+ src/apiverve_cuidgenerator.egg-info/top_level.txt
14
+ src/apiverve_cuidgenerator/tests/__init__.py
15
+ src/apiverve_cuidgenerator/tests/test_api.py
16
+ tests/test_api.py
@@ -0,0 +1,27 @@
1
+ import unittest
2
+ from apiverve_cuidgenerator.apiClient import CuidgeneratorAPIClient
3
+ from unittest.mock import patch
4
+
5
+ class TestCuidgeneratorAPIClient(unittest.TestCase):
6
+
7
+ def setUp(self):
8
+ self.api_key = 'test_api_key'
9
+ self.client = CuidgeneratorAPIClient(self.api_key)
10
+
11
+ @patch('apiverve_cuidgenerator.apiClient.requests.get')
12
+ def test_make_request_success(self, mock_get):
13
+ # Assuming there's an endpoint 'test_endpoint' for testing purposes
14
+ mock_get.return_value.status_code = 200
15
+ mock_get.return_value.json.return_value = {'test': 'test'}
16
+ response = self.client.get('test_endpoint')
17
+ self.assertIsInstance(response, dict)
18
+
19
+ @patch('apiverve_cuidgenerator.apiClient.requests.get')
20
+ def test_make_request_failure(self, mock_get):
21
+ # Assuming there's an endpoint 'test_endpoint' for testing purposes
22
+ mock_get.return_value.status_code = 404
23
+ with self.assertRaises(Exception):
24
+ self.client.get('test_endpoint')
25
+
26
+ if __name__ == '__main__':
27
+ unittest.main()