poelis-sdk 0.3.5__py3-none-any.whl → 0.3.6__py3-none-any.whl

poelis_sdk-0.3.6.dist-info/METADATA

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: poelis-sdk
+Version: 0.3.6
+Summary: Official Python SDK for Poelis
+Project-URL: Homepage, https://poelis.com
+Project-URL: Source, https://github.com/PoelisTechnologies/poelis-python-sdk
+Project-URL: Issues, https://github.com/PoelisTechnologies/poelis-python-sdk/issues
+Author-email: Matteo Braceschi <matteo@poelis.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,client,poelis,sdk
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: build>=1.3.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.7
+Requires-Dist: twine>=6.2.0
+Description-Content-Type: text/markdown
+
+# Poelis Python SDK
+
+Python SDK for Poelis - explore your data with simple dot notation.
+
+## Installation
+
+```bash
+pip install -U poelis-sdk
+```
+
+Requires Python 3.11+.
+
+## Quick Start
+
+```python
+from poelis_sdk import PoelisClient
+
+# Create client
+poelis = PoelisClient(
+    api_key="poelis_live_A1B2C3...",    # Get from Organization Settings → API Keys
+    org_id="tenant_uci_001",            # Same section
+)
+
+# Use the browser for easy exploration
+poelis = poelis.browser  # Now you can use dot notation!
+
+# Explore your data
+poelis.workspace_name.product_name.item_name
+```
+
+## Getting Your Credentials
+
+1. Go to **Organization Settings → API Keys**
+2. Click **"Create API key"** (read-only recommended)
+3. Copy the key (shown only once) and your `org_id`
+4. Store securely as environment variables:
+
+```bash
+export POELIS_API_KEY=poelis_live_A1B2C3...
+export POELIS_ORG_ID=tenant_uci_001
+```
+
+## Browser Usage
+
+The browser lets you navigate your Poelis data with simple dot notation:
+
+```python
+# Navigate through your data
+poelis = poelis.browser
+
+# List workspaces
+poelis.names()  # ['workspace1', 'workspace2', ...]
+
+# Access workspace
+ws = poelis.workspace1
+
+# List products in workspace  
+ws.names()  # ['product1', 'product2', ...]
+
+# Access product
+product = ws.product1
+
+# List items in product
+product.names()  # ['item1', 'item2', ...]
+
+# Access item and its properties
+item = product.item1
+item_value = item.some_property.value  # Access property values directly
+item_category = item.some_property.category  # Access property categories directly
+
+```
+
+## IDE Compatibility & Autocomplete
+
+The Poelis SDK works in all Python environments, but autocomplete behavior varies by IDE:
+
+### ✅ VS Code (Recommended for Notebooks)
+- **Autocomplete**: Works perfectly with dynamic attributes
+- **Setup**: No configuration needed
+- **Experience**: Full autocomplete at all levels
+
+### ⚠️ PyCharm (Jupyter Notebooks)
+- **Autocomplete**: Limited - PyCharm uses static analysis and doesn't see dynamic attributes
+- **Code execution**: Works perfectly (attributes are real and functional)
+- **Workaround**: Call `names()` at each level to prime autocomplete
+
+## Examples
+
+See `notebooks/try_poelis_sdk.ipynb` for complete examples including authentication, data exploration, and search queries.
+
+## Requirements
+
+- Python >= 3.11
+- API base URL reachable from your environment
+
+## License
+
+MIT

{poelis_sdk-0.3.5.dist-info → poelis_sdk-0.3.6.dist-info}/RECORD

@@ -10,7 +10,7 @@ poelis_sdk/org_validation.py,sha256=c4fB6ySTvcovWxG4F1wU_OBlP-FyuIaAUzCwqgJKzBE,
 poelis_sdk/products.py,sha256=wmh0Jh1_k9SNN_w2M_dMy1cpu56LGesAFKF99kOIuNU,3240
 poelis_sdk/search.py,sha256=3DqFd7ilTpizjOYgWplR7MTslnY89Q8AmUfn865TnKc,4113
 poelis_sdk/workspaces.py,sha256=_6cic97ByvNckmbaaTUS-5QpgvQcZZfBY-wMwsuTTxU,2383
-poelis_sdk-0.3.5.dist-info/METADATA,sha256=e8OaUspKDtJ6GAkRUXeAeRdgo0-qvLv6-hVbKNnoZlQ,2968
-poelis_sdk-0.3.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-poelis_sdk-0.3.5.dist-info/licenses/LICENSE,sha256=EEmE_r8wk_pdXB8CWp1LG6sBOl7--hNSS2kV94cI6co,1075
-poelis_sdk-0.3.5.dist-info/RECORD,,
+poelis_sdk-0.3.6.dist-info/METADATA,sha256=ke2cZa5Dm3Xy9zcRvE_mDnMrR_l3-VAgtB6mfvY9vWw,3259
+poelis_sdk-0.3.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+poelis_sdk-0.3.6.dist-info/licenses/LICENSE,sha256=EEmE_r8wk_pdXB8CWp1LG6sBOl7--hNSS2kV94cI6co,1075
+poelis_sdk-0.3.6.dist-info/RECORD,,

poelis_sdk-0.3.5.dist-info/METADATA

@@ -1,99 +0,0 @@
-Metadata-Version: 2.4
-Name: poelis-sdk
-Version: 0.3.5
-Summary: Official Python SDK for Poelis
-Project-URL: Homepage, https://poelis.com
-Project-URL: Source, https://github.com/PoelisTechnologies/poelis-python-sdk
-Project-URL: Issues, https://github.com/PoelisTechnologies/poelis-python-sdk/issues
-Author-email: Matteo Braceschi <matteo@poelis.com>
-License-Expression: MIT
-License-File: LICENSE
-Keywords: api,client,poelis,sdk
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.11
-Requires-Dist: build>=1.3.0
-Requires-Dist: httpx>=0.27
-Requires-Dist: pydantic>=2.7
-Requires-Dist: twine>=6.2.0
-Description-Content-Type: text/markdown
-
-# Poelis Python SDK
-
-Python SDK for Poelis.
-
-## Installation
-
-```bash
-pip install -U poelis-sdk
-```
-
-Requires Python 3.11+.
-
-## Quickstart (API key + org ID)
-
-```python
-from poelis_sdk import PoelisClient
-
-client = PoelisClient(
-    api_key="poelis_live_A1B2C3...",    # Organization Settings → API Keys
-    org_id="tenant_uci_001",            # same section
-)
-```
-
-## Configuration
-
-### Getting your API key and org ID
-
-1. Navigate to Organization Settings → API Keys.
-2. Click “Create API key”, choose a name and scopes (read-only by default recommended).
-3. Copy the full key when shown (it will be visible only once). Keep it secret.
-4. The `org_id` for your organization is displayed in the same section.
-5. You can rotate or revoke keys anytime. Prefer storing as env vars:
-
-```bash
-export POELIS_API_KEY=poelis_live_A1B2C3...
-export POELIS_ORG_ID=tenant_id_001
-```
-
-
-### How authentication works
-
-The SDK does not talk to Auth0. It sends your API key directly to the Poelis backend for validation on every request.
-
-- Default headers sent by the SDK:
-
-  - `X-API-Key: <api_key>` (and `X-Poelis-Api-Key` as a compatibility alias)
-  - `Authorization: Api-Key <api_key>` (compatibility for gateways expecting Authorization-only)
-  - `X-Poelis-Org: <org_id>`
-
-You can opt into Bearer mode (legacy) by setting `POELIS_AUTH_MODE=bearer`, which will send:
-
-  - `Authorization: Bearer <api_key>`
-  - `X-Poelis-Org: <org_id>`
-
-The backend validates the API key against your organization, applies authorization and filtering, and returns data.
-
-
-## Dot-path browser (Notebook UX)
-
-The SDK exposes a dot-path browser for easy exploration:
-
-```python
-client.browser  # then use TAB to explore
-# client.browser.<workspace>.<product>.<item>.<child>.properties
-```
-
-See the example notebook in `notebooks/try_poelis_sdk.ipynb` for an end-to-end walkthrough (authentication, listing workspaces/products/items, and simple search queries). The client defaults to `https://api.poelis.ai` unless `POELIS_BASE_URL` is set.
-
-## Requirements
-
-- Python >= 3.11
-- API base URL reachable from your environment
-
-## License
-
-MIT