infino-sdk 0.1.0__tar.gz

infino_sdk-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

infino_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,366 @@
+Metadata-Version: 2.4
+Name: infino-sdk
+Version: 0.1.0
+Summary: Python SDK for Infino API with AWS SigV4 authentication
+Author: Infino AI, Inc.
+Author-email: "Infino AI, Inc." <tech@infino.ai>
+Maintainer-email: "Infino AI, Inc." <tech@infino.ai>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://infino.ai
+Keywords: infino,search,analytics,opensearch,sdk,sigv4,ai,nlp
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Requires-Dist: backoff>=2.0.0
+Requires-Dist: websockets>=10.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: responses>=0.23.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: pylint>=2.17.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: build>=0.10.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-python
+
+# Infino Python SDK
+
+Python SDK for interacting with Infino's API, providing AWS SigV4 authenticated access to search, analytics, and AI capabilities.
+
+## Installation
+
+```bash
+pip install infino-sdk
+```
+
+## Quick Start
+
+```python
+from infino_sdk.lib import InfinoSDK
+import asyncio
+
+async def main():
+    # Create SDK instance with your credentials
+    async with InfinoSDK(
+        access_key="your_access_key",
+        secret_key="your_secret_key",
+        endpoint="http://localhost:9200"
+    ) as sdk:
+        # Check connection
+        info = await sdk.ping()
+        print(f"Connected to: {info}")
+
+        # Create an index
+        await sdk.create_index("my_index")
+
+        # Search documents
+        query = '{"query": {"match_all": {}}}'
+        results = await sdk.search("my_index", query)
+        print(f"Search results: {results}")
+
+# Run the async function
+asyncio.run(main())
+```
+
+## Usage Examples
+
+### Basic Operations
+
+```python
+from infino_sdk.lib import InfinoSDK
+
+async with InfinoSDK(access_key, secret_key, endpoint) as sdk:
+    # Index operations
+    await sdk.create_index("products")
+    await sdk.delete_index("old_products")
+    indices = await sdk.get_cat_indices()
+
+    # Document operations
+    doc = await sdk.get_document("products", "doc_id")
+    source = await sdk.get_source("products", "doc_id")
+
+    # Search operations
+    results = await sdk.search("products", '{"query": {"term": {"category": "electronics"}}}')
+    ai_results = await sdk.search_ai("products", "find all smartphones")
+
+    # SQL queries
+    sql_results = await sdk.sql("SELECT * FROM products WHERE price > 100")
+
+    # Bulk operations
+    bulk_data = '{"index": {"_id": "1"}}\n{"name": "Product 1"}\n'
+    await sdk.bulk_ingest("products", bulk_data)
+```
+
+### WebSocket Connections
+
+```python
+async with InfinoSDK(access_key, secret_key, endpoint) as sdk:
+    # Connect to WebSocket endpoint with automatic SigV4 authentication
+    ws = await sdk.websocket_connect("/_conversation/ws")
+
+    try:
+        # Send message
+        await ws.send('{"type": "message", "content": "Hello"}')
+
+        # Receive response
+        response = await ws.recv()
+        print(f"Received: {response}")
+    finally:
+        await ws.close()
+```
+
+### Security Operations
+
+```python
+async with InfinoSDK(access_key, secret_key, endpoint) as sdk:
+    # User management
+    user_config = {
+        "password": "strong_password",
+        "backend_roles": ["admin"]
+    }
+    await sdk.create_user("new_user", user_config)
+    users = await sdk.list_users()
+
+    # Role management
+    role_config = {
+        "cluster_permissions": ["indices:admin/*"],
+        "index_permissions": [{
+            "index_patterns": ["*"],
+            "allowed_actions": ["read", "write"]
+        }]
+    }
+    await sdk.create_role("custom_role", role_config)
+
+    # Role mapping
+    mapping_config = {
+        "users": ["new_user"],
+        "backend_roles": ["custom_role"]
+    }
+    await sdk.create_role_mapping("my_mapping", mapping_config)
+```
+
+### ML Commons Operations
+
+```python
+async with InfinoSDK(access_key, secret_key, endpoint) as sdk:
+    # Register a model
+    model_config = {
+        "name": "my_model",
+        "version": "1.0",
+        "model_type": "text_embedding"
+    }
+    result = await sdk.register_model(model_config)
+    model_id = result["model_id"]
+
+    # Deploy the model
+    await sdk.deploy_model(model_id)
+
+    # Make predictions
+    input_data = {"text": "Sample text for embedding"}
+    prediction = await sdk.predict(model_id, input_data)
+
+    # Undeploy when done
+    await sdk.undeploy_model(model_id)
+```
+
+### Account Management
+
+```python
+async with InfinoSDK(access_key, secret_key, endpoint) as sdk:
+    # Create a new account (no authentication required)
+    account_data = {
+        "public": "account_name",
+        "private": "account_password"
+    }
+    new_account = await sdk.create_account(account_data)
+    account_id = new_account["account_id"]
+
+    # Get account information
+    account_info = await sdk.get_account(account_id)
+
+    # Rotate API keys
+    new_keys = await sdk.rotate_api_keys("username")
+    print(f"New access key: {new_keys['access_key']}")
+
+    # Delete account
+    await sdk.delete_account(account_id)
+```
+
+### Manual Session Management
+
+If you need more control over the session lifecycle:
+
+```python
+from infino_sdk.lib import InfinoSDK
+
+# Create SDK instance
+sdk = InfinoSDK(access_key, secret_key, endpoint)
+
+# Initialize session manually
+await sdk._ensure_session()
+
+try:
+    # Use SDK methods
+    await sdk.ping()
+    results = await sdk.search("my_index", query)
+finally:
+    # Always close the session when done
+    await sdk.close()
+```
+
+## API Reference
+
+### Core Methods
+
+- `ping()` - Test connection to the Infino endpoint
+- `close()` - Close the underlying HTTP session
+
+### Index Operations
+
+- `create_index(index_name)` - Create a new index
+- `create_index_with_mapping(index_name, mapping)` - Create index with custom mapping
+- `delete_index(index_name)` - Delete an index
+- `get_index(index_name)` - Get index information
+- `get_cat_indices()` - List all indices
+
+### Document Operations
+
+- `get_document(index, doc_id)` - Retrieve a document
+- `get_source(index, doc_id)` - Get document source
+- `document_exists(index, doc_id)` - Check if document exists
+- `delete_by_query(index, query)` - Delete documents matching query
+
+### Search Operations
+
+- `search(index, query)` - Execute a search query
+- `search_ai(index, query_text)` - AI-powered natural language search
+- `msearch(queries)` - Multi-search across indices
+- `sql(query)` - Execute SQL query
+- `count(index, query)` - Count matching documents
+
+### Bulk Operations
+
+- `bulk_ingest(index, payload)` - Bulk index documents (NDJSON format)
+- `metrics(index, payload)` - Ingest metrics data
+
+### WebSocket
+
+- `websocket_connect(path, headers=None)` - Connect to WebSocket with SigV4 auth
+
+### Security APIs
+
+- `create_user()`, `get_user()`, `update_user()`, `delete_user()`, `list_users()`
+- `create_role()`, `get_role()`, `update_role()`, `delete_role()`, `list_roles()`
+- `create_role_mapping()`, `get_role_mapping()`, `update_role_mapping()`, `delete_role_mapping()`
+- `rotate_api_keys(username)` - Rotate user API keys
+
+## Authentication
+
+The SDK uses AWS SigV4 authentication. All requests are automatically signed with your access key and secret key. For WebSocket connections, authentication is provided via query parameters.
+
+## Error Handling
+
+```python
+from infino_sdk.lib import InfinoError
+
+try:
+    await sdk.get_document("index", "missing_doc")
+except InfinoError as e:
+    if e.status_code() == 404:
+        print("Document not found")
+    else:
+        print(f"Error: {e.message}")
+```
+
+## Requirements
+
+- Python 3.7+
+- requests
+- websockets
+- backoff
+
+## License
+
+See LICENSE file in the repository root.
+
+## Development & Publishing
+
+### Setup Development Environment
+```bash
+pip install -e .[dev]
+```
+
+### Pre-Publication Checklist
+
+Before publishing to PyPI, ensure:
+
+- [ ] Version number updated in `pyproject.toml` and `__init__.py`
+- [ ] CHANGELOG.md updated with release notes
+- [ ] README.md reviewed and accurate
+- [ ] LICENSE file present in package root
+- [ ] Dependencies verified and correct
+- [ ] Build succeeds: `python -m build`
+- [ ] Package installable locally: `pip install dist/*.whl`
+- [ ] Import works: `python -c "from infino_sdk import InfinoSDK; print('OK')"`
+- [ ] `twine check dist/*` passes without warnings
+
+### Publishing Workflow
+
+#### 1. Test with TestPyPI
+
+Build the package:
+```bash
+cd sdk/python
+python -m build
+```
+
+Check the distribution:
+```bash
+twine check dist/*
+```
+
+Upload to TestPyPI:
+```bash
+twine upload --repository testpypi dist/*
+```
+
+Test installation from TestPyPI:
+```bash
+pip install --index-url https://test.pypi.org/simple/ --no-deps infino-sdk
+python -c "from infino_sdk import InfinoSDK; print('Success!')"
+```
+
+#### 2. Publish to PyPI
+
+Once tested on TestPyPI, publish to production PyPI:
+
+```bash
+twine upload dist/*
+```
+
+Verify installation:
+```bash
+pip install infino-sdk
+```
+
+### Notes
+
+- Package name on PyPI: `infino-sdk` (kebab-case)
+- Import name in Python: `infino_sdk` (snake_case)
+- Always test on TestPyPI before production PyPI