sqlnbfmt 0.3.2__tar.gz → 0.4.1__tar.gz

{sqlnbfmt-0.3.2 → sqlnbfmt-0.4.1}/PKG-INFO

@@ -1,17 +1,24 @@
 Metadata-Version: 2.4
 Name: sqlnbfmt
-Version: 0.3.2
-Summary: A tool to format SQL code in Jupyter notebooks.
+Version: 0.4.1
+Summary: A tool to format SQL code in Jupyter notebooks and Marimo notebooks.
 Author-email: Qing <qingye779@gmail.com>
 License: MIT
 Project-URL: Homepage, https://github.com/flyersworder/sqlnbfmt
 Project-URL: Repository, https://github.com/flyersworder/sqlnbfmt
 Project-URL: Changelog, https://github.com/flyersworder/sqlnbfmt/blob/main/CHANGELOG.md
 Project-URL: Issues, https://github.com/flyersworder/sqlnbfmt/issues
-Keywords: sql,jupyter,notebook,formatter,sqlglot,pre-commit
+Keywords: sql,jupyter,marimo,notebook,formatter,sqlglot,pre-commit
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Framework :: Jupyter
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -23,22 +30,25 @@ Dynamic: license-file
 # sqlnbfmt
 
 [![PyPI](https://img.shields.io/pypi/v/sqlnbfmt.svg)](https://pypi.org/project/sqlnbfmt/)
+[![Tests](https://github.com/flyersworder/sqlnbfmt/actions/workflows/ci-and-publish.yml/badge.svg)](https://github.com/flyersworder/sqlnbfmt/actions/workflows/ci-and-publish.yml)
 [![License](https://img.shields.io/pypi/l/sqlnbfmt.svg)](https://github.com/flyersworder/sqlnbfmt/blob/main/LICENSE)
 [![Python Versions](https://img.shields.io/pypi/pyversions/sqlnbfmt.svg)](https://pypi.org/project/sqlnbfmt/)
 
 > **Quick start:** `pip install sqlnbfmt && sqlnbfmt notebook.ipynb`
 
-A SQL formatter designed specifically for Jupyter Notebooks. `sqlnbfmt` automatically formats SQL queries embedded in code cells, including both Python strings and SQL magic cells (`%%sql`), helping you maintain clean and consistent code.
+A SQL formatter for Jupyter Notebooks and Marimo notebooks. `sqlnbfmt` automatically formats SQL queries embedded in notebook cells — Python strings, SQL magic cells (`%%sql`), and Marimo `mo.sql()` calls — helping you maintain clean and consistent code.
 
 ## Features
 
 - **Zero-config**: Works out of the box with sensible defaults — no config file needed
-- **Smart SQL Detection**: Automatically identifies and formats SQL queries in code cells and magic SQL cells
+- **Jupyter + Marimo**: Formats SQL in `.ipynb` notebooks and Marimo `.py` notebooks
+- **Smart SQL Detection**: Automatically identifies and formats SQL queries in code cells, magic SQL cells, and `mo.sql()` calls
 - **AST-Powered**: Uses Abstract Syntax Tree parsing for accurate SQL string identification
-- **Safe Formatting**: Preserves Python comments, query parameters (e.g., `%s`, `?`), and SQL comments
+- **Safe Formatting**: Preserves Python comments, query parameters (e.g., `%s`, `?`), f-string placeholders, and SQL comments
 - **CI-Friendly**: `--check` mode exits non-zero when formatting is needed; `--diff` shows what would change
 - **Skip Hints**: Add `# sqlnbfmt: skip` to any cell to exclude it from formatting
 - **Pre-commit Ready**: Seamlessly integrates with pre-commit hooks
+- **JupyterLab Plugin**: Works with `jupyterlab-code-formatter` for interactive format-on-save
 - **Lightweight**: Only three runtime dependencies (sqlglot, nbformat, pyyaml)
 
 ## Installation
@@ -51,14 +61,24 @@ pip install sqlnbfmt
 
 ### Command Line
 
-Format a single notebook:
+Format Jupyter notebooks:
 ```bash
 sqlnbfmt path/to/your_notebook.ipynb
 ```
 
+Format Marimo notebooks (or any Python file with SQL strings):
+```bash
+sqlnbfmt path/to/your_notebook.py
+```
+
+Mix both in a single invocation:
+```bash
+sqlnbfmt *.ipynb marimo_app.py
+```
+
 Check formatting without modifying files (useful in CI):
 ```bash
-sqlnbfmt --check path/to/your_notebook.ipynb
+sqlnbfmt --check path/to/your_notebook.ipynb path/to/marimo_app.py
 ```
 
 Show a diff of what would change:
@@ -68,13 +88,30 @@ sqlnbfmt --diff path/to/your_notebook.ipynb
 
 ### Skipping Cells
 
-Add a `# sqlnbfmt: skip` comment anywhere in a cell to skip formatting:
+Add a `# sqlnbfmt: skip` comment to skip formatting. In Jupyter notebooks this applies per-cell; in Python files it applies to the entire file.
 
 ```python
 # sqlnbfmt: skip
 query = "select * from my_special_table where id = 1"
 ```
 
+### JupyterLab Integration
+
+Format SQL cells interactively with [jupyterlab-code-formatter](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter):
+
+1. Install both packages:
+```bash
+pip install sqlnbfmt jupyterlab-code-formatter
+```
+
+2. Register the formatter in `~/.jupyter/jupyter_notebook_config.py`:
+```python
+from sqlnbfmt.jupyterlab_integration import register
+register()                       # or: register(dialect="postgres")
+```
+
+3. In JupyterLab, use **Edit > Format Cell** or configure format-on-save in Settings > Code Formatter.
+
 ### Pre-commit Integration
 
 1. Install pre-commit:
@@ -86,12 +123,18 @@ pip install pre-commit
 ```yaml
 repos:
   - repo: https://github.com/flyersworder/sqlnbfmt
-    rev: v0.3.0
+    rev: v0.4.0
     hooks:
       - id: sqlnbfmt
         types: [jupyter]
 ```
 
+To also format Marimo notebooks (Python files), add the Python hook:
+```yaml
+      - id: sqlnbfmt-py
+        files: '\.py$'  # optionally narrow with: files: 'marimo_.*\.py$'
+```
+
 All arguments are optional. To specify a dialect or custom config:
 ```yaml
         args: [--dialect, postgres, --config, config.yaml]
@@ -116,6 +159,7 @@ Use `--check` in GitHub Actions to enforce formatting:
   run: |
     pip install sqlnbfmt
     sqlnbfmt --check **/*.ipynb
+    sqlnbfmt --check marimo_*.py  # if using Marimo
 ```
 
 ## Configuration
@@ -134,7 +178,9 @@ Create a `config.yaml` file to customize formatting behavior. [Here](https://git
 | `single_line_threshold` | Maximum length before splitting SQL | 80 |
 | `indent_width` | Number of spaces for indentation | 4 |
 
-## Example
+## Examples
+
+### Jupyter Notebook
 
 Before formatting:
 ```python
@@ -159,6 +205,35 @@ ORDER BY
 """)
 ```
 
+### Marimo Notebook
+
+Before formatting:
+```python
+@app.cell
+def _(mo):
+    _df = mo.sql(f"select id, name from users where active = 1 order by name")
+    return
+```
+
+After formatting:
+```python
+@app.cell
+def _(mo):
+    _df = mo.sql(
+    f"""
+    SELECT
+      id,
+      name
+    FROM users
+    WHERE
+      active = 1
+    ORDER BY
+      name
+    """
+)
+    return
+```
+
 ## Troubleshooting
 
 **SQL not being formatted?**

sqlnbfmt-0.3.2/sqlnbfmt.egg-info/PKG-INFO → sqlnbfmt-0.4.1/README.md

@@ -1,44 +1,25 @@
-Metadata-Version: 2.4
-Name: sqlnbfmt
-Version: 0.3.2
-Summary: A tool to format SQL code in Jupyter notebooks.
-Author-email: Qing <qingye779@gmail.com>
-License: MIT
-Project-URL: Homepage, https://github.com/flyersworder/sqlnbfmt
-Project-URL: Repository, https://github.com/flyersworder/sqlnbfmt
-Project-URL: Changelog, https://github.com/flyersworder/sqlnbfmt/blob/main/CHANGELOG.md
-Project-URL: Issues, https://github.com/flyersworder/sqlnbfmt/issues
-Keywords: sql,jupyter,notebook,formatter,sqlglot,pre-commit
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: nbformat>=5.10.4
-Requires-Dist: pyyaml>=6.0.2
-Requires-Dist: sqlglot>=25.27.0
-Dynamic: license-file
-
 # sqlnbfmt
 
 [![PyPI](https://img.shields.io/pypi/v/sqlnbfmt.svg)](https://pypi.org/project/sqlnbfmt/)
+[![Tests](https://github.com/flyersworder/sqlnbfmt/actions/workflows/ci-and-publish.yml/badge.svg)](https://github.com/flyersworder/sqlnbfmt/actions/workflows/ci-and-publish.yml)
 [![License](https://img.shields.io/pypi/l/sqlnbfmt.svg)](https://github.com/flyersworder/sqlnbfmt/blob/main/LICENSE)
 [![Python Versions](https://img.shields.io/pypi/pyversions/sqlnbfmt.svg)](https://pypi.org/project/sqlnbfmt/)
 
 > **Quick start:** `pip install sqlnbfmt && sqlnbfmt notebook.ipynb`
 
-A SQL formatter designed specifically for Jupyter Notebooks. `sqlnbfmt` automatically formats SQL queries embedded in code cells, including both Python strings and SQL magic cells (`%%sql`), helping you maintain clean and consistent code.
+A SQL formatter for Jupyter Notebooks and Marimo notebooks. `sqlnbfmt` automatically formats SQL queries embedded in notebook cells — Python strings, SQL magic cells (`%%sql`), and Marimo `mo.sql()` calls — helping you maintain clean and consistent code.
 
 ## Features
 
 - **Zero-config**: Works out of the box with sensible defaults — no config file needed
-- **Smart SQL Detection**: Automatically identifies and formats SQL queries in code cells and magic SQL cells
+- **Jupyter + Marimo**: Formats SQL in `.ipynb` notebooks and Marimo `.py` notebooks
+- **Smart SQL Detection**: Automatically identifies and formats SQL queries in code cells, magic SQL cells, and `mo.sql()` calls
 - **AST-Powered**: Uses Abstract Syntax Tree parsing for accurate SQL string identification
-- **Safe Formatting**: Preserves Python comments, query parameters (e.g., `%s`, `?`), and SQL comments
+- **Safe Formatting**: Preserves Python comments, query parameters (e.g., `%s`, `?`), f-string placeholders, and SQL comments
 - **CI-Friendly**: `--check` mode exits non-zero when formatting is needed; `--diff` shows what would change
 - **Skip Hints**: Add `# sqlnbfmt: skip` to any cell to exclude it from formatting
 - **Pre-commit Ready**: Seamlessly integrates with pre-commit hooks
+- **JupyterLab Plugin**: Works with `jupyterlab-code-formatter` for interactive format-on-save
 - **Lightweight**: Only three runtime dependencies (sqlglot, nbformat, pyyaml)
 
 ## Installation
@@ -51,14 +32,24 @@ pip install sqlnbfmt
 
 ### Command Line
 
-Format a single notebook:
+Format Jupyter notebooks:
 ```bash
 sqlnbfmt path/to/your_notebook.ipynb
 ```
 
+Format Marimo notebooks (or any Python file with SQL strings):
+```bash
+sqlnbfmt path/to/your_notebook.py
+```
+
+Mix both in a single invocation:
+```bash
+sqlnbfmt *.ipynb marimo_app.py
+```
+
 Check formatting without modifying files (useful in CI):
 ```bash
-sqlnbfmt --check path/to/your_notebook.ipynb
+sqlnbfmt --check path/to/your_notebook.ipynb path/to/marimo_app.py
 ```
 
 Show a diff of what would change:
@@ -68,13 +59,30 @@ sqlnbfmt --diff path/to/your_notebook.ipynb
 
 ### Skipping Cells
 
-Add a `# sqlnbfmt: skip` comment anywhere in a cell to skip formatting:
+Add a `# sqlnbfmt: skip` comment to skip formatting. In Jupyter notebooks this applies per-cell; in Python files it applies to the entire file.
 
 ```python
 # sqlnbfmt: skip
 query = "select * from my_special_table where id = 1"
 ```
 
+### JupyterLab Integration
+
+Format SQL cells interactively with [jupyterlab-code-formatter](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter):
+
+1. Install both packages:
+```bash
+pip install sqlnbfmt jupyterlab-code-formatter
+```
+
+2. Register the formatter in `~/.jupyter/jupyter_notebook_config.py`:
+```python
+from sqlnbfmt.jupyterlab_integration import register
+register()                       # or: register(dialect="postgres")
+```
+
+3. In JupyterLab, use **Edit > Format Cell** or configure format-on-save in Settings > Code Formatter.
+
 ### Pre-commit Integration
 
 1. Install pre-commit:
@@ -86,12 +94,18 @@ pip install pre-commit
 ```yaml
 repos:
   - repo: https://github.com/flyersworder/sqlnbfmt
-    rev: v0.3.0
+    rev: v0.4.0
     hooks:
       - id: sqlnbfmt
         types: [jupyter]
 ```
 
+To also format Marimo notebooks (Python files), add the Python hook:
+```yaml
+      - id: sqlnbfmt-py
+        files: '\.py$'  # optionally narrow with: files: 'marimo_.*\.py$'
+```
+
 All arguments are optional. To specify a dialect or custom config:
 ```yaml
         args: [--dialect, postgres, --config, config.yaml]
@@ -116,6 +130,7 @@ Use `--check` in GitHub Actions to enforce formatting:
   run: |
     pip install sqlnbfmt
     sqlnbfmt --check **/*.ipynb
+    sqlnbfmt --check marimo_*.py  # if using Marimo
 ```
 
 ## Configuration
@@ -134,7 +149,9 @@ Create a `config.yaml` file to customize formatting behavior. [Here](https://git
 | `single_line_threshold` | Maximum length before splitting SQL | 80 |
 | `indent_width` | Number of spaces for indentation | 4 |
 
-## Example
+## Examples
+
+### Jupyter Notebook
 
 Before formatting:
 ```python
@@ -159,6 +176,35 @@ ORDER BY
 """)
 ```
 
+### Marimo Notebook
+
+Before formatting:
+```python
+@app.cell
+def _(mo):
+    _df = mo.sql(f"select id, name from users where active = 1 order by name")
+    return
+```
+
+After formatting:
+```python
+@app.cell
+def _(mo):
+    _df = mo.sql(
+    f"""
+    SELECT
+      id,
+      name
+    FROM users
+    WHERE
+      active = 1
+    ORDER BY
+      name
+    """
+)
+    return
+```
+
 ## Troubleshooting
 
 **SQL not being formatted?**

{sqlnbfmt-0.3.2 → sqlnbfmt-0.4.1}/pyproject.toml

@@ -1,18 +1,25 @@
 [project]
 name = "sqlnbfmt"
-version = "0.3.2"
-description = "A tool to format SQL code in Jupyter notebooks."
+version = "0.4.1"
+description = "A tool to format SQL code in Jupyter notebooks and Marimo notebooks."
 authors = [
   { name = "Qing", email = "qingye779@gmail.com" }
 ]
 license = { text = "MIT" }
 readme = "README.md"
 requires-python = ">=3.12"
-keywords = ["sql", "jupyter", "notebook", "formatter", "sqlglot", "pre-commit"]
+keywords = ["sql", "jupyter", "marimo", "notebook", "formatter", "sqlglot", "pre-commit"]
 classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.13"
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Quality Assurance",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Framework :: Jupyter",
 ]
 dependencies = [
     "nbformat>=5.10.4",