onyx-database 0.0.1__tar.gz

onyx_database-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install package (editable)
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .
+
+      - name: Compile sources
+        run: python -m py_compile $(find onyx_database tests -name '*.py')
+
+      - name: Run unit tests
+        run: python -m unittest discover tests

onyx_database-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: read
+  id-token: write  # required for trusted publisher OIDC
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tooling
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

onyx_database-0.0.1/.gitignore

@@ -0,0 +1,221 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# 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__/
+.venv/
+__pycache__/
+*.pyc
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.DS_Store
+.vscode/
+config/onyx-database.json
+onyx-database.json
+examples/onyx-database.json
+onyx/
+examples/onyx/

onyx_database-0.0.1/.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "debug example",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${file}",
+      "console": "integratedTerminal",
+      "env": {
+        "PYTHONPATH": "${workspaceFolder}",
+        "ONYX_DEBUG": "true"
+      },
+      "justMyCode": true,
+      "preLaunchTask": "onyx: prep"
+    }
+  ]
+}

onyx_database-0.0.1/.vscode/tasks.json

@@ -0,0 +1,33 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "onyx: ensure env",
+      "type": "shell",
+      "command": "source .venv/bin/activate && python -m pip install -e . && python -m py_compile $(find onyx_database -name '*.py')",
+      "presentation": {
+        "reveal": "always",
+        "panel": "shared",
+        "clear": true
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "onyx: gen",
+      "type": "shell",
+      "command": "source .venv/bin/activate && onyx-py gen",
+      "presentation": {
+        "reveal": "always",
+        "panel": "shared",
+        "clear": true
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "onyx: prep",
+      "dependsOn": ["onyx: ensure env", "onyx: gen"],
+      "dependsOrder": "sequence",
+      "problemMatcher": []
+    }
+  ]
+}

onyx_database-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,127 @@
+# Contributing to onyx-database-python
+
+Thanks for helping build the Onyx Database Python SDK. This guide walks you from checkout to shipping changes with the same flows used in the TypeScript SDK.
+
+# Quick start on macOS (fresh machine)
+```bash
+
+# first time setup
+xcode-select --install                                    # command line tools (once)
+brew install python@3.11 pipx                             # Python + pipx from Homebrew
+python3 -m venv .venv && source .venv/bin/activate        # isolate from PEP 668 protections
+python -m pip install --upgrade pip                       # upgrade pip inside the venv
+git clone https://github.com/OnyxDevTools/onyx-database-python.git
+cd onyx-database-python
+
+# building and installing locally
+python -m pip install -e .                                # install SDK + CLI locally
+python -m py_compile $(find onyx_database -name '*.py')   # quick sanity check
+# Download onyx-database.json from https://cloud.onyx.dev and save to ./config/onyx-database.json
+onyx-py info                                              # user this to verify your installation and connection
+onyx-py schema get                                        # fetch schema (writes ./schema/onyx.schema.json)
+onyx-py gen --out ./onyx                                  # generate the onyx/ package used by examples
+python examples/seed.py                                   # creates sample data that the examples depend on
+python examples/query/basic.py                            # run a sample
+ # Optional: set ONYX_DEBUG=true to log requests/responses
+```
+
+## If you make a code change, you just need to: 
+pip install -e .
+python -m py_compile $(find onyx_database -name '*.py')
+## or this is done for you if you run an example using the vscode/launch.json config `debug example`
+
+
+##  Writing code with the SDK
+- Initialize using your config: 
+  ```py
+  from onyx_database import onyx
+  db = onyx.init()  # uses onyx-database.json via the resolver chain
+  ```
+- Simple save and query (drop into `examples/` or your app):
+  ```py
+  from onyx_database import eq, asc
+
+  db.save("User", {"id": "user_1", "email": "a@example.com", "status": "active"})
+  users = (
+      db.from_table("User")
+        .where(eq("status", "active"))
+        .order_by(asc("createdAt"))
+        .limit(10)
+        .list()
+  )
+  ```
+
+## Configuring credentials
+- Preferred locations (checked in order): `./config/onyx-database.json`, then `./onyx-database.json`
+- Obtain the file from https://cloud.onyx.dev (API Keys -> download `onyx-database.json`) and place it under `./config/`
+- Fallbacks: set `ONYX_CONFIG_PATH` to an absolute/relative JSON file; home profiles are also read if present.
+- Schema defaults: `./schema/onyx.schema.json` or `./onyx.schema.json`
+
+## CLI (codegen + schema)
+- From checkout: `python3 -m pip install -e .` exposes `onyx-py`
+- Or globally via pipx: `pipx install .`
+- Check help: `onyx-py --help`, `onyx-py gen --help`, `onyx-py schema --help`
+
+```
++---------------------+---------------------------------------------+--------------------------------------------------------------+
+| Command             | Flags                                       | Defaults / notes                                             |
++---------------------+---------------------------------------------+--------------------------------------------------------------+
+| onyx-py info        | --json                                      | Shows DB ID, base URL, masked keys, config path, status.     |
+|                     |                                             | Uses standard config resolution.                             |
++---------------------+---------------------------------------------+--------------------------------------------------------------+
+| onyx-py schema get  | --out <path>                                | Writes ./schema/onyx.schema.json if --out not set.           |
+|                     | --tables a,b                                | Creates schema/ if missing. --print skips writing.           |
+|                     | --print                                     |                                                              |
++---------------------+---------------------------------------------+--------------------------------------------------------------+
+| onyx-py schema publish | --schema <path>                          | Reads ./schema/onyx.schema.json (or ./onyx.schema.json)      |
+|                        |                                           | by default; publishes to API.                               |
++---------------------+---------------------------------------------+--------------------------------------------------------------+
+| onyx-py schema validate | --schema <path>                         | Validates local schema file (same default path as publish).  |
++---------------------+---------------------------------------------+--------------------------------------------------------------+
+| onyx-py schema diff | --schema <path>                             | Diffs local schema (same default path as publish) vs remote. |
++---------------------+---------------------------------------------+--------------------------------------------------------------+
+| onyx-py gen         | --source api|file (default file)            | Generates models/tables/schema helpers.                      |
+|                     | --schema <path> (default ./schema/onyx.schema.json | Multiple --out allowed (repeat or space-separated).   |
+|                     |    or ./onyx.schema.json)                   | Default package inferred from final folder name of each      |
+|                     | --out <paths...> (default ./onyx)           | --out when --package is omitted.                             |
+|                     | --package <name>                            |                                                              |
+|                     | --timestamps datetime|string|number         | Default timestamps: datetime.                                |
++---------------------+---------------------------------------------+--------------------------------------------------------------+
+```
+
+## 10) Release / publish the library
+- Bump version in `pyproject.toml` (and any `_version.py` once added)
+- Build: `python -m build`
+- Publish: `twine upload dist/*`
+
+## 11) Install the public package
+- `pip install onyx-database-python`
+- For CLI-only without touching a venv: `pipx install onyx-database-python`
+
+## CLI tools (schema + codegen)
+Install the CLI (`onyx-py`) locally or globally, then use `schema` / `gen`:
+
+Install:
+- In repo venv: `python -m pip install -e .`
+- Global (isolated) from this checkout: `pipx install .` (PyPI name not published yet). If pipx warns about PATH, run `pipx ensurepath`
+- Verify: `onyx-py --help`
+
+Schema commands:
+- Download remote schema: `onyx-py schema get` (writes `./schema/onyx.schema.json` by default)
+- Print only: `onyx-py schema get --print`
+- Publish local schema: `onyx-py schema publish --schema ./schema/onyx.schema.json`
+- Validate/diff: `onyx-py schema validate <path>`, `onyx-py schema diff <path>`
+
+Codegen commands:
+- From API: `onyx-py gen --source api --out ./onyx --package onyx`
+- From file: `onyx-py gen --source file --schema ./schema/onyx.schema.json --out ./onyx --package onyx`
+- Multiple outputs: `onyx-py gen --out ./onyx --out ./apps/admin/onyx`
+- Timestamp mode: `--timestamps string` to keep ISO strings in generated models.
+- Validation models: `--models pydantic` to emit Pydantic models (default is plain classes; extra fields allowed).
+- HTTP flags: `--timeout <seconds>`, `--max-retries <n>`, `--retry-backoff <seconds>`
+- Subset to stdout: `onyx-py gen --tables User Role` (prints those entities instead of writing files)
+
+Config/env knobs:
+- `ONYX_CONFIG_PATH` to point to a specific `onyx-database.json` (otherwise uses `./config/onyx-database.json`, then `./onyx-database.json`, then home profile).
+- `ONYX_SCHEMA_PATH` to point to a schema file for `schema` and `gen --source file`.
+- `ONYX_DEBUG=true` to log request/response bodies and credential resolution.

onyx_database-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Onyx Database
+
+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.