sqlseed-cli 0.2.4__py3-none-any.whl

sqlseed_cli-0.2.4.dist-info/METADATA

@@ -0,0 +1,118 @@
+Metadata-Version: 2.5
+Name: sqlseed-cli
+Version: 0.2.4
+Summary: Command-line interface for sqlseed test data generation, preview and configuration replay
+Project-URL: Documentation, https://sunbos.github.io/sqlseed/guide/
+Project-URL: Homepage, https://github.com/sunbos/sqlseed
+Project-URL: Repository, https://github.com/sunbos/sqlseed/tree/main/plugins/sqlseed-cli
+Author-email: SunBo <1443584939@qq.com>
+License-Expression: AGPL-3.0-or-later
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
+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
+Requires-Python: >=3.10
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=13.0
+Requires-Dist: sqlseed<0.3,>=0.2.4.dev0
+Description-Content-Type: text/markdown
+
+# sqlseed-cli
+
+Command-line interface for [sqlseed](https://sunbos.github.io/sqlseed/): generate
+SQLite and PostgreSQL test data, preview samples, inspect schema, and save or replay
+configuration. This package provides the `sqlseed` command.
+
+## Installation
+
+For the 0.2.4 release, use a Python 3.10+ virtual environment:
+
+```bash
+python -m pip install "sqlseed-cli==0.2.4"
+```
+
+Core 0.2.3 does not provide the URL API required by this CLI.
+For development, install Core and the required local plugins together from the
+repository root:
+
+```bash
+python -m pip install -e . -e ./plugins/sqlseed-cli
+```
+
+For AI commands in a source checkout, install all three local packages together:
+
+```bash
+python -m pip install -e . -e ./plugins/sqlseed-cli -e ./plugins/sqlseed-ai
+```
+
+Installing only `sqlseed` provides the Python API. Install `sqlseed-cli` or the Core
+`cli` extra to get the console command. Faker is included with Core; Mimesis is
+optional. The examples below select the installed Faker provider explicitly.
+
+## Usage
+
+Create your tables first, then run:
+
+```bash
+sqlseed fill app.db -t users -n 1000 --provider faker --no-ai
+sqlseed preview app.db -t users -n 5 --provider faker
+sqlseed inspect app.db --table users --show-mapping
+sqlseed init generate.yaml --db app.db
+sqlseed fill app.db -t users -n 100 --provider faker --no-ai --snapshot
+sqlseed replay <cache_dir>/snapshots/YYYY-MM-DD_HHMMSS_ffffff_users.yaml
+```
+
+| Command | Purpose |
+|---|---|
+| `fill` | Generate and write data into existing tables |
+| `preview` | Generate samples without writing them |
+| `inspect` | Show schema and column mapping |
+| `init` | Write a YAML configuration template |
+| `replay` | Run a saved configuration snapshot |
+
+For PostgreSQL, install the Core `postgres` extra and use `--url`:
+
+```bash
+python -m pip install "sqlseed[postgres]==0.2.4" "sqlseed-cli==0.2.4"
+sqlseed fill --url "postgresql+psycopg://user:pass@host/db" -t users -n 1000 --provider faker --no-ai
+sqlseed inspect --url "postgresql+psycopg://user:pass@host/db"
+```
+
+For configuration-driven generation, put exactly one of `db_path` or `url` in the YAML.
+Set `provider: faker` in a generated template, or install the optional Mimesis provider
+if the template uses `provider: mimesis`:
+
+```bash
+sqlseed fill --config generate.yaml --no-ai
+```
+
+`--config` cannot be combined with a positional database path or `--url`. Omitted
+`--provider`, `--locale`, and `--batch-size` preserve the YAML values. Explicit options
+override those values, including options equal to the command defaults. Without
+`--config`, the defaults are `mimesis`, `en_US`, and `5000`.
+
+If any table reports generation errors, the command prints those errors and exits
+with status 1. `count` reports rows actually committed; a later batch failure can
+leave earlier commits. A snapshot retains a supplied transform script path and replay
+runs that script again; the script itself is not embedded in the snapshot.
+
+The optional AI plugin registers `ai-suggest`, `ai-analyze`, and `auto-heal` through
+`sqlseed.cli_commands`. CLI does not require AI for its five base commands.
+
+## Requirements
+
+- Python `>=3.10`
+- `sqlseed>=0.2.4.dev0,<0.3`
+- `click>=8.0`
+- `rich>=13.0`
+
+See the [user guide](https://sunbos.github.io/sqlseed/guide/),
+[migration guide](https://sunbos.github.io/sqlseed/migration/), and
+[package source](https://github.com/sunbos/sqlseed/tree/main/plugins/sqlseed-cli).
+
+License: [AGPL-3.0-or-later](https://github.com/sunbos/sqlseed/blob/main/LICENSE).
+The distribution includes the full LICENSE text.

sqlseed_cli-0.2.4.dist-info/RECORD

@@ -0,0 +1,8 @@
+sqlseed_cli/__init__.py,sha256=LWYAx8g50UB9ssH_Ptm1JkGa_8xK8UAIJ92WSslmDlI,2398
+sqlseed_cli/_utils.py,sha256=ZUFQ55sg69ALsxE8w4XNhqfJaSKlO3k-aQwNGePTf6c,684
+sqlseed_cli/main.py,sha256=4k8vPX6cp0uTFp9QhDSMKGf1vWTzYXrR9-p3pn3Y6hA,21705
+sqlseed_cli-0.2.4.dist-info/METADATA,sha256=XQdpc6aMyDbWs_DzI2jZkdIUWgQtbG1pe503j7eWQe4,4571
+sqlseed_cli-0.2.4.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+sqlseed_cli-0.2.4.dist-info/entry_points.txt,sha256=ahwSeWp_DYjJ2kzD184uaYmxyB1kam-Vh3n-ef8G4sk,45
+sqlseed_cli-0.2.4.dist-info/licenses/LICENSE,sha256=YBF91vYz3wZ5LfDR6oUtQ-r3qy0pSd7Ld-SgFNYRzkE,35257
+sqlseed_cli-0.2.4.dist-info/RECORD,,

sqlseed_cli-0.2.4.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

sqlseed_cli-0.2.4.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sqlseed = sqlseed_cli:main