vermillio-sdk 0.0.6__tar.gz

vermillio_sdk-0.0.6/.editorconfig

@@ -0,0 +1,23 @@
+# Check http://editorconfig.org for more information
+# This is the main config file for this project:
+root = true
+
+[*]
+charset = utf-8
+trim_trailing_whitespace = true
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+indent_size = 2
+
+[*.{py,pyi}]
+indent_size = 4
+
+[*.snap]
+trim_trailing_whitespace = false
+
+[*.md]
+max_line_length = 100
+
+[*.toml]
+indent_size = 4

vermillio_sdk-0.0.6/.gitignore

@@ -0,0 +1,179 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# 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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# 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
+.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/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python
+
+.uv-cache
+public/

vermillio_sdk-0.0.6/.gitlab-ci.yml

@@ -0,0 +1,121 @@
+stages:
+  - build
+  - deploy
+
+
+default:
+  image: python:3.9
+  before_script:
+    - curl -LsSf https://astral.sh/uv/install.sh | sh
+    - export PATH="$HOME/.local/bin:$PATH"
+
+variables:
+  UV_CACHE_DIR: ".uv-cache"
+  UV_SYSTEM_PYTHON: 1
+  GIT_DEPTH: 0
+
+cache:
+  paths:
+    - .uv-cache
+
+build:
+  stage: build
+  script:
+    - uv run publish.py --no-publish
+    - uv sync --group docs
+    - export BUILD_DATE=$(date -u +"%Y-%m-%d %H:%M UTC")
+    - export SITE_VERSION=${CI_COMMIT_TAG:-$CI_COMMIT_SHORT_SHA}
+    - BUILD_DATE="$BUILD_DATE" VERSION="$SITE_VERSION" uv run mkdocs build --site-dir public
+    - echo "Review docs at https://vermillio-public.gitlab.io/-/vermillio-sdk/-/jobs/${CI_JOB_ID}/artifacts/public/index.html"
+  artifacts:
+    expire_in: 1 week
+    paths:
+      - dist
+      - public
+  environment:
+    name: docs/$CI_COMMIT_REF_SLUG
+    url: https://vermillio-public.gitlab.io/-/vermillio-sdk/-/jobs/${CI_JOB_ID}/artifacts/public/index.html
+
+deploy:pages:
+  stage: deploy
+  dependencies: [build]
+  rules:
+    - if: $CI_COMMIT_REF_PROTECTED == "true"
+      when: manual
+    - when: never
+  script:
+    - echo "Docs available at https://docs.vermill.io"
+  pages: true
+  environment:
+    name: docs
+    url: https://docs.vermill.io
+
+deploy:gitlab:
+  stage: deploy
+  dependencies: [build]
+  variables:
+    UV_PUBLISH_URL: "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi"
+    UV_PUBLISH_USERNAME: "gitlab-ci-token"
+    UV_PUBLISH_PASSWORD: "${CI_JOB_TOKEN}"
+  script:
+    - uv run publish.py --publish --no-build --no-version
+    - echo "Deployed to https://gitlab.com/vermillio-public/vermillio-sdk/-/packages"
+  rules:
+    - if: $CI_COMMIT_TAG && $CI_COMMIT_REF_PROTECTED == "true"
+      when: manual
+    - when: never
+  environment:
+    name: gitlab
+    url: https://gitlab.com/vermillio-public/vermillio-sdk/-/packages
+
+deploy:pypi:
+  stage: deploy
+  dependencies: [build]
+  variables:
+    UV_PUBLISH_TOKEN: $PYPI_TOKEN 
+  script:
+    - uv run publish.py --publish --no-build --no-version
+    - echo "Deployed to https://pypi.org/org/vermillio/"
+  rules:
+    - if: $CI_COMMIT_TAG && $CI_COMMIT_REF_PROTECTED == "true"
+      when: manual
+    - when: never
+  environment:
+    name: pypi
+    url: https://pypi.org/org/vermillio/
+
+deploy:dry-run:
+  stage: deploy
+  dependencies: [build]
+  script:
+    - uv run publish.py --publish --no-build --no-version --dry-run --verbose
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: never
+    - if: $CI_COMMIT_TAG && $CI_COMMIT_REF_PROTECTED == "true"
+      when: never
+    - when: manual
+
+# Given sdk lives in vermillio-public and not included in our gitlab plan we can't use parallel deployments
+# create-pages:
+#   variables:
+#     PAGES_PREFIX: "" # no prefix by default (run on the default branch)
+#   before_script:
+#     - curl -LsSf https://astral.sh/uv/install.sh | sh
+#     - export PATH="$HOME/.local/bin:$PATH"
+#   script:
+#     - uv sync --group docs
+#     - uv run mkdocs build --site-dir public
+#   pages:  # specifies that this is a Pages job and publishes the default public directory
+#     path_prefix: "$PAGES_PREFIX"
+#   environment:
+#     name: "Pages ${PAGES_PREFIX}"
+#     url: $CI_PAGES_URL
+#   rules:
+#     - if: $CI_COMMIT_BRANCH != "main" # ensure to run on the default branch (with default PAGES_PREFIX)
+#       variables:
+#         PAGES_PREFIX: "$CI_COMMIT_BRANCH"
+#     - if: $CI_PIPELINE_SOURCE == "merge_request_event" # conditionally change the prefix on Merge Requests
+#       when: manual # run pages manually on Merge Requests
+#       variables:
+#         PAGES_PREFIX: 'mr-$CI_MERGE_REQUEST_IID' # prefix with the mr-<iid>, like `mr-123`

vermillio_sdk-0.0.6/.python-version

@@ -0,0 +1 @@
+3.9

vermillio_sdk-0.0.6/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: vermillio-sdk
+Version: 0.0.6
+Summary: SDKs for interacting with Vermillio's various APIs.
+Project-URL: Homepage, https://vermill.io
+Project-URL: Documentation, https://docs.vermill.io
+Project-URL: Repository, https://gitlab.com/vermillio-public/vermillio-sdk.git
+Project-URL: Issues, https://gitlab.com/vermillio-public/vermillio-sdk/-/issues
+Requires-Python: >=3.9
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: vermillio-core-sdk==0.0.6
+Provides-Extra: guardrails
+Requires-Dist: vermillio-guardrails-sdk==0.0.6; extra == 'guardrails'
+Provides-Extra: ml
+Requires-Dist: vermillio-ml-sdk==0.0.6; extra == 'ml'
+Provides-Extra: music
+Requires-Dist: vermillio-music-sdk==0.0.6; extra == 'music'
+Description-Content-Type: text/markdown
+
+# Vermillio SDK
+
+Entrypoint for Vermillio's various SDK's for interacting with Vermillio API's.
+
+## Guardrails SDK
+
+### Installing
+
+```bash
+pip install vermillio-sdk[guardrails]
+uv add vermillio-sdk[guardrails]
+```
+
+
+### Getting Started
+
+```python
+from vermillio.sdk.guardrails import VermillioGuardrails, GuardrailsExternalSource
+
+client = VermillioGuardrails()
+
+sources = [
+    GuardrailsExternalSource(
+        prompt="Write a song about a flying hero from Krypton.",
+    )
+]
+
+results = client.run_results(sources)
+if results:
+    first = results[0]
+    print(first.summary)
+```
+
+## Music SDK
+
+### Installing
+
+```bash
+pip install vermillio-sdk[music]
+uv add vermillio-sdk[music]
+```
+
+### Getting Started
+
+```python
+from vermillio.sdk.music import VermillioMusicAIDetect, AIDetectExternalSource
+
+ai_detect = VermillioMusicAIDetect()
+result = next(iter(ai_detect.run_results([
+    AIDetectExternalSource(path="https://example.com/track.wav"),
+] or [])), None)
+
+if result and result.status == 'Succeeded':
+    for detection in result.results.detections:
+        confidence = f"({detection.confidence:0.2f})" if detection.confidence else "--"
+        print(f"[{detection.query_segment.start:0.2f}-{detection.query_segment.end:0.2f}] {segment.label} {confidence}")
+```

vermillio_sdk-0.0.6/README.md

@@ -0,0 +1,57 @@
+# Vermillio SDK
+
+Entrypoint for Vermillio's various SDK's for interacting with Vermillio API's.
+
+## Guardrails SDK
+
+### Installing
+
+```bash
+pip install vermillio-sdk[guardrails]
+uv add vermillio-sdk[guardrails]
+```
+
+
+### Getting Started
+
+```python
+from vermillio.sdk.guardrails import VermillioGuardrails, GuardrailsExternalSource
+
+client = VermillioGuardrails()
+
+sources = [
+    GuardrailsExternalSource(
+        prompt="Write a song about a flying hero from Krypton.",
+    )
+]
+
+results = client.run_results(sources)
+if results:
+    first = results[0]
+    print(first.summary)
+```
+
+## Music SDK
+
+### Installing
+
+```bash
+pip install vermillio-sdk[music]
+uv add vermillio-sdk[music]
+```
+
+### Getting Started
+
+```python
+from vermillio.sdk.music import VermillioMusicAIDetect, AIDetectExternalSource
+
+ai_detect = VermillioMusicAIDetect()
+result = next(iter(ai_detect.run_results([
+    AIDetectExternalSource(path="https://example.com/track.wav"),
+] or [])), None)
+
+if result and result.status == 'Succeeded':
+    for detection in result.results.detections:
+        confidence = f"({detection.confidence:0.2f})" if detection.confidence else "--"
+        print(f"[{detection.query_segment.start:0.2f}-{detection.query_segment.end:0.2f}] {segment.label} {confidence}")
+```

vermillio_sdk-0.0.6/config.yml

@@ -0,0 +1,10 @@
+name: data-transfer-ws
+cpu: 2
+memory: 1Gi
+min: 0
+max: 1000
+throttle: 'false'
+env:
+  BUCKET: "{project}.appspot.com"
+deploy_args: 
+  - '--use-http2'

vermillio_sdk-0.0.6/docs/.pages

@@ -0,0 +1,6 @@
+title: Vermillio SDK
+nav:
+- index.md
+- sdk
+- guardrails
+- music

vermillio_sdk-0.0.6/docs/README.md

@@ -0,0 +1,45 @@
+# Docs
+
+
+Ref: https://vermillio.atlassian.net/wiki/spaces/~486166302/pages/1320353828/Vermillio+SDK+Documentation
+
+
+https://www.mkdocs.org/getting-started/
+
+uv sync --group docs
+
+uv run mkdocs build
+uv run mkdocs serve
+mkdocs serve
+
+
+mkdocs build
+
+
+## Examples
+
+- Ray: https://docs.ray.io/
+- DVC (Data Version Control): https://dvc.org/doc
+- Poetry: https://python-poetry.org/docs/
+- MkDocs Awesome Pages Plugin: https://lukasgeiter.github.io/mkdocs-awesome-pages-plugin/
+- Home Assistant Developer Docs: https://developers.home-assistant.io/
+- OpenFaaS: https://docs.openfaas.com/
+- FastAPI: https://fastapi.tiangolo.com/
+- Pydantic: https://docs.pydantic.dev/
+- MKDocs Material: https://squidfunk.github.io/mkdocs-material/
+
+
+## Investigate
+
+- https://zensical.org/
+- OpenAPI spec integration for interactive API
+- Docusaurus
+
+
+## OpenAPI integration
+
+Using Scalar
+
+```bash
+npx @redocly/cli@latest join ./docs/openapi_specs/external-api.yaml ./docs/openapi_specs/petstore.yaml -o ./docs/openapi_specs/combined.yaml
+```

vermillio_sdk-0.0.6/docs/assets/scalar.html

@@ -0,0 +1,21 @@
+<!doctype html>
+<html>
+  <head>
+    <title>API Reference</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style>
+      body { margin: 0; padding: 0; }
+    </style>
+  </head>
+  <body>
+    <script
+      id="api-reference"
+      data-url="../openapi_specs/guardrails.json"
+      
+      src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"
+    ></script>
+  </body>
+  <!-- data-proxy-url="https://proxy.scalar.com" -->
+</html>
+

vermillio_sdk-0.0.6/docs/guardrails/.pages

@@ -0,0 +1,5 @@
+title: Guardrails SDK
+nav:
+- getting-started.md
+- reference.md
+- api.md

vermillio_sdk-0.0.6/docs/guardrails/api.md

@@ -0,0 +1,13 @@
+---
+hide:
+  - toc
+title: API Reference
+---
+# Guardrails API Reference
+
+<!-- <iframe 
+    src="../assets/scalar.html" 
+    style="width:100%; height:800px; border:none; overflow:hidden;" scrolling="no"
+></iframe> -->
+
+<swagger-ui  src="./guardrails.json"/>

vermillio_sdk-0.0.6/docs/guardrails/getting-started.md

@@ -0,0 +1,65 @@
+---
+title: Getting Started
+---
+
+# Guardrails SDK
+<!-- [![CI](https://gitlab.com/vermillio-public/vermillio-sdk/badges/main/pipeline.svg)](https://gitlab.com/vermillio-public/vermillio-sdk/-/commits/main)
+[![pypi](https://img.shields.io/pypi/v/vermillio-sk.svg)](https://pypi.python.org/pypi/vermillio-sdk) -->
+
+## Installation
+
+Vermillio Guardrails SDK is published as a Python package and can be installed ideally within a virtual environment. Vermillio Guardrails SDK requires __Python 3.9+__.
+
+<!-- === "pip"
+
+    ```bash
+    pip install vermillio-sdk[guardrails]
+    ```
+
+=== "uv"
+
+    ```bash
+    uv add vermillio-sdk[guardrails]
+    ``` -->
+
+
+/// tab | pip
+```bash
+pip install vermillio-sdk[guardrails]
+```
+///
+
+/// tab | uv
+```bash
+uv add vermillio-sdk[guardrails]
+```
+///
+
+## Configuration
+
+The client loads credentials from environment variables by default:
+
+- `VERMILLIO_SDK_CLIENT_ID` : Client id provided by Vermillio
+- `VERMILLIO_SDK_CLIENT_SECRET` : Client secret provided by Vermillio
+
+For full documentation, see [Authentication](../sdk/authentication.md#sdk-authentication) for a more detailed description.
+
+## Initialization
+
+All of the classes for Guardrails SDK live under `vermillio.sdk.guardrails`. Here is an example usage:
+
+```python
+from vermillio.sdk.guardrails import VermillioGuardrails, GuardrailsExternalSource
+
+guardrails = VermillioGuardrails() # The default behavior is to pull from env
+# alternatively a VermillioConfig class can be provided
+# guardrails = VermillioGuardrails(VermillioConfig.credentials(client_id, client_secret))
+
+result = next(iter(guardrails.run_results([
+    GuardrailsExternalSource(prompt="Write a song about a flying hero from Krypton.", lyrics="Hit me baby one more time.")
+] or []), None)
+
+if result and result.status == 'Succeeded':
+    print(f"Recommended action: {result.action}")
+    print(f"Identified profiles: {result.summary.profiles}")
+```