rename

Author: dongwonmoon

.github/workflows/run_tests.yml

@@ -1,4 +1,4 @@
-name: "Data Scribe Tests"
+name: "Schema Scribe Tests"
 
 on:
   push:
@@ -32,12 +32,12 @@ jobs:
 
       - name: "Run Pytest"
         run: |
-          pytest data_scribe/tests/
+          pytest schema_scribe/tests/
         env:
           # Set dummy keys to allow client initialization tests to pass
           # The actual API calls are mocked, so these don't need to be real
           OPENAI_API_KEY: "ci_test_key"
           GOOGLE_API_KEY: "ci_test_key"
           SNOWFLAKE_PASSWORD: "ci_test_key"
           MARIADB_PASSWORD: "ci_test_key"
-          CONFLUENCE_API_TOKEN: "ci_test_key"
+          CONFLUENCE_API_TOKEN: "ci_test_key"

README.md

@@ -1,18 +1,18 @@
-# ✍️ Data Scribe: AI-Powered Data Documentation
+# ✍️ Schema Scribe: AI-Powered Data Documentation
 
 **Tired of writing data documentation? Let AI do it for you.**
 
-Data Scribe is a CLI tool that scans your databases and dbt projects, uses AI to generate descriptions, and automatically updates your documentation.
+Schema Scribe is a CLI tool that scans your databases and dbt projects, uses AI to generate descriptions, and automatically updates your documentation.
 
 ---
 
 ## ✨ See it in Action
 
-Stop manually updating YAML files or writing Markdown tables. Let `data-scribe` do the work in seconds.
+Stop manually updating YAML files or writing Markdown tables. Let `schema-scribe` do the work in seconds.
 
 | **Magically update dbt `schema.yml`** | **Instantly generate DB catalogs (w/ ERD)** |
 | :---: | :---: |
-| Run `data-scribe dbt --update` and watch AI fill in your missing descriptions, tags, and tests. | Point `data-scribe db` at a database and get a full Markdown catalog, complete with a Mermaid ERD. |
+| Run `schema-scribe dbt --update` and watch AI fill in your missing descriptions, tags, and tests. | Point `schema-scribe db` at a database and get a full Markdown catalog, complete with a Mermaid ERD. |
 | ![dbt Workflow Demo](asset/dbt_demo.gif) | ![Database Scan Demo](asset/markdown_demo.gif) |
 
 ## 🚀 Quick Start (60 Seconds)
@@ -24,20 +24,20 @@ Get your first AI-generated catalog in less than a minute.
 Clone the repo and install dependencies.
 
 ```bash
-git clone https://github.com/dongwonmoon/DataScribe.git
-cd DataScribe
+git clone https://github.com/dongwonmoon/SchemaScribe.git
+cd SchemaScribe
 pip install -r requirements.txt
 ```
 
-*(Note: For specific databases, install optional dependencies: `pip install -e ".[postgres, snowflake]"`)*
-*(Note: To use the web server, also install server dependencies: `pip install "data-scribe[server]"`)*
+*(Note: For specific databases, install optional dependencies: `pip install -e " .[postgres, snowflake]"`)*
+*(Note: To use the web server, also install server dependencies: `pip install "schema-scribe[server]"`)*
 
 ### 2. Initialize
 
 Run the interactive wizard. It will guide you through setting up your database and LLM, automatically creating `config.yaml` and a secure `.env` file for your API keys.
 
 ```bash
-data-scribe init
+schema-scribe init
 ```
 
 ### 3. Run!
@@ -48,22 +48,22 @@ You're all set.
 (Make sure `dbt compile` has been run to create `manifest.json`)
 ```bash
 # See what's missing (CI check)
-data-scribe dbt --project-dir /path/to/your/dbt/project --check
+schema-scribe dbt --project-dir /path/to/your/dbt/project --check
 
 # Let AI fix it
-data-scribe dbt --project-dir /path/to/your/dbt/project --update
+schema-scribe dbt --project-dir /path/to/your/dbt/project --update
 
 # Check for documentation drift against the live database
-data-scribe dbt --project-dir /path/to/your/dbt/project --db your_db_profile --drift
+schema-scribe dbt --project-dir /path/to/your/dbt/project --db your_db_profile --drift
 
 # Generate a global, end-to-end lineage graph
-data-scribe lineage --project-dir /path/to/your/dbt/project --db your_db_profile --output your_mermaid_profile
+schema-scribe lineage --project-dir /path/to/your/dbt/project --db your_db_profile --output your_mermaid_profile
 ```
 
 **For a database:**
 (Assuming you created an output profile named `my_markdown` during `init`)
 ```bash
-data-scribe db --output my_markdown
+schema-scribe db --output my_markdown
 ```
 
 ---
@@ -96,19 +96,19 @@ data-scribe db --output my_markdown
 
 ## Command Reference
 
-### `data-scribe init`
+### `schema-scribe init`
 
 Runs the interactive wizard to create `config.yaml` and `.env` files. This is the recommended first step.
 
-### `data-scribe db`
+### `schema-scribe db`
 
 Scans a live database and generates a catalog.
 
 -   `--db TEXT`: (Optional) The database profile from `config.yaml` to use. Overrides default.
 -   `--llm TEXT`: (Optional) The LLM profile from `config.yaml` to use. Overrides default.
 -   `--output TEXT`: (Required) The output profile from `config.yaml` to use.
 
-### `data-scribe dbt`
+### `schema-scribe dbt`
 
 Scans a dbt project's `manifest.json` file.
 
@@ -122,15 +122,15 @@ Scans a dbt project's `manifest.json` file.
 
 **Note:** `--update`, `--check`, `--interactive`, and `--drift` flags are mutually exclusive. Choose only one.
 
-### `data-scribe lineage`
+### `schema-scribe lineage`
 
 Generates a global, end-to-end lineage graph for a dbt project.
 
 -   `--project-dir TEXT`: **(Required)** Path to the dbt project directory.
 -   `--db TEXT`: **(Required)** The database profile to scan for physical Foreign Keys.
 -   `--output TEXT`: **(Required)** The output profile (must be type 'mermaid') to write the `.md` file to.
 
-### `data-scribe serve`
+### `schema-scribe serve`
 
 Launches the FastAPI web server.
 
@@ -141,12 +141,12 @@ Launches the FastAPI web server.
 
 ## 🚀 Web API Server
 
-Data Scribe includes a built-in FastAPI web server that exposes the core workflows via a REST API. This is perfect for programmatic integration or for building a custom web UI.
+Schema Scribe includes a built-in FastAPI web server that exposes the core workflows via a REST API. This is perfect for programmatic integration or for building a custom web UI.
 
 **1. Launch the server:**
-(Make sure you have installed the server dependencies: `pip install "data-scribe[server]"`)
+(Make sure you have installed the server dependencies: `pip install "schema-scribe[server]"`)
 ```bash
-data-scribe serve --host 0.0.0.0 --port 8000
+schema-scribe serve --host 0.0.0.0 --port 8000
 ```
 
 **2. Explore the API:**
@@ -180,12 +180,12 @@ If the documentation is outdated, the API will return a `409 Conflict` status co
 
 Adding a new database, LLM, or writer is easy:
 
-1.  Create a new class in the appropriate directory (e.g., `data_scribe/components/db_connectors`).
+1.  Create a new class in the appropriate directory (e.g., `schema_scribe/components/db_connectors`).
 2.  Implement the base interface (e.g., `BaseConnector`).
-3.  Register your new class in `data_scribe/core/factory.py`.
+3.  Register your new class in `schema_scribe/core/factory.py`.
 
 The `init` command and core logic will automatically pick up your new component.
 
 ## 🤝 Contributing
 
-Contributions are welcome! Please feel free to open an issue or submit a pull request.
+Contributions are welcome! Please feel free to open an issue or submit a pull request.

create_demo_db.py

@@ -45,10 +45,10 @@
     "INSERT INTO users (name, email) VALUES ('천재 사용자', 'genius@example.com')"
 )
 cursor.execute(
-    "INSERT INTO products (name, price) VALUES ('Data Scribe Pro', 99.9)"
+    "INSERT INTO products (name, price) VALUES ('Schema Scribe Pro', 99.9)"
 )
 
 conn.commit()
 conn.close()
 
-print(f"✅ 데모 데이터베이스 '{DB_FILE}' 생성 완료!")
+print(f"✅ 데모 데이터베이스 '{DB_FILE}' 생성 완료!")

jaffle_shop_mini/dbt_project.yml

@@ -5,4 +5,4 @@ config-version: 2
 profile: 'default'
 
 model-paths: ["models"]
-target-path: "target"
+target-path: "target"

jaffle_shop_mini/models/schema.yml

@@ -31,4 +31,4 @@ models:
           - user_info
           - pii
     description: This dbt model generates a single record representing customer 
-      information, with attributes like customer ID, name, and email address.
+      information, with attributes like customer ID, name, and email address.

pyproject.toml

@@ -3,8 +3,8 @@ requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "data-scribe"
-version = "0.1.1"
+name = "schema-scribe"
+version = "0.2.0"
 description = "AI-powered data documentation generator for databases and dbt projects."
 readme = "README.md"
 authors = [
@@ -65,8 +65,8 @@ all = [
 ]
 
 [tool.setuptools.packages.find]
-include = ["data_scribe*"]
+include = ["schema_scribe*"]
 exclude = ["jaffle_shop_mini*", "tests*"]
 
 [project.scripts]
-data-scribe = "data_scribe.main:app"
+schema-scribe = "schema_scribe.main:app"

data_scribe/app.py schema_scribe/app.pydata_scribe/app.py renamed to schema_scribe/app.py

@@ -1,5 +1,5 @@
 """
-This module defines the command-line interface (CLI) for the Data Scribe application.
+This module defines the command-line interface (CLI) for the Schema Scribe application.
 
 It uses the Typer library to create a simple and intuitive CLI for scanning databases
 and dbt projects. The main commands, `db` and `dbt`, orchestrate the process of
@@ -18,24 +18,24 @@
 except:
     uvicorn = None
 
-from data_scribe.core.db_workflow import DbWorkflow
-from data_scribe.core.dbt_workflow import DbtWorkflow
-from data_scribe.core.lineage_workflow import LineageWorkflow
-from data_scribe.core.exceptions import (
+from schema_scribe.core.db_workflow import DbWorkflow
+from schema_scribe.core.dbt_workflow import DbtWorkflow
+from schema_scribe.core.lineage_workflow import LineageWorkflow
+from schema_scribe.core.exceptions import (
     DataScribeError,
     ConnectorError,
     ConfigError,
     LLMClientError,
     WriterError,
     CIError,
 )
-from data_scribe.core.factory import (
+from schema_scribe.core.factory import (
     DB_CONNECTOR_REGISTRY,
     LLM_CLIENT_REGISTRY,
     WRITER_REGISTRY,
 )
-from data_scribe.utils.logger import get_logger
-from data_scribe.server.main import app as fastapi_app
+from schema_scribe.utils.logger import get_logger
+from schema_scribe.server.main import app as fastapi_app
 
 # Initialize a logger for this module
 logger = get_logger(__name__)
@@ -161,7 +161,7 @@ def _prompt_db_params(
             f"Password (sensitive, will be stored in .env)", hide_input=True
         )
         env_key = f"{profile_name.upper()}_PASSWORD"
-        params["password"] = f"${{{env_key}}}"
+        params["password"] = f"$ {{{env_key}}}"
         env_data[env_key] = pw
         params["dbname"] = typer.prompt("Database (dbname)")
         if db_type == "postgres":
@@ -178,7 +178,7 @@ def _prompt_db_params(
             f"Password (sensitive, will be stored in .env)", hide_input=True
         )
         env_key = f"{profile_name.upper()}_PASSWORD"
-        params["password"] = f"${{{env_key}}}"
+        params["password"] = f"$ {{{env_key}}}"
         env_data[env_key] = pw
         params["warehouse"] = typer.prompt("Warehouse")
         params["database"] = typer.prompt("Database")
@@ -273,7 +273,7 @@ def _prompt_writer_params(
             "Confluence Parent Page ID (numeric)"
         )
         params["page_title_prefix"] = typer.prompt(
-            "Page title prefix", default="Data Scribe Catalog"
+            "Page title prefix", default="Schema Scribe Catalog"
         )
         params["username"] = typer.prompt("Confluence Username (email)")
 
@@ -470,7 +470,7 @@ def init_config():
             logger.info("Aborting configuration initialization.")
             raise typer.Exit(code=0)
 
-    logger.info(f"Starting the Data Scribe configuration wizard...")
+    logger.info(f"Starting the Schema Scribe configuration wizard...")
     logger.info(
         f"This will create '{CONFIG_FILE}' and '{ENV_FILE}' in the current directory."
     )
@@ -559,9 +559,9 @@ def init_config():
         if env_data:
             # Use 'a' (append) mode to avoid overwriting existing .env variables
             with open(ENV_FILE, "a", encoding="utf-8") as f:
-                f.write("\n# Added by data-scribe init\n")
+                f.write("\n# Added by schema-scribe init\n")
                 for key, value in env_data.items():
-                    f.write(f'{key}="{value}"\n')
+                    f.write(f'{key}"={value}"\n')
             logger.info(
                 typer.style(
                     f"Sensitive information added to '{ENV_FILE}'.",
@@ -589,24 +589,24 @@ def serve_app(
     port: int = typer.Option(8000, help="The port to run the server on."),
 ):
     """
-    Launches the Data Scribe web server (FastAPI).
+    Launches the Schema Scribe web server (FastAPI).
 
     This command starts a Uvicorn server to run the FastAPI application,
-    providing a web-based API for the Data Scribe workflows.
+    providing a web-based API for the Schema Scribe workflows.
 
     Note: This feature requires optional dependencies. Install them with:
-    `pip install "data-scribe[server]"`
+    `pip install \"schema-scribe[server]"`
     """
     if uvicorn is None:
         logger.error("Failed to import 'uvicorn' or 'fastapi'.")
         logger.error(
-            "Please run 'pip install data-scribe[server]' to install server dependencies."
+            "Please run 'pip install schema-scribe[server]' to install server dependencies."
         )
         raise typer.Exit(code=1)
 
-    logger.info(f"Starting Data Scribe server at http://{host}:{port}")
+    logger.info(f"Starting Schema Scribe server at http://{host}:{port}")
     logger.info("Go to http://{host}:{port}/docs for API documentation.")
 
     uvicorn.run(
         fastapi_app, host=host, port=port  # The FastAPI app we imported
-    )
+    )

…ibe/components/db_connectors/__init__.py …ibe/components/db_connectors/__init__.pydata_scribe/components/db_connectors/__init__.py renamed to schema_scribe/components/db_connectors/__init__.py data_scribe/components/db_connectors/__init__.py renamed to schema_scribe/components/db_connectors/__init__.py

@@ -3,4 +3,4 @@
 from .mariadb_connector import MariaDBConnector
 from .duckdb_connector import DuckDBConnector
 from .snowflake_connector import SnowflakeConnector
-from .sql_base_connector import SqlBaseConnector
+from .sql_base_connector import SqlBaseConnector

…onents/db_connectors/duckdb_connector.py …onents/db_connectors/duckdb_connector.pydata_scribe/components/db_connectors/duckdb_connector.py renamed to schema_scribe/components/db_connectors/duckdb_connector.py data_scribe/components/db_connectors/duckdb_connector.py renamed to schema_scribe/components/db_connectors/duckdb_connector.py

@@ -10,9 +10,9 @@
 import os
 from typing import List, Dict, Any, Optional
 
-from data_scribe.core.interfaces import BaseConnector
-from data_scribe.core.exceptions import ConnectorError
-from data_scribe.utils.logger import get_logger
+from schema_scribe.core.interfaces import BaseConnector
+from schema_scribe.core.exceptions import ConnectorError
+from schema_scribe.utils.logger import get_logger
 
 logger = get_logger(__name__)
 
@@ -389,4 +389,4 @@ def close(self):
             self.connection.close()
             self.connection = None
             self.cursor = None
-            logger.info("DuckDB database connection closed.")
+            logger.info("DuckDB database connection closed.")

…nents/db_connectors/mariadb_connector.py …nents/db_connectors/mariadb_connector.pydata_scribe/components/db_connectors/mariadb_connector.py renamed to schema_scribe/components/db_connectors/mariadb_connector.py data_scribe/components/db_connectors/mariadb_connector.py renamed to schema_scribe/components/db_connectors/mariadb_connector.py

@@ -10,8 +10,8 @@
 from typing import Dict, Any
 
 from .sql_base_connector import SqlBaseConnector
-from data_scribe.core.exceptions import ConnectorError
-from data_scribe.utils.logger import get_logger
+from schema_scribe.core.exceptions import ConnectorError
+from schema_scribe.utils.logger import get_logger
 
 logger = get_logger(__name__)
 
@@ -62,4 +62,4 @@ def connect(self, db_params: Dict[str, Any]):
             )
         except mysql.connector.Error as e:
             logger.error(f"MariaDB/MySQL connection failed: {e}", exc_info=True)
-            raise ConnectorError(f"MariaDB/MySQL connection failed: {e}") from e
+            raise ConnectorError(f"MariaDB/MySQL connection failed: {e}") from e