dbslice 0.1.0__tar.gz

dbslice-0.1.0/.gitignore

@@ -0,0 +1,228 @@
+# 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
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Database dumps
+*.sql
+!examples/**/*.sql
+
+# Environment files
+.env
+.env.*
+
+# Internal docs
+executive_summary.md
+dbslice-prd.md

dbslice-0.1.0/LICENSE

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

dbslice-0.1.0/PKG-INFO

@@ -0,0 +1,235 @@
+Metadata-Version: 2.4
+Name: dbslice
+Version: 0.1.0
+Summary: Extract minimal, referentially-intact database subsets for local development
+Project-URL: Homepage, https://github.com/nabroleonx/dbslice
+Project-URL: Documentation, https://github.com/nabroleonx/dbslice#readme
+Project-URL: Repository, https://github.com/nabroleonx/dbslice
+Project-URL: Issues, https://github.com/nabroleonx/dbslice/issues
+Author: nabroleonx
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,database,extraction,mysql,postgresql,sqlite,subset
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: faker>=20.0.0
+Requires-Dist: psycopg2-binary>=2.9.9
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.9.0
+Provides-Extra: all
+Requires-Dist: mkdocs-material>=9.5.0; extra == 'all'
+Requires-Dist: mkdocs>=1.5.0; extra == 'all'
+Requires-Dist: mypy>=1.0.0; extra == 'all'
+Requires-Dist: mysql-connector-python>=8.0.0; extra == 'all'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'all'
+Requires-Dist: pytest>=7.0.0; extra == 'all'
+Requires-Dist: ruff>=0.1.0; extra == 'all'
+Requires-Dist: types-pyyaml>=6.0.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
+Requires-Dist: mkdocs>=1.5.0; extra == 'docs'
+Provides-Extra: mysql
+Requires-Dist: mysql-connector-python>=8.0.0; extra == 'mysql'
+Description-Content-Type: text/markdown
+
+# dbslice
+
+[![PyPI version](https://img.shields.io/pypi/v/dbslice)](https://pypi.org/project/dbslice/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+
+Extract minimal, referentially-intact database subsets for local development and debugging.
+
+## The Problem
+
+Copying an entire production database to your machine is infeasible. But reproducing a bug often requires having the exact data that caused it. **dbslice** solves this by extracting only the records you need, following foreign key relationships to ensure referential integrity.
+
+## Quick Start
+
+```bash
+uv add dbslice
+
+# Extract an order and all related records
+dbslice extract postgres://localhost/myapp --seed "orders.id=12345" > subset.sql
+
+# Import into local database
+psql -d localdb < subset.sql
+```
+
+## Features
+
+- **Zero-config start** -- Introspects schema automatically, no data model file required
+- **Single command** -- Extract complete data subsets with one CLI invocation
+- **Safe by default** -- Auto-detects and anonymizes sensitive fields (emails, phones, SSNs, etc.)
+- **Multiple output formats** -- SQL, JSON, and CSV
+- **Streaming** -- Memory-efficient extraction for large datasets (100K+ rows)
+- **Virtual foreign keys** -- Support for Django GenericForeignKeys and implicit relationships via config
+- **Config files** -- YAML-based configuration for repeatable extractions
+- **Validation** -- Checks referential integrity of extracted data
+
+### Database Support
+
+| Database   | Status                |
+|------------|-----------------------|
+| PostgreSQL | Fully supported       |
+| MySQL      | Planned (not yet implemented) |
+| SQLite     | Planned (not yet implemented) |
+
+## Installation
+
+```bash
+# Install with uv (recommended)
+uv add dbslice
+
+# Try without installing
+uvx dbslice --help
+
+# Or with pip
+pip install dbslice
+```
+
+## Usage
+
+### Basic Extraction
+
+```bash
+# Extract by primary key
+dbslice extract postgres://user:pass@host:5432/db --seed "orders.id=12345"
+
+# Extract with WHERE clause
+dbslice extract postgres://localhost/db --seed "orders:status='failed' AND created_at > '2024-01-01'"
+
+# Multiple seeds
+dbslice extract postgres://localhost/db \
+  --seed "orders.id=100" \
+  --seed "orders.id=101"
+```
+
+### Control Traversal
+
+```bash
+# Limit depth (default: 3)
+dbslice extract postgres://... --seed "orders.id=1" --depth 2
+
+# Direction: up (parents only), down (children only), both (default)
+dbslice extract postgres://... --seed "orders.id=1" --direction up
+```
+
+### Anonymization
+
+```bash
+# Auto-anonymize detected sensitive fields
+dbslice extract postgres://... --seed "users.id=1" --anonymize
+
+# Redact additional fields
+dbslice extract postgres://... --seed "users.id=1" --anonymize --redact "audit_logs.ip_address"
+```
+
+### Output Formats
+
+```bash
+# SQL (default)
+dbslice extract postgres://... --seed "orders.id=1" --output sql
+
+# JSON fixtures
+dbslice extract postgres://... --seed "orders.id=1" --output json --out-file fixtures/
+
+# CSV
+dbslice extract postgres://... --seed "orders.id=1" --output csv --out-file data/
+```
+
+### Virtual Foreign Keys
+
+For relationships not defined in the database schema (Django GenericForeignKeys, implicit relationships):
+
+```yaml
+# dbslice.yaml
+database:
+  url: postgres://localhost:5432/myapp
+
+virtual_foreign_keys:
+  - source_table: notifications
+    source_columns: [object_id]
+    target_table: orders
+    description: "Generic FK to orders via ContentType"
+
+  - source_table: audit_log
+    source_columns: [user_id]
+    target_table: users
+    description: "Implicit FK without DB constraint"
+```
+
+```bash
+dbslice extract --config dbslice.yaml --seed "users.id=1"
+```
+
+### Inspect Schema
+
+```bash
+dbslice inspect postgres://localhost/myapp
+```
+
+### Configuration File
+
+```bash
+# Generate config from database
+dbslice init postgres://localhost/myapp --out-file dbslice.yaml
+
+# Use config
+dbslice extract --config dbslice.yaml --seed "orders.id=12345"
+```
+
+## How It Works
+
+1. **Introspect** -- Reads database schema to discover tables and foreign key relationships
+2. **Traverse** -- Starting from seed record(s), follows FK relationships via BFS
+3. **Extract** -- Fetches all identified records
+4. **Sort** -- Topologically sorts tables for correct INSERT order
+5. **Output** -- Generates SQL/JSON/CSV with proper escaping
+
+## Comparison
+
+| Feature | dbslice | Jailer | Greenmask | slice-db |
+|---------|---------|--------|-----------|----------|
+| Language | Python | Java | Go | Ruby |
+| Configuration | Zero-config | Requires model file | Config required | Manual YAML |
+| Setup time | Seconds | Hours | Medium | Medium |
+| Anonymization | Built-in (Faker) | Plugin-based | Advanced transformers | Not available |
+| Subsetting | FK traversal | FK traversal | Limited | FK traversal |
+| Output formats | SQL, JSON, CSV | SQL, XML, CSV | SQL | SQL only |
+| Cycle handling | Automatic | Manual config | N/A | Manual |
+| Streaming | Built-in | Configurable | Built-in | Not available |
+| Maintenance | Active | Active | Active | Unmaintained |
+
+**dbslice** is the lightweight, zero-config Python option: install and extract in under a minute.
+
+## Development
+
+```bash
+git clone https://github.com/nabroleonx/dbslice.git
+cd dbslice
+uv sync --dev
+uv run pytest
+```
+
+## License
+
+MIT

dbslice-0.1.0/README.md

@@ -0,0 +1,183 @@
+# dbslice
+
+[![PyPI version](https://img.shields.io/pypi/v/dbslice)](https://pypi.org/project/dbslice/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+
+Extract minimal, referentially-intact database subsets for local development and debugging.
+
+## The Problem
+
+Copying an entire production database to your machine is infeasible. But reproducing a bug often requires having the exact data that caused it. **dbslice** solves this by extracting only the records you need, following foreign key relationships to ensure referential integrity.
+
+## Quick Start
+
+```bash
+uv add dbslice
+
+# Extract an order and all related records
+dbslice extract postgres://localhost/myapp --seed "orders.id=12345" > subset.sql
+
+# Import into local database
+psql -d localdb < subset.sql
+```
+
+## Features
+
+- **Zero-config start** -- Introspects schema automatically, no data model file required
+- **Single command** -- Extract complete data subsets with one CLI invocation
+- **Safe by default** -- Auto-detects and anonymizes sensitive fields (emails, phones, SSNs, etc.)
+- **Multiple output formats** -- SQL, JSON, and CSV
+- **Streaming** -- Memory-efficient extraction for large datasets (100K+ rows)
+- **Virtual foreign keys** -- Support for Django GenericForeignKeys and implicit relationships via config
+- **Config files** -- YAML-based configuration for repeatable extractions
+- **Validation** -- Checks referential integrity of extracted data
+
+### Database Support
+
+| Database   | Status                |
+|------------|-----------------------|
+| PostgreSQL | Fully supported       |
+| MySQL      | Planned (not yet implemented) |
+| SQLite     | Planned (not yet implemented) |
+
+## Installation
+
+```bash
+# Install with uv (recommended)
+uv add dbslice
+
+# Try without installing
+uvx dbslice --help
+
+# Or with pip
+pip install dbslice
+```
+
+## Usage
+
+### Basic Extraction
+
+```bash
+# Extract by primary key
+dbslice extract postgres://user:pass@host:5432/db --seed "orders.id=12345"
+
+# Extract with WHERE clause
+dbslice extract postgres://localhost/db --seed "orders:status='failed' AND created_at > '2024-01-01'"
+
+# Multiple seeds
+dbslice extract postgres://localhost/db \
+  --seed "orders.id=100" \
+  --seed "orders.id=101"
+```
+
+### Control Traversal
+
+```bash
+# Limit depth (default: 3)
+dbslice extract postgres://... --seed "orders.id=1" --depth 2
+
+# Direction: up (parents only), down (children only), both (default)
+dbslice extract postgres://... --seed "orders.id=1" --direction up
+```
+
+### Anonymization
+
+```bash
+# Auto-anonymize detected sensitive fields
+dbslice extract postgres://... --seed "users.id=1" --anonymize
+
+# Redact additional fields
+dbslice extract postgres://... --seed "users.id=1" --anonymize --redact "audit_logs.ip_address"
+```
+
+### Output Formats
+
+```bash
+# SQL (default)
+dbslice extract postgres://... --seed "orders.id=1" --output sql
+
+# JSON fixtures
+dbslice extract postgres://... --seed "orders.id=1" --output json --out-file fixtures/
+
+# CSV
+dbslice extract postgres://... --seed "orders.id=1" --output csv --out-file data/
+```
+
+### Virtual Foreign Keys
+
+For relationships not defined in the database schema (Django GenericForeignKeys, implicit relationships):
+
+```yaml
+# dbslice.yaml
+database:
+  url: postgres://localhost:5432/myapp
+
+virtual_foreign_keys:
+  - source_table: notifications
+    source_columns: [object_id]
+    target_table: orders
+    description: "Generic FK to orders via ContentType"
+
+  - source_table: audit_log
+    source_columns: [user_id]
+    target_table: users
+    description: "Implicit FK without DB constraint"
+```
+
+```bash
+dbslice extract --config dbslice.yaml --seed "users.id=1"
+```
+
+### Inspect Schema
+
+```bash
+dbslice inspect postgres://localhost/myapp
+```
+
+### Configuration File
+
+```bash
+# Generate config from database
+dbslice init postgres://localhost/myapp --out-file dbslice.yaml
+
+# Use config
+dbslice extract --config dbslice.yaml --seed "orders.id=12345"
+```
+
+## How It Works
+
+1. **Introspect** -- Reads database schema to discover tables and foreign key relationships
+2. **Traverse** -- Starting from seed record(s), follows FK relationships via BFS
+3. **Extract** -- Fetches all identified records
+4. **Sort** -- Topologically sorts tables for correct INSERT order
+5. **Output** -- Generates SQL/JSON/CSV with proper escaping
+
+## Comparison
+
+| Feature | dbslice | Jailer | Greenmask | slice-db |
+|---------|---------|--------|-----------|----------|
+| Language | Python | Java | Go | Ruby |
+| Configuration | Zero-config | Requires model file | Config required | Manual YAML |
+| Setup time | Seconds | Hours | Medium | Medium |
+| Anonymization | Built-in (Faker) | Plugin-based | Advanced transformers | Not available |
+| Subsetting | FK traversal | FK traversal | Limited | FK traversal |
+| Output formats | SQL, JSON, CSV | SQL, XML, CSV | SQL | SQL only |
+| Cycle handling | Automatic | Manual config | N/A | Manual |
+| Streaming | Built-in | Configurable | Built-in | Not available |
+| Maintenance | Active | Active | Active | Unmaintained |
+
+**dbslice** is the lightweight, zero-config Python option: install and extract in under a minute.
+
+## Development
+
+```bash
+git clone https://github.com/nabroleonx/dbslice.git
+cd dbslice
+uv sync --dev
+uv run pytest
+```
+
+## License
+
+MIT