ciaren-client 0.1.0__tar.gz

ciaren_client-0.1.0/.gitignore

@@ -0,0 +1,266 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+# …but keep the committed example signed plugin artifact (reproducible demo).
+!examples/plugins/dist/
+!examples/plugins/dist/*.ciarenplugin
+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/
+
+# Generated from the root CHANGELOG.md by docs/scripts/sync-changelog.js
+# (npm run predev / prebuild) — root file is the source of truth.
+docs/guide/changelog.md
+
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+.idea/
+.CLAUDE.md
+.architecture.md
+
+# Local AI assistant/tooling state (personal workspace only)
+.claude/
+.codex/
+.codex_tmp/
+.agents/
+backend/.claude/
+local.claude.md
+
+# Local-only maintainer notes/planning docs (not for VCS)
+internal/
+BRAND_GUIDELINES.md
+
+# Local dev databases / data dirs (SQLite default; not for VCS)
+*.db
+*.db-journal
+*.sqlite
+*.sqlite3
+*.sqlite-journal
+.data/
+backend/*.db
+backend/.dev_data/
+backend/.data/
+
+# MLflow local store + model artifacts (created by `ciaren init` / training)
+mlruns/
+mlartifacts/
+backend/mlruns/
+backend/mlartifacts/
+
+# Web UI bundled into the wheel at build time (generated from frontend/dist)
+backend/app/web/
+
+# Node (frontend/ and docs/ have their own ignores; this covers any root-level
+# node_modules created by running npm/vitest from the repo root)
+node_modules/
+.vite/

ciaren_client-0.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: ciaren-client
+Version: 0.1.0
+Summary: Python client for the Ciaren visual data and ML workflow server
+Project-URL: Homepage, https://www.ciaren.com/
+Project-URL: Repository, https://github.com/ciaren-labs/Ciaren
+Project-URL: Documentation, https://ciaren.com/docs
+Project-URL: Issues, https://github.com/ciaren-labs/Ciaren/issues
+Project-URL: Author, https://www.linkedin.com/in/rodrigo-arenas-gomez/
+Author-email: Rodrigo Arenas <31422766+rodrigo-arenas@users.noreply.github.com>
+License: Apache-2.0
+Keywords: api-client,ciaren,data,data-engineering,etl,ml,workflow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.24
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# ciaren-client
+
+`ciaren-client` is the lightweight Python SDK for Ciaren. It talks to the
+Ciaren REST API without installing the full application.
+
+> Status: alpha (pre-1.0), `0.1.0`. Breaking changes are expected before `1.0.0`.
+
+## Install
+
+```bash
+python -m pip install ciaren-client
+```
+
+For local development from this repository:
+
+```bash
+pip install -e path/to/Ciaren/client
+```
+
+## Quick Start
+
+```python
+from ciaren_client import Ciaren
+
+with Ciaren("http://localhost:8055", webhook_secret="my-secret") as client:
+    run = client.trigger("flow-id", parameters={"date": "2026-07-01"})
+    print(run["status"])
+```
+
+Async usage is available through `AsyncCiaren`:
+
+```python
+from ciaren_client import AsyncCiaren
+
+async with AsyncCiaren("http://localhost:8055", webhook_secret="my-secret") as client:
+    run = await client.trigger("flow-id")
+```
+
+## What It Covers
+
+The client includes typed sync and async methods for projects, datasets, flows,
+runs, schedules, connections (including OS-keychain secrets), catalog metadata,
+transformations, runtime app settings, ML helpers, plugins, marketplace
+endpoints, webhook triggers, and SSE run logs.
+
+Use `api_token` when the server is configured with `CIAREN_API_TOKEN`.
+Use `webhook_secret` only for `trigger()`, which calls the webhook endpoint.
+
+License: Apache-2.0.
+
+See the [SDK documentation](https://ciaren.com/docs/guide/sdk).

ciaren_client-0.1.0/README.md

@@ -0,0 +1,51 @@
+# ciaren-client
+
+`ciaren-client` is the lightweight Python SDK for Ciaren. It talks to the
+Ciaren REST API without installing the full application.
+
+> Status: alpha (pre-1.0), `0.1.0`. Breaking changes are expected before `1.0.0`.
+
+## Install
+
+```bash
+python -m pip install ciaren-client
+```
+
+For local development from this repository:
+
+```bash
+pip install -e path/to/Ciaren/client
+```
+
+## Quick Start
+
+```python
+from ciaren_client import Ciaren
+
+with Ciaren("http://localhost:8055", webhook_secret="my-secret") as client:
+    run = client.trigger("flow-id", parameters={"date": "2026-07-01"})
+    print(run["status"])
+```
+
+Async usage is available through `AsyncCiaren`:
+
+```python
+from ciaren_client import AsyncCiaren
+
+async with AsyncCiaren("http://localhost:8055", webhook_secret="my-secret") as client:
+    run = await client.trigger("flow-id")
+```
+
+## What It Covers
+
+The client includes typed sync and async methods for projects, datasets, flows,
+runs, schedules, connections (including OS-keychain secrets), catalog metadata,
+transformations, runtime app settings, ML helpers, plugins, marketplace
+endpoints, webhook triggers, and SSE run logs.
+
+Use `api_token` when the server is configured with `CIAREN_API_TOKEN`.
+Use `webhook_secret` only for `trigger()`, which calls the webhook endpoint.
+
+License: Apache-2.0.
+
+See the [SDK documentation](https://ciaren.com/docs/guide/sdk).

ciaren_client-0.1.0/ciaren_client/__init__.py

@@ -0,0 +1,65 @@
+"""ciaren-client — thin HTTP client for the Ciaren visual data and ML workflow server.
+
+Sync usage::
+
+    from ciaren_client import Ciaren
+
+    client = Ciaren("http://localhost:8055", webhook_secret="my-secret")
+    run = client.trigger("flow-id")
+    print(run["status"])
+
+Async usage::
+
+    from ciaren_client import AsyncCiaren
+
+    async with AsyncCiaren("http://localhost:8055", webhook_secret="my-secret") as client:
+        run = await client.trigger("flow-id")
+        async for line in client.stream_logs(run["id"]):
+            print(line)
+"""
+
+from ciaren_client._async import AsyncCiaren
+from ciaren_client._sync import Ciaren
+from ciaren_client._types import (
+    AppSetting,
+    CodeExport,
+    Connection,
+    ConnectionTestResult,
+    Dataset,
+    DatasetVersion,
+    Flow,
+    FlowDocument,
+    FlowMigrationResult,
+    JsonDict,
+    KeyringAvailability,
+    KeyringSecretStatus,
+    Project,
+    Run,
+    RunStatus,
+    Schedule,
+    WebhookStatus,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "AppSetting",
+    "AsyncCiaren",
+    "Ciaren",
+    "CodeExport",
+    "Connection",
+    "ConnectionTestResult",
+    "Dataset",
+    "DatasetVersion",
+    "Flow",
+    "FlowDocument",
+    "FlowMigrationResult",
+    "JsonDict",
+    "KeyringAvailability",
+    "KeyringSecretStatus",
+    "Project",
+    "Run",
+    "RunStatus",
+    "Schedule",
+    "WebhookStatus",
+]