From 8e112379fcdd491782dfecb711b72226c211e460 Mon Sep 17 00:00:00 2001 From: saileshwar-skyflow Date: Wed, 16 Sep 2026 15:14:05 +0530 Subject: [PATCH 1/2] SK-3118: Fix root README for the unary-only FlowVault SDK MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The repo landing page was stale: it showed flowvault importing as `skyflow_flowvault` (it imports as `skyflow`), described it as "high-throughput bulk + unary" (bulk has been removed — it is unary only), and used the retired "Flow DB" name. Correct the import name and description, rename Flow DB -> FlowVault, and align the page structure with the Java repo's root README (add Documentation and Reporting a Vulnerability sections; note that both artifacts share the `skyflow` import and can't coexist in one environment). Co-Authored-By: Claude Opus 4.8 --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7d69d5e..582690f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Skyflow Python SDK -This repository hosts the Skyflow Python SDKs. It is a multi-package workspace — pick the package +This repository hosts Skyflow's Python SDKs. It is a multi-package workspace — pick the package that matches the vault you're using. ## Which package do I want? @@ -8,16 +8,17 @@ that matches the vault you're using. | Package (PyPI) | Import | Vault type | Docs | |---|---|---|---| | **`skyflow`** | `import skyflow` | Privacy DB (v2.x) — vault CRUD, tokenize/detokenize, query, files, Detect, Connections | [skyvault/README.md](skyvault/README.md) | -| **`skyflow-flowvault-python`** | `import skyflow_flowvault` | Flow DB (v1.x) — high-throughput bulk + unary vault operations | [flowvault/README.md](flowvault/README.md) | +| **`skyflow-flowvault-python`** | `import skyflow` | FlowVault (v1.x) — unary vault operations (insert, get, update, delete, detokenize) | [flowvault/README.md](flowvault/README.md) | ```bash -pip install skyflow # Privacy DB SDK -pip install skyflow-flowvault-python # Flow DB SDK +pip install skyflow # Privacy DB SDK +pip install skyflow-flowvault-python # FlowVault SDK ``` -> The two artifacts have **independent version lines** and cannot be installed into the same Python -> environment at once. A lower `skyflow-flowvault-python` version number (1.x) does not mean it is behind -> `skyflow` (2.x) — they are separate products. +> The two artifacts are versioned independently and **both install under the same top-level `skyflow` +> import**, so they cannot live in the same Python environment at once — install one per environment. A +> lower `skyflow-flowvault-python` version (1.x) does not mean it is behind `skyflow` (2.x); they are +> separate products. ## Repository layout @@ -25,14 +26,20 @@ pip install skyflow-flowvault-python # Flow DB SDK |---|---| | `common/` | Shared client, credentials, config, and error code — depended on by both SDKs, never published on its own. | | `skyvault/` | The `skyflow` (Privacy DB / v2) SDK. | -| `flowvault/` | The `skyflow-flowvault-python` (Flow DB / v1) SDK. | +| `flowvault/` | The `skyflow-flowvault-python` (FlowVault / v1) SDK. | | `docs/` | Reference docs and the [v1 → v2 migration guide](docs/migrate_to_v2.md). | | `CHANGELOG.md` | Release history. | Each SDK ships runnable examples under its own `samples/` directory ([flowvault/samples/](flowvault/samples/), [skyvault/samples/](skyvault/samples/)). -## Resources +## Documentation +- [Privacy DB SDK (`skyflow`) reference](skyvault/README.md) +- [FlowVault SDK (`skyflow-flowvault-python`) reference](flowvault/README.md) +- [v1 → v2 migration guide](docs/migrate_to_v2.md) - [Skyflow docs](https://docs.skyflow.com/) -- [GitHub](https://github.com/skyflowapi/skyflow-python/) + +## Reporting a Vulnerability + +If you discover a potential security issue, please email **security@skyflow.com** rather than opening a public GitHub issue. From bf234861c33aa321ca2da0b818905546ff31e404 Mon Sep 17 00:00:00 2001 From: saileshwar-skyflow Date: Wed, 16 Sep 2026 16:08:24 +0530 Subject: [PATCH 2/2] SK-3118: Restructure root README to match the Java repo layout Follow the skyflow-java root README structure: title + intro + CI/release/license badges, a "Which package do I want?" table (Package / Artifact / README / Vault Type / Version line), the independent-versioning note, repository layout, Documentation, and Reporting a Vulnerability. Vault types are named SkyVault and FlowVault. Also keeps the Python-specific note that both artifacts share the `skyflow` import and must be installed one per environment. Co-Authored-By: Claude Opus 4.8 --- README.md | 52 +++++++++++++++++++++++----------------------------- 1 file changed, 23 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 582690f..d6015b5 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,39 @@ -# Skyflow Python SDK +# Skyflow Python -This repository hosts Skyflow's Python SDKs. It is a multi-package workspace — pick the package -that matches the vault you're using. +This repository hosts Skyflow's Python SDKs for integrating Skyflow into a Python backend. It's a multi-package workspace with more than one published artifact — pick the package that matches what you need below. + +[![CI](https://img.shields.io/static/v1?label=CI&message=passing&color=green?style=plastic&logo=github)](https://github.com/skyflowapi/skyflow-python/actions) +[![GitHub release](https://img.shields.io/github/v/release/skyflowapi/skyflow-python.svg)](https://github.com/skyflowapi/skyflow-python/releases) +[![License](https://img.shields.io/github/license/skyflowapi/skyflow-python)](https://github.com/skyflowapi/skyflow-python/blob/main/LICENSE) ## Which package do I want? -| Package (PyPI) | Import | Vault type | Docs | -|---|---|---|---| -| **`skyflow`** | `import skyflow` | Privacy DB (v2.x) — vault CRUD, tokenize/detokenize, query, files, Detect, Connections | [skyvault/README.md](skyvault/README.md) | -| **`skyflow-flowvault-python`** | `import skyflow` | FlowVault (v1.x) — unary vault operations (insert, get, update, delete, detokenize) | [flowvault/README.md](flowvault/README.md) | +| Package | Artifact (PyPI) | README | Vault Type | Version line | +|---|---|---|---|---| +| **skyvault** | `skyflow` | [skyvault/README.md](skyvault/README.md) | SkyVault | 2.x | +| **flowvault** | `skyflow-flowvault-python` | [flowvault/README.md](flowvault/README.md) | FlowVault | 1.x | + +`flowvault` shares auth/client setup with `skyvault` — both depend on the `common` module. + +> **The two artifacts are versioned independently.** `flowvault` is a new SDK starting at `1.0.0`; its lower version number reflects a first release, not an older or lesser SDK than `skyvault` 2.x. Upgrade each on its own version line. -```bash -pip install skyflow # Privacy DB SDK -pip install skyflow-flowvault-python # FlowVault SDK -``` +> **Install one per environment.** Both artifacts install under the same top-level `skyflow` import, so they cannot coexist in the same Python environment. -> The two artifacts are versioned independently and **both install under the same top-level `skyflow` -> import**, so they cannot live in the same Python environment at once — install one per environment. A -> lower `skyflow-flowvault-python` version (1.x) does not mean it is behind `skyflow` (2.x); they are -> separate products. +> Migrating from v1? See skyvault's **[Migration Guide](docs/migrate_to_v2.md)**. V1 is in maintenance mode and will reach End of Life on October 31, 2026. ## Repository layout -| Path | What it is | -|---|---| -| `common/` | Shared client, credentials, config, and error code — depended on by both SDKs, never published on its own. | -| `skyvault/` | The `skyflow` (Privacy DB / v2) SDK. | -| `flowvault/` | The `skyflow-flowvault-python` (FlowVault / v1) SDK. | -| `docs/` | Reference docs and the [v1 → v2 migration guide](docs/migrate_to_v2.md). | -| `CHANGELOG.md` | Release history. | +The workspace contains: -Each SDK ships runnable examples under its own `samples/` directory -([flowvault/samples/](flowvault/samples/), [skyvault/samples/](skyvault/samples/)). +- `common/` — shared client, credentials, config, and error-handling code used by both `skyvault` and `flowvault` +- `skyvault/` — the `skyflow` SDK ([README](skyvault/README.md)) +- `flowvault/` — the `skyflow-flowvault-python` SDK ([README](flowvault/README.md)) ## Documentation -- [Privacy DB SDK (`skyflow`) reference](skyvault/README.md) -- [FlowVault SDK (`skyflow-flowvault-python`) reference](flowvault/README.md) -- [v1 → v2 migration guide](docs/migrate_to_v2.md) -- [Skyflow docs](https://docs.skyflow.com/) +- [skyvault API Reference](docs/api_reference.md) — full list of request/response classes, enums, and service-account utilities +- [Migrate from v1 to v2](docs/migrate_to_v2.md) ## Reporting a Vulnerability -If you discover a potential security issue, please email **security@skyflow.com** rather than opening a public GitHub issue. +If you discover a potential security issue in this project, please reach out to us at **security@skyflow.com**. Please do not create public GitHub issues or Pull Requests, as malicious actors could potentially view them.