poelis-sdk 0.5.4__py3-none-any.whl

poelis_sdk-0.5.4.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: poelis-sdk
+Version: 0.5.4
+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.
+
+## 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 the relevant `list_*().names` at each level to prime autocomplete
+
+## Examples
+
+See `notebooks/try_poelis_sdk.ipynb` for complete examples including authentication, data exploration, and search queries.
+
+## Installation
+
+- Python >= 3.11
+- API base URL reachable from your environment
+
+```bash
+pip install -U poelis-sdk
+```
+
+## Quick Start
+
+1. Go to **Organization Settings → API Keys**
+2. Click **\"Create API key\"**
+3. Copy the key (shown only once) and store it securely, for example as an environment variable:
+
+```python
+from poelis_sdk import PoelisClient
+
+# Create client
+poelis_client = PoelisClient(
+    api_key="poelis_live_A1B2C3...",    # Get from Organization Settings → API Keys
+)
+```
+
+## Browser Usage
+
+The browser lets you navigate your Poelis data with simple dot notation:
+
+```python
+# Navigate through your data
+poelis = poelis_client.browser
+
+# List workspaces
+poelis.list_workspaces().names  # ['workspace1', 'workspace2', ...]
+
+# Access workspace
+ws = poelis.workspace1
+
+# List products in workspace  
+ws.list_products().names  # ['product1', 'product2', ...]
+
+# Access product
+product = ws.product1
+
+# List items in product
+product.list_items().names  # ['item1', 'item2', ...]
+
+# Access item and its properties
+item = product.item1
+
+# List children by type for more control
+item.list_items().names       # ['child_item1', 'child_item2'] - only child items
+item.list_properties().names  # ['Color', 'Weight', ...] - only properties
+
+# Access property values directly
+item_value = item.some_property.value  # Access property values directly
+item_category = item.some_property.category  # Access property categories directly
+item_unit = item.some_property.unit  # Access property units directly
+```
+
+## Property Change Detection
+
+The SDK can automatically warn you when property values change between script/notebook runs. This is useful when you're using property values for calculations and want to be notified if a colleague changes them in the webapp.
+
+
+## License
+
+MIT

poelis_sdk-0.5.4.dist-info/RECORD

@@ -0,0 +1,18 @@
+poelis_sdk/__init__.py,sha256=7nLSHnIDePEtOM3-QFIvcahcbqXmemtctMuOWcKp-zo,924
+poelis_sdk/_transport.py,sha256=IW4A6ix24mmy7AMjhiGInzsK0DIuz1RmUNTB6MRQolA,5818
+poelis_sdk/browser.py,sha256=ieo5I0GPKJb_gOenelL2h2A5YTV03rk0jhsqWmhPwQ0,94681
+poelis_sdk/change_tracker.py,sha256=4d2LyTVAmF9W6eWUMtsZEPgIB-cixbJ98n2jW5TwTio,32726
+poelis_sdk/client.py,sha256=DsiwIVG3l6kHTCg11cvBOuMsug8ZUmFXfzSq5TfFaUE,7302
+poelis_sdk/exceptions.py,sha256=qX5kpAr8ozJUOW-CNhmspWVIE-bvUZT_PUnimYuBxNY,1101
+poelis_sdk/items.py,sha256=LR5InWLZFvWuTN2iWH-sRYc37vXJXv31M1NVFSTVFLM,4219
+poelis_sdk/logging.py,sha256=zmg8Us-7qjDl0n_NfOSvDolLopy7Dc_hQ-pcrC63dY8,2442
+poelis_sdk/models.py,sha256=ohQvimy2UzcIl8ZW42mCvIm0vw2kqn6liT3nLV1FT94,6871
+poelis_sdk/org_validation.py,sha256=YWqw0Fyf_U7gJljvbxjnVcOo-hdhSNlG-_OSG00-6aA,6002
+poelis_sdk/products.py,sha256=kaVQGR4HLodojqNSlOEqdGiqT-7IkQ4PeALwfjza2fo,6391
+poelis_sdk/search.py,sha256=hQcQg2bJkv8TDk1zd2E1F6sa-QIGpNpRPno2Le6ZZWM,4079
+poelis_sdk/versions.py,sha256=RpfsOIrQHQSMctIMacFID65ogIAOj-BLpoV3O21JCXE,3814
+poelis_sdk/workspaces.py,sha256=fIxr3OXe0xfqqbMJTJgZne0JUx6HAcHJ8BJ4DUKfzd4,1594
+poelis_sdk-0.5.4.dist-info/METADATA,sha256=gEn6OsKRqAe6EjynBgJTN_24GIx3FhSjBFzHkrpykL4,3493
+poelis_sdk-0.5.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+poelis_sdk-0.5.4.dist-info/licenses/LICENSE,sha256=EEmE_r8wk_pdXB8CWp1LG6sBOl7--hNSS2kV94cI6co,1075
+poelis_sdk-0.5.4.dist-info/RECORD,,

poelis_sdk-0.5.4.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

poelis_sdk-0.5.4.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 PoelisTechnologies
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.