poelis-sdk 0.4.2__tar.gz

poelis_sdk-0.4.2/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+      with:
+        version: "latest"
+
+    - name: Install dependencies
+      run: |
+        uv sync --dev
+
+    - name: Run linting with Ruff
+      run: |
+        uv run ruff check .
+
+    - name: Run import sort fix (I001) and type checks
+      run: |
+        uv run ruff check --select I --fix .
+
+    - name: Run tests with pytest (temporarily allow failures)
+      run: |
+        uv run pytest src/tests tests --maxfail=1 --disable-warnings --cov=src/poelis_sdk --cov-report=xml --cov-report=term --cov-fail-under=0 || true
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: false

poelis_sdk-0.4.2/.github/workflows/codeql.yml

@@ -0,0 +1,39 @@
+name: CodeQL
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+  schedule:
+    - cron: '0 2 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+

poelis_sdk-0.4.2/.github/workflows/publish-on-push.yml

@@ -0,0 +1,87 @@
+name: Publish on version bump
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'pyproject.toml'
+  workflow_dispatch: {}
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+      with:
+        version: 'latest'
+
+    - name: Extract version
+      id: v
+      run: |
+        VER=$(python -c "import tomllib;print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+        echo "version=$VER" >> $GITHUB_OUTPUT
+
+    - name: Check if tag exists
+      id: tag
+      run: |
+        if git rev-parse --verify --quiet refs/tags/v${{ steps.v.outputs.version }}; then
+          echo "exists=true" >> $GITHUB_OUTPUT
+        else
+          echo "exists=false" >> $GITHUB_OUTPUT
+        fi
+
+    - name: Create tag
+      if: steps.tag.outputs.exists == 'false'
+      run: |
+        git config user.name "github-actions"
+        git config user.email "github-actions@users.noreply.github.com"
+        git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
+        git tag v${{ steps.v.outputs.version }}
+        git push origin v${{ steps.v.outputs.version }}
+
+    - name: Install build tooling
+      run: |
+        uv sync --dev
+
+    - name: Build sdist and wheel
+      run: |
+        uv run python -m build
+
+    - name: List built packages
+      run: |
+        ls -la dist/
+        echo "Package contents:"
+        for pkg in dist/*; do
+          echo "Package: $pkg"
+          if [[ $pkg == *.whl ]]; then
+            unzip -l "$pkg" | head -10
+          elif [[ $pkg == *.tar.gz ]]; then
+            tar -tzf "$pkg" | head -10
+          fi
+        done
+
+    - name: Install twine
+      run: |
+        uv add twine
+
+    - name: Publish to PyPI with twine
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        uv run twine upload --skip-existing --verbose dist/*
+

poelis_sdk-0.4.2/.gitignore

@@ -0,0 +1,216 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+*.DS_Store
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+
+# Others
+.cursor/
+# Allow GitHub workflows
+!/.github/
+!/.github/workflows/
+!/.github/workflows/*.yml

poelis_sdk-0.4.2/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.

poelis_sdk-0.4.2/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: poelis-sdk
+Version: 0.4.2
+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.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
+
+```
+
+## 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.
+
+## Requirements
+
+- Python >= 3.11
+- API base URL reachable from your environment
+
+## License
+
+MIT

poelis_sdk-0.4.2/README.md

@@ -0,0 +1,105 @@
+# 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.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
+
+```
+
+## 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.
+
+## Requirements
+
+- Python >= 3.11
+- API base URL reachable from your environment
+
+## License
+
+MIT