erioon 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

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,30 @@
1
+ Metadata-Version: 2.2
2
+ Name: erioon
3
+ Version: 0.1.3
4
+ Summary: Erioon Python SDK for seamless interaction with Erioon data services
5
+ Author: Zyber Pireci
6
+ Author-email: zyber.pireci@erioon.com
7
+ License: MIT
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: License :: OSI Approved :: MIT License
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Topic :: Software Development :: Libraries
12
+ Classifier: Intended Audience :: Developers
13
+ Requires-Python: >=3.6
14
+ Description-Content-Type: text/plain
15
+ License-File: LICENSE
16
+ Requires-Dist: requests>=2.25.1
17
+ Requires-Dist: pyodbc
18
+ Requires-Dist: azure-storage-blob
19
+ Requires-Dist: msgpack
20
+ Dynamic: author
21
+ Dynamic: author-email
22
+ Dynamic: classifier
23
+ Dynamic: description
24
+ Dynamic: description-content-type
25
+ Dynamic: license
26
+ Dynamic: requires-dist
27
+ Dynamic: requires-python
28
+ Dynamic: summary
29
+
30
+ The Erioon SDK for Python provides a robust interface to interact with Erioon resources such as collections, databases, and clusters. It supports CRUD operations, querying, and connection management with ease, enabling developers to integrate Erioon data services into their applications efficiently.
@@ -0,0 +1,5 @@
1
+ erioon-0.1.3.dist-info/LICENSE,sha256=xwnq3DNlZpQyteOK9HvtHRhMdYviXTTaCDljEodFRnQ,569
2
+ erioon-0.1.3.dist-info/METADATA,sha256=ANwursGi1wO_jNAg8yar9a7mdqJ_Auf650oeAXcbF3I,1165
3
+ erioon-0.1.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
4
+ erioon-0.1.3.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
5
+ erioon-0.1.3.dist-info/RECORD,,
@@ -0,0 +1 @@
1
+
erioon/auth.py DELETED
@@ -1,20 +0,0 @@
1
- from erioon.client import ErioonClient
2
-
3
- def Auth(credential_string):
4
- """
5
- Authenticates a user using a colon-separated email:password string.
6
-
7
- Parameters:
8
- - credential_string (str): A string in the format "email:password"
9
-
10
- Returns:
11
- - ErioonClient instance: An instance representing the authenticated user.
12
- If authentication fails, the instance will contain the error message.
13
-
14
- Example usage:
15
- >>> from erioon.auth import Auth
16
- >>> client = Auth("<API_KEY>:<EMAIL>:<PASSWORD>")
17
- >>> print(client) # prints user_id if successful or error message if not
18
- """
19
- api, email, password = credential_string.split(":")
20
- return ErioonClient(api ,email, password)
erioon/client.py DELETED
@@ -1,191 +0,0 @@
1
- import os
2
- import json
3
- import requests
4
- from datetime import datetime, timezone
5
- from erioon.database import Database
6
-
7
- class ErioonClient:
8
- """
9
- Client SDK for interacting with the Erioon API.
10
-
11
- Handles:
12
- - User authentication with email/password and API key
13
- - Token caching to avoid re-authenticating every time
14
- - SAS token expiration detection and auto-renewal
15
- - Access to user-specific databases
16
- """
17
-
18
- def __init__(self, api, email, password, base_url="https://sdk.erioon.com"):
19
- self.api = api
20
- self.email = email
21
- self.password = password
22
- self.base_url = base_url
23
- self.user_id = None
24
- self.error = None
25
- self.token_path = os.path.expanduser(f"~/.erioon_token_{self._safe_filename(email)}")
26
- self.login_metadata = None
27
-
28
- try:
29
- self.login_metadata = self._load_or_login()
30
- self._update_metadata_fields()
31
- except Exception as e:
32
- self.error = str(e)
33
-
34
- def _safe_filename(self, text):
35
- """
36
- Converts unsafe filename characters to underscores for cache file naming.
37
- """
38
- return "".join(c if c.isalnum() else "_" for c in text)
39
-
40
- def _do_login_and_cache(self):
41
- """
42
- Logs in to the API and writes the returned metadata (e.g. SAS token, user ID) to a local file.
43
- """
44
- metadata = self._login()
45
- with open(self.token_path, "w") as f:
46
- json.dump(metadata, f)
47
- return metadata
48
-
49
- def _load_or_login(self):
50
- """
51
- Tries to load the cached login metadata.
52
- If token is expired or file does not exist, performs a fresh login.
53
- """
54
- if os.path.exists(self.token_path):
55
- with open(self.token_path, "r") as f:
56
- metadata = json.load(f)
57
- if self._is_sas_expired(metadata):
58
- metadata = self._do_login_and_cache()
59
- return metadata
60
- else:
61
- return self._do_login_and_cache()
62
-
63
- def _login(self):
64
- """
65
- Sends login request to Erioon API using API key, email, and password.
66
- Returns authentication metadata including SAS token.
67
- """
68
- url = f"{self.base_url}/login_with_credentials"
69
- payload = {"api_key": self.api, "email": self.email, "password": self.password}
70
- headers = {"Content-Type": "application/json"}
71
-
72
- response = requests.post(url, json=payload, headers=headers)
73
- if response.status_code == 200:
74
- data = response.json()
75
- self.login_metadata = data
76
- self._update_metadata_fields()
77
- return data
78
- else:
79
- raise Exception("Invalid account")
80
-
81
- def _update_metadata_fields(self):
82
- if self.login_metadata:
83
- self.user_id = self.login_metadata.get("_id")
84
- self.cluster = self.login_metadata.get("cluster")
85
- self.database = self.login_metadata.get("database")
86
- self.sas_tokens = self.login_metadata.get("sas_tokens", {})
87
-
88
-
89
- def _clear_cached_token(self):
90
- """
91
- Clears the locally cached authentication token and resets internal state.
92
- """
93
- if os.path.exists(self.token_path):
94
- os.remove(self.token_path)
95
- self.user_id = None
96
- self.login_metadata = None
97
-
98
- def _is_sas_expired(self, metadata):
99
- """
100
- Determines whether the SAS token has expired by comparing the 'sas_token_expiry'
101
- or 'expiry' field with the current UTC time.
102
- """
103
- expiry_str = metadata.get("sas_token_expiry") or metadata.get("expiry")
104
-
105
- if not expiry_str:
106
- return True
107
-
108
- try:
109
- expiry_dt = datetime.fromisoformat(expiry_str.replace("Z", "+00:00"))
110
- now = datetime.now(timezone.utc)
111
- return now >= expiry_dt
112
- except Exception:
113
- return True
114
-
115
- def __getitem__(self, db_id):
116
- """
117
- Allows syntax like `client["my_database_id"]` to access a database.
118
- If the token is expired or invalid, it attempts reauthentication.
119
- """
120
- if not self.user_id:
121
- raise ValueError("Client not authenticated. Cannot access database.")
122
-
123
- try:
124
- return self._get_database_info(db_id)
125
- except Exception as e:
126
- err_msg = str(e).lower()
127
- if f"database with {db_id.lower()}" in err_msg or "database" in err_msg:
128
- self._clear_cached_token()
129
- try:
130
- self.login_metadata = self._do_login_and_cache()
131
- self._update_metadata_fields()
132
- except Exception:
133
- return "Login error"
134
-
135
- try:
136
- return self._get_database_info(db_id)
137
- except Exception:
138
- return f"❌ Database with _id {db_id} ..."
139
- else:
140
- raise e
141
-
142
- def _get_database_info(self, db_id):
143
- payload = {"user_id": self.user_id, "db_id": db_id}
144
- headers = {"Content-Type": "application/json"}
145
-
146
- response = requests.post(f"{self.base_url}/db_info", json=payload, headers=headers)
147
-
148
- if response.status_code == 200:
149
- db_info = response.json()
150
-
151
- sas_info = self.sas_tokens.get(db_id)
152
- if not sas_info:
153
- raise Exception(f"No SAS token info found for database id {db_id}")
154
-
155
- container_url = sas_info.get("container_url")
156
- sas_token = sas_info.get("sas_token")
157
-
158
- if not container_url or not sas_token:
159
- raise Exception("Missing SAS URL components for storage access")
160
-
161
- if not sas_token.startswith("?"):
162
- sas_token = "?" + sas_token
163
-
164
- sas_url = container_url.split("?")[0] + sas_token
165
-
166
- return Database(
167
- user_id=self.user_id,
168
- metadata=db_info,
169
- database=self.database,
170
- cluster=self.cluster,
171
- sas_url=sas_url
172
- )
173
- else:
174
- try:
175
- error_json = response.json()
176
- error_msg = error_json.get("error", response.text)
177
- except Exception:
178
- error_msg = response.text
179
- raise Exception(error_msg)
180
-
181
- def __str__(self):
182
- """
183
- Returns user_id or error string when printed.
184
- """
185
- return self.user_id if self.user_id else self.error
186
-
187
- def __repr__(self):
188
- """
189
- Developer-friendly representation of the client.
190
- """
191
- return f"<ErioonClient user_id={self.user_id}>" if self.user_id else f"<ErioonClient error='{self.error}'>"
erioon/collection.py DELETED
@@ -1,298 +0,0 @@
1
- import json
2
- from urllib.parse import urlparse
3
- from erioon.read import handle_get_all, handle_get_data, handle_classify_vector
4
- from erioon.create import handle_insert_one, handle_insert_many, handle_vector, handle_insert_many_vectors
5
- from erioon.delete import handle_delete_one, handle_delete_many
6
- from erioon.update import handle_update_query
7
- from erioon.ping import handle_connection_ping
8
-
9
- class Collection:
10
- def __init__(
11
- self,
12
- user_id,
13
- db_id,
14
- coll_id,
15
- metadata,
16
- database,
17
- cluster,
18
- sas_url,
19
- ):
20
-
21
- """
22
- Initialize a Collection object that wraps Erioon collection access.
23
-
24
- Args:
25
- user_id (str): The authenticated user's ID.
26
- db_id (str): The database ID.
27
- coll_id (str): The collection ID.
28
- metadata (dict): Metadata info about this collection (e.g., schema, indexing, etc.).
29
- database (str): Name or ID of the database.
30
- cluster (str): Cluster name or ID hosting the database.
31
- sas_url (str): Full SAS URL used to access the storage container.
32
- """
33
-
34
- self.user_id = user_id
35
- self.db_id = db_id
36
- self.coll_id = coll_id
37
- self.metadata = metadata
38
- self.database = database
39
- self.cluster = cluster
40
-
41
- parsed_url = urlparse(sas_url.rstrip("/"))
42
- container_name = parsed_url.path.lstrip("/").split("/")[0]
43
- account_url = f"{parsed_url.scheme}://{parsed_url.netloc}"
44
- sas_token = parsed_url.query
45
- self.container_url = f"{account_url}/{container_name}?{sas_token}"
46
-
47
- def _print_loading(self):
48
- """Prints a loading message (likely for UX in CLI or SDK usage)."""
49
- print("Erioon is loading...")
50
-
51
- def _is_read_only(self):
52
- """Check if the current database is marked as read-only."""
53
- return self.database == "read"
54
-
55
- def _read_only_response(self):
56
- """Standardized error response for blocked write operations."""
57
- return "This user is not allowed to perform write operations.", 403
58
-
59
- def get_all(self, limit=1000000):
60
- """
61
- Fetch all records from the collection (up to a limit).
62
-
63
- Args:
64
- limit (int): Max number of records to fetch.
65
- Returns:
66
- list: Collection of records.
67
- """
68
- self._print_loading()
69
- result, status_code = handle_get_all(
70
- user_id=self.user_id,
71
- db_id=self.db_id,
72
- coll_id=self.coll_id,
73
- limit=limit,
74
- container_url=self.container_url,
75
- )
76
- return result
77
-
78
- def get_specific(self, filters: dict | None = None, limit: int = 1000):
79
- """
80
- Fetch records that match specific key-value filters.
81
-
82
- Args:
83
- filters (dict): Dictionary of exact match filters.
84
- limit (int): Max number of matching records to return.
85
-
86
- Returns:
87
- list: Filtered records from the collection.
88
- """
89
- if limit > 500_000:
90
- raise ValueError("Limit of 500,000 exceeded")
91
- self._print_loading()
92
-
93
- if filters is None:
94
- filters = {}
95
-
96
- search_criteria = [{k: v} for k, v in filters.items()]
97
- print(search_criteria)
98
-
99
- result, status_code = handle_get_data(
100
- user_id=self.user_id,
101
- db_id=self.db_id,
102
- coll_id=self.coll_id,
103
- search_criteria=search_criteria,
104
- limit=limit,
105
- container_url=self.container_url,
106
- )
107
- return result
108
-
109
- def insert_one(self, record):
110
- """
111
- Insert a single record into the collection.
112
-
113
- Args:
114
- record (dict): Record to insert.
115
-
116
- Returns:
117
- tuple: (response message, HTTP status code)
118
- """
119
- if self._is_read_only():
120
- return self._read_only_response()
121
- return handle_insert_one(
122
- user_id_cont=self.user_id,
123
- database=self.db_id,
124
- collection=self.coll_id,
125
- record=record,
126
- container_url=self.container_url,
127
- )
128
-
129
- def insert_many(self, data):
130
- """
131
- Insert multiple records into the collection.
132
-
133
- Args:
134
- data (list of dicts): Multiple records to insert.
135
-
136
- Returns:
137
- tuple: (response message, HTTP status code)
138
- """
139
- if self._is_read_only():
140
- return self._read_only_response()
141
- return handle_insert_many(
142
- user_id_cont=self.user_id,
143
- database=self.db_id,
144
- collection=self.coll_id,
145
- data=data,
146
- container_url=self.container_url,
147
- )
148
-
149
- def delete_one(self, record_to_delete):
150
- """
151
- Delete a single record based on its _id or nested key.
152
-
153
- Args:
154
- record_to_delete (dict): Identification of the record.
155
-
156
- Returns:
157
- tuple: (response message, HTTP status code)
158
- """
159
- if self._is_read_only():
160
- return self._read_only_response()
161
- return handle_delete_one(
162
- user_id=self.user_id,
163
- db_id=self.db_id,
164
- coll_id=self.coll_id,
165
- data_to_delete=record_to_delete,
166
- container_url=self.container_url,
167
- )
168
-
169
- def delete_many(self, records_to_delete_list, batch_size=10):
170
- """
171
- Delete multiple records in batches.
172
-
173
- Args:
174
- records_to_delete_list (list): List of record identifiers.
175
- batch_size (int): How many to delete at once (for efficiency).
176
-
177
- Returns:
178
- tuple: (response message, HTTP status code)
179
- """
180
- if self._is_read_only():
181
- return self._read_only_response()
182
- return handle_delete_many(
183
- user_id=self.user_id,
184
- db_id=self.db_id,
185
- coll_id=self.coll_id,
186
- data_to_delete_list=records_to_delete_list,
187
- batch_size=batch_size,
188
- container_url=self.container_url,
189
- )
190
-
191
- def update_query(self, filter_query: dict, update_query: dict):
192
- """
193
- Update a record in-place by filtering and applying update logic.
194
-
195
- Args:
196
- filter_query (dict): Dict describing what record(s) to match.
197
- update_query (dict): Dict describing update operators ($set, $push, $remove).
198
-
199
- Returns:
200
- tuple: (response message, HTTP status code)
201
- """
202
- if self._is_read_only():
203
- return self._read_only_response()
204
- return handle_update_query(
205
- user_id=self.user_id,
206
- db_id=self.db_id,
207
- coll_id=self.coll_id,
208
- filter_query=filter_query,
209
- update_query=update_query,
210
- container_url=self.container_url,
211
- )
212
-
213
- def ping(self):
214
- """
215
- Health check / ping to verify collection accessibility.
216
-
217
- Returns:
218
- tuple: (response message, HTTP status code)
219
- """
220
- return handle_connection_ping(
221
- user_id=self.user_id,
222
- db_id=self.db_id,
223
- coll_id=self.coll_id,
224
- container_url=self.container_url,
225
- )
226
-
227
- def insert_one_vector(self, vector_data, metadata):
228
- """
229
- Insert a single record into the collection.
230
-
231
- Args:
232
- record (dict): Record to insert.
233
-
234
- Returns:
235
- tuple: (response message, HTTP status code)
236
- """
237
- if self._is_read_only():
238
- return self._read_only_response()
239
- self._print_loading()
240
- return handle_vector(
241
- user_id_cont=self.user_id,
242
- database=self.db_id,
243
- collection=self.coll_id,
244
- vector=vector_data,
245
- metadata=metadata,
246
- container_url=self.container_url,
247
- )
248
-
249
- def insert_many_vectors(self, records):
250
- """
251
- Insert multiple vector records into the collection.
252
-
253
- Args:
254
- records (list): List of dicts, each with keys 'vector', 'metadata', and optional '_id'.
255
-
256
- Returns:
257
- tuple: (response message, HTTP status code)
258
- """
259
- if self._is_read_only():
260
- return self._read_only_response()
261
- self._print_loading()
262
- return handle_insert_many_vectors(
263
- user_id_cont=self.user_id,
264
- database=self.db_id,
265
- collection=self.coll_id,
266
- records=records,
267
- container_url=self.container_url,
268
- )
269
-
270
- def classify_vector(self, k=3):
271
- """
272
- Retrieve all vector records from the collection and classify them using k-NN.
273
-
274
- Args:
275
- k (int): Number of neighbors to use for classification.
276
-
277
- Returns:
278
- tuple: (response message, HTTP status code)
279
- """
280
- if self._is_read_only():
281
- return self._read_only_response()
282
- self._print_loading()
283
- return handle_classify_vector(
284
- user_id=self.user_id,
285
- db_id=self.db_id,
286
- coll_id=self.coll_id,
287
- container_url=self.container_url,
288
- k=k
289
- )
290
-
291
-
292
- def __str__(self):
293
- """Pretty print the collection metadata."""
294
- return json.dumps(self.metadata, indent=4)
295
-
296
- def __repr__(self):
297
- """Simplified representation for debugging or introspection."""
298
- return f"<Collection coll_id={self.coll_id}>"