sirius-cli 0.1.0__py3-none-any.whl

sirius_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: sirius-cli
+Version: 0.1.0
+Summary: A rapid prototyping tool for generating containerized backend + frontend CRUD stacks from CSV/SQLite files.
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.9.0
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: pandas>=1.5.0
+Requires-Dist: sqlalchemy>=2.0.0
+Requires-Dist: alembic>=1.11.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: openpyxl>=3.0.0
+Dynamic: license-file
+
+# Sirius-CLI
+
+A rapid prototyping CLI tool designed to take multiple CSV files, Excel spreadsheets, a SQLite database, or a JSON configuration file as inputs, automatically infer their structural schemas and relationships, and generate:
+- A production-grade, container-ready **FastAPI** backend (with SQLAlchemy models, Pydantic v2 validation schemas, and automated Alembic migrations).
+- A modular, responsive, multi-page **React 18 (TypeScript, Vite, Tailwind CSS)** CRUD frontend with dynamic relational selectors and a beautiful Dashboard.
+
+---
+
+## Key Capabilities
+
+- **Automatic Relationship Mapping**: Automatically extracts foreign keys from databases and resolves CSV/Excel associations using naming heuristics (linking `[table]_id` fields), navigating irregular English plurals effortlessly.
+- **Auto-Seeding**: Automatically seeds the generated database with the entries inside the source CSV/Excel files during migration (if using SQLite).
+- **Relational Integrity**: Generates dropdowns in the UI for foreign keys and displays badges that navigate to parent entities.
+- **Enterprise Data Grid**: The generated tables feature server-side searching (`?search=`), server-side column sorting (`?order_by=`), and dual data export buttons (CSV and Excel `.xlsx`).
+- **Dashboard Analytics**: A built-in Recharts dashboard showing live dataset distribution and entity insights.
+- **Multiple Database Engines**: Target `SQLite` for rapid local prototyping, or generate `PostgreSQL` and `MySQL` ready projects out of the box using `--pg` and `--mysql`.
+- **Iterative Updates**: Use `sirius-update` to safely inject new tables or columns into an existing scaffolded project.
+
+---
+
+## Installation
+
+Install the package locally in editable mode:
+```bash
+pip install -e .
+```
+
+---
+
+## Usage: Creating a New Project (`sirius-init`)
+
+### 1. Generating from CSVs or Excel
+```bash
+# From CSVs
+sirius-init store_system --csv examples/users.csv --csv examples/orders.csv --theme violet
+
+# From Excel
+sirius-init store_system --excel examples/products.xlsx --theme amber
+```
+
+### 2. Target Production Databases
+By default, the stack uses an embedded SQLite file (`app.db`). You can target Postgres or MySQL instead:
+```bash
+sirius-init billing_system --config schema.json --pg
+```
+*(The generated `docker-compose.yml` and `database.py` will expect a `DATABASE_URL` environment variable).*
+
+### 3. Generating from JSON Configuration
+Specify database schemas, relationships, and colors in a JSON file:
+```json
+{
+  "project_name": "billing_system",
+  "theme": "emerald",
+  "entities": {
+    "customers": {
+      "columns": [
+        { "name": "id",        "type": "Integer", "is_pk": true },
+        { "name": "name",      "type": "String" },
+        { "name": "email",     "type": "String" },
+        { "name": "is_active", "type": "Boolean" }
+      ]
+    },
+    "invoices": {
+      "columns": [
+        { "name": "id",          "type": "Integer", "is_pk": true },
+        { "name": "ref_no",      "type": "String" },
+        { "name": "amount",      "type": "Float" },
+        { "name": "customer_id", "type": "Integer", "foreign_key": "customers.id" },
+        { "name": "created_at", "type": "DateTime" }
+      ]
+    }
+  }
+}
+```
+Then run:
+```bash
+sirius-init --config examples/billing-config.json
+```
+
+---
+
+## Usage: Updating an Existing Project (`sirius-update`)
+
+If your data requirements change (e.g., adding a `reviews` table to your store), you don't need to start from scratch. Use `sirius-update` to merge new schemas into an existing project.
+
+```bash
+sirius-update ./store_system --csv examples/new_reviews.csv
+```
+
+Sirius-CLI will:
+1. Regenerate your SQLAlchemy models and Pydantic schemas.
+2. Regenerate your frontend routing and CRUD views.
+3. Automatically run `alembic revision --autogenerate` and `alembic upgrade head` to apply the database migrations seamlessly.
+
+---
+
+## All CLI Flags
+
+### `sirius-init` / `sirius-update`
+
+| Flag | Short | Default | Description |
+|---|---|---|---|
+| `--csv` | | | Path to a CSV file (repeatable) |
+| `--excel` | | | Path to an Excel .xlsx/.xls file (repeatable) |
+| `--db` | | | Path to a SQLite .db file |
+| `--config` | `-c` | | Path to a JSON config file |
+| `--theme` | `-t` | `blue` | Frontend color theme (`blue`, `indigo`, `emerald`, `amber`, `rose`, `sky`, `violet`) |
+| `--out` | `-o` | `.` | Output directory (only for `init`) |
+| `--port` | `-p` | `8000` | Backend port (used in Dockerfile, docker-compose, .env) |
+| `--api-url` | | `http://localhost:<port>` | Override the frontend VITE_API_URL |
+| `--no-seed` | | `false` | Skip seeding the DB from source CSV/Excel files |
+| `--pg` | | `false` | Generate Postgres connection pool and drivers |
+| `--mysql` | | `false` | Generate MySQL connection pool and drivers |
+
+---
+
+## Running the Scaffolded Stack
+
+### Using Docker Compose
+```bash
+cd <project_name>
+docker compose up --build
+```
+
+### Running Locally
+1. **Start Backend**:
+   ```bash
+   cd <project_name>/backend
+   pip install -r requirements.txt
+   uvicorn backend.main:app --reload --port 8000
+   ```
+2. **Start Frontend**:
+   ```bash
+   cd <project_name>/frontend
+   npm install
+   npm run dev
+   ```
+   Open `http://localhost:5173/` in your browser.
+
+---
+
+## License & Commercial Use
+
+Sirius-CLI is open-source and released under the **GNU AGPLv3 License**. 
+
+This is a strong copyleft license that ensures the project remains free and open. By using this software, you agree that any modifications or larger works incorporating this tool that are distributed or provided as a network service (SaaS) **must also be open-sourced** under the same AGPLv3 license.
+
+**Dual Licensing for Enterprise**
+If your organization wishes to use Sirius-CLI in proprietary, closed-source software without being subject to the open-source requirements of the AGPLv3, a **Commercial License** is available for purchase. Please contact the maintainer for more details on enterprise licensing.

sirius_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,32 @@
+sirius_cli/__init__.py,sha256=ZrAeJE1uMzlxg4X-idA3Ba4ftIfn1p7q4T_gcPEs8vk,21
+sirius_cli/cli.py,sha256=P3D62g9f-XIkTbPaiqzQED000PsBDZ-OGgrdQy4wi5w,15081
+sirius_cli/generator.py,sha256=rpBhdAbjxNMW1A45IWs0z78HqQyZ0TuJbj683p4IjaM,4384
+sirius_cli/parser.py,sha256=HW_yu0SwGHqArmrAKbCdGmLRVRiRmCFlosAnfVMKUE0,11520
+sirius_cli/templates/docker-compose.yml.jinja2,sha256=RHxKjolGt4zc6KIjWyG1ih1a3ccdLhE3GRrOEqdIaJk,479
+sirius_cli/templates/backend/Dockerfile.jinja2,sha256=Ay6QgUMprdS4cNkB2_0x0Wje2wbnqSos-mz2GsfOn8M,413
+sirius_cli/templates/backend/database.py.jinja2,sha256=GBc9AX5eUk1fnrHmrgKe7GRvfZe6nHbG_Nqf5Q8UT_0,1266
+sirius_cli/templates/backend/main.py.jinja2,sha256=IATRVNf2MjxOy-GpCk3eL_n7Nob3ybiMb0LXOXSlCSo,6768
+sirius_cli/templates/backend/models.py.jinja2,sha256=udO4_MIDnA1-nbMI5DhxeS0oXppi7-5F3Fzbu9W2vGM,1129
+sirius_cli/templates/backend/requirements.txt.jinja2,sha256=eMR5hzB_AcAMLM0bRAcBUJhwqZa-tqWzIV56wU6WR3Q,241
+sirius_cli/templates/backend/schemas.py.jinja2,sha256=pRSu8tbBtEQ-6Omlfn2MqzBGm0ce7T8ut2KiIv9ft5g,3056
+sirius_cli/templates/backend/alembic/env.py.jinja2,sha256=EHQTjzRVHWVUsv0hl5IefelV6wf0VytI0F5pX20gmuE,1906
+sirius_cli/templates/backend/alembic/script.py.mako.jinja2,sha256=J2d5Gyqs0ZumB_U7ABgN68gmGwqoSEn3rOG-vNduUuU,523
+sirius_cli/templates/frontend/.env.jinja2,sha256=E9PxDgta-0zn35xJXIUsefZohm71Vq2fF9GzpP-EScs,130
+sirius_cli/templates/frontend/Dockerfile.jinja2,sha256=f59huwwT7Rj4ijxtO-EAjkiq4z1Ewt28WJXO_DourRc,137
+sirius_cli/templates/frontend/index.html.jinja2,sha256=d54geNKYKaokyRMC6mS-JmOajQyuA65LvkZ7ehg8T7s,708
+sirius_cli/templates/frontend/package.json.jinja2,sha256=T2btMNkYgBvOmxc6tUdLvA6NzGyLMKA7gHqOZxNDJxo,635
+sirius_cli/templates/frontend/postcss.config.js.jinja2,sha256=hZLG_OtBHyhlqZtN694nISAXcFRdQ6lPr9if4EPh4c8,78
+sirius_cli/templates/frontend/tailwind.config.js.jinja2,sha256=U87elnT-nIaFNy2YJjJi5fR-xJSpEhfI2TgWkex1two,411
+sirius_cli/templates/frontend/tsconfig.json.jinja2,sha256=_23QLYPxlX5mcrOLFliiwhD10qR2XxbtsxuuGXZTHoA,582
+sirius_cli/templates/frontend/vite.config.ts.jinja2,sha256=ZQ0SWdCWNA5wG207pW2sgXxbUL3sbQ12qhRImHe58Ac,180
+sirius_cli/templates/frontend/src/App.tsx.jinja2,sha256=t-MPc7G68eK5-hv2tB_Saexqm_ehJlOa8gea1mXAuD0,3971
+sirius_cli/templates/frontend/src/Dashboard.tsx.jinja2,sha256=KZ7F6jS4sQ7zB3xa8H6T86TplVL39PUjz-dbW9nfuSQ,9455
+sirius_cli/templates/frontend/src/TableCrud.tsx.jinja2,sha256=cBYVP7-gzuAf_jMRDXS9yT_1F9Ec2KGYZEk8xUTe-tk,24640
+sirius_cli/templates/frontend/src/index.css.jinja2,sha256=OtOSVznfw-2kZL1diDsNw1Yj91j-eeOcb3IKJ0l9NYM,447
+sirius_cli/templates/frontend/src/main.tsx.jinja2,sha256=1UAmXezxGB3uttbqWzAbZvDDqDLXK8LT1g3VZmQXmXA,235
+sirius_cli-0.1.0.dist-info/licenses/LICENSE,sha256=chfQduHY7P_dqgE4rkaW0vurtvXpMlvD_6kjVNaL7NA,32385
+sirius_cli-0.1.0.dist-info/METADATA,sha256=0jips20f-YWKH7HbOh1W2VzOWSiSelee5Snq7evlhPk,6434
+sirius_cli-0.1.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+sirius_cli-0.1.0.dist-info/entry_points.txt,sha256=xFPJau6Z8Fdvz_Xjr6Q-bwJADmzAZodadbNsu8PU_s4,51
+sirius_cli-0.1.0.dist-info/top_level.txt,sha256=MLvIdQaLzQlK3m7ERVqqCktdkYtGIO3KR2TnwF27vS8,11
+sirius_cli-0.1.0.dist-info/RECORD,,

sirius_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sirius_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sirius-init = sirius_cli.cli:app