colablinter 0.0.1__tar.gz

colablinter-0.0.1/LICENSE

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

colablinter-0.0.1/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: colablinter
+Version: 0.0.1
+Summary: Linting and formatting Python code in Google Colab.
+Author-email: RektPunk <rektpunk@gmail.com>
+Project-URL: repository, https://github.com/RektPunk/colablinter
+Keywords: jupyter,colab,ipython,magic,ruff,isort,linter
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: IPython
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ipython>=7.34.0
+Requires-Dist: isort>=7.0.0
+Requires-Dist: ruff>=0.14.8
+Dynamic: license-file
+
+# colablinter
+
+[![PyPI version](https://img.shields.io/pypi/v/colablinter.svg)](https://pypi.org/project/colablinter/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Overview
+
+**`colablinter`** is an **IPython magic command extension** for Jupyter and Google Colab environments.
+
+It integrates the high-speed linter **`ruff`** and import sorter **`isort`** to perform cell-by-cell code quality and formatting checks.
+
+## Magic Commands
+
+| Command | Role | Description |
+| :--- | :--- | :--- |
+| **`%%check`** | **Quality Check** | Displays a linting report. |
+| **`%%format`** | **Format, Sort** | Displays a formatting preview (**for copy/paste**) |
+
+After executing a magic command, the **original code** of the cell is executed (if applicable to the command).
+
+## Installation
+
+Requires Python 3.12 or newer.
+
+```bash
+pip install colablinter
+```
+
+## Usage
+The extension must be explicitly loaded in the notebook session before use.
+
+```python
+%load_ext colablinter
+```
+
+1. Check Code Quality
+
+    Use `%%check` to see linting reports.
+    ```python
+    %%check
+
+    def invalid_code(x):
+        return x + y # 'y' is not defined
+    ```
+
+    Output examples:
+    ```bash
+    --- Code Quality & Style Check Report ---
+    F821 Undefined name `y`
+    --> notebook_cell.py:4:16
+    |
+    2 | def invalid_code(x):
+    3 |     return x + y # 'y' is not defined
+    |                ^
+    |
+
+    Found 1 error.
+    -------------------------------------------
+    ```
+
+2. Format code preview
+
+    `%%format` will display the formatted code, but the cell executes the original code.
+    ```python
+    %%format
+    import sys
+    import os
+    def calculate_long_sum(a,b,c,d,e,f):
+        return (a+b+c)*(d+e+f)  # messy
+    ```
+
+    Output examples:
+    ```python
+    # Formatted Code
+    import os
+    import sys
+    from datetime import datetime
+
+
+    def calculate_long_sum(a, b, c, d, e, f):
+        return (a + b + c) * (d + e + f)  # messy
+    ```

colablinter-0.0.1/README.md

@@ -0,0 +1,82 @@
+# colablinter
+
+[![PyPI version](https://img.shields.io/pypi/v/colablinter.svg)](https://pypi.org/project/colablinter/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Overview
+
+**`colablinter`** is an **IPython magic command extension** for Jupyter and Google Colab environments.
+
+It integrates the high-speed linter **`ruff`** and import sorter **`isort`** to perform cell-by-cell code quality and formatting checks.
+
+## Magic Commands
+
+| Command | Role | Description |
+| :--- | :--- | :--- |
+| **`%%check`** | **Quality Check** | Displays a linting report. |
+| **`%%format`** | **Format, Sort** | Displays a formatting preview (**for copy/paste**) |
+
+After executing a magic command, the **original code** of the cell is executed (if applicable to the command).
+
+## Installation
+
+Requires Python 3.12 or newer.
+
+```bash
+pip install colablinter
+```
+
+## Usage
+The extension must be explicitly loaded in the notebook session before use.
+
+```python
+%load_ext colablinter
+```
+
+1. Check Code Quality
+
+    Use `%%check` to see linting reports.
+    ```python
+    %%check
+
+    def invalid_code(x):
+        return x + y # 'y' is not defined
+    ```
+
+    Output examples:
+    ```bash
+    --- Code Quality & Style Check Report ---
+    F821 Undefined name `y`
+    --> notebook_cell.py:4:16
+    |
+    2 | def invalid_code(x):
+    3 |     return x + y # 'y' is not defined
+    |                ^
+    |
+
+    Found 1 error.
+    -------------------------------------------
+    ```
+
+2. Format code preview
+
+    `%%format` will display the formatted code, but the cell executes the original code.
+    ```python
+    %%format
+    import sys
+    import os
+    def calculate_long_sum(a,b,c,d,e,f):
+        return (a+b+c)*(d+e+f)  # messy
+    ```
+
+    Output examples:
+    ```python
+    # Formatted Code
+    import os
+    import sys
+    from datetime import datetime
+
+
+    def calculate_long_sum(a, b, c, d, e, f):
+        return (a + b + c) * (d + e + f)  # messy
+    ```

colablinter-0.0.1/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = "colablinter"
+version = "0.0.1"
+description = "Linting and formatting Python code in Google Colab."
+readme = "README.md"
+authors = [
+    {name = "RektPunk", email = "rektpunk@gmail.com"},
+]
+keywords = ["jupyter", "colab", "ipython", "magic", "ruff", "isort", "linter"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Framework :: IPython",
+]
+requires-python = ">=3.12"
+dependencies = [
+    "ipython>=7.34.0",
+    "isort>=7.0.0",
+    "ruff>=0.14.8",
+]
+
+[project.urls]
+repository = "https://github.com/RektPunk/colablinter"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.5.0",
+]

colablinter-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

colablinter-0.0.1/src/colablinter/__init__.py

@@ -0,0 +1,10 @@
+try:
+    from .magics import LintMagics
+
+    def load_ipython_extension(ipython):
+        ipython.register_magics(LintMagics)
+        print("[ColabLinter:INFO] %%format, %%check commands registered.")
+
+except Exception as e:
+    print(f"[ColabLinter:ERROR] Initialization failed: {e}")
+    pass

colablinter-0.0.1/src/colablinter/magics.py

@@ -0,0 +1,81 @@
+import subprocess
+import sys
+
+from IPython.core.magic import Magics, line_cell_magic, magics_class
+
+
+def _execute_command(command: str, input_data: str) -> str | None:
+    try:
+        result = subprocess.run(
+            command,
+            input=input_data,
+            shell=True,
+            capture_output=True,
+            text=True,
+            encoding="utf-8",
+            check=False,
+        )
+        if result.stderr:
+            print(
+                f"[ColabLinter: Subprocess Warning/Error]: {result.stderr.strip()}",
+                file=sys.stderr,
+            )
+        return result.stdout.strip()
+    except Exception as e:
+        print(f"[ColabLinter:ERROR] Error running command: {e}")
+        return
+
+
+@magics_class
+class LintMagics(Magics):
+    _FILE_NAME = "notebook_cell.py"
+
+    @line_cell_magic
+    def check(self, line: str, cell: str | None = None) -> str | None:
+        if not cell or not cell.strip():
+            return
+        self.__check(cell)
+        self.__execute(cell)
+
+    @line_cell_magic
+    def format(self, line: str, cell: str | None = None) -> str | None:
+        if not cell or not cell.strip():
+            return
+        self.__format(cell)
+        self.__execute(cell)
+
+    def __check(self, cell: str) -> None:
+        print("---- Code Quality & Style Check Report ----")
+        if report := _execute_command(
+            f"ruff check --stdin-filename={self._FILE_NAME}", input_data=cell
+        ):
+            print(report)
+        else:
+            print("[ColabLinter:INFO] No issues found. Code is clean.")
+        print("-------------------------------------------")
+
+    def __execute(self, cell: str) -> None:
+        try:
+            self.shell.run_cell(cell, silent=False, store_history=True)
+        except Exception as e:
+            print(f"[ColabLinter:ERROR] Code execution failed: {e}")
+
+    def __format(self, cell: str) -> None:
+        _formatted_code: str | None = _execute_command(
+            f"ruff format --stdin-filename={self._FILE_NAME}", input_data=cell
+        )
+        if _formatted_code is None:
+            print("[ColabLinter:ERROR] Formatting failed.")
+            return
+
+        formatted_code: str | None = _execute_command(
+            "isort --profile=black -", input_data=_formatted_code
+        )
+        code_to_print = (
+            formatted_code if formatted_code is not None else _formatted_code
+        )
+        if cell.strip() != code_to_print.strip():
+            print("# Formatted Code")
+            print(formatted_code.strip())
+        else:
+            print("[ColabLinter:INFO] Code already formatted. No changes needed.")

colablinter-0.0.1/src/colablinter.egg-info/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: colablinter
+Version: 0.0.1
+Summary: Linting and formatting Python code in Google Colab.
+Author-email: RektPunk <rektpunk@gmail.com>
+Project-URL: repository, https://github.com/RektPunk/colablinter
+Keywords: jupyter,colab,ipython,magic,ruff,isort,linter
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: IPython
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ipython>=7.34.0
+Requires-Dist: isort>=7.0.0
+Requires-Dist: ruff>=0.14.8
+Dynamic: license-file
+
+# colablinter
+
+[![PyPI version](https://img.shields.io/pypi/v/colablinter.svg)](https://pypi.org/project/colablinter/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Overview
+
+**`colablinter`** is an **IPython magic command extension** for Jupyter and Google Colab environments.
+
+It integrates the high-speed linter **`ruff`** and import sorter **`isort`** to perform cell-by-cell code quality and formatting checks.
+
+## Magic Commands
+
+| Command | Role | Description |
+| :--- | :--- | :--- |
+| **`%%check`** | **Quality Check** | Displays a linting report. |
+| **`%%format`** | **Format, Sort** | Displays a formatting preview (**for copy/paste**) |
+
+After executing a magic command, the **original code** of the cell is executed (if applicable to the command).
+
+## Installation
+
+Requires Python 3.12 or newer.
+
+```bash
+pip install colablinter
+```
+
+## Usage
+The extension must be explicitly loaded in the notebook session before use.
+
+```python
+%load_ext colablinter
+```
+
+1. Check Code Quality
+
+    Use `%%check` to see linting reports.
+    ```python
+    %%check
+
+    def invalid_code(x):
+        return x + y # 'y' is not defined
+    ```
+
+    Output examples:
+    ```bash
+    --- Code Quality & Style Check Report ---
+    F821 Undefined name `y`
+    --> notebook_cell.py:4:16
+    |
+    2 | def invalid_code(x):
+    3 |     return x + y # 'y' is not defined
+    |                ^
+    |
+
+    Found 1 error.
+    -------------------------------------------
+    ```
+
+2. Format code preview
+
+    `%%format` will display the formatted code, but the cell executes the original code.
+    ```python
+    %%format
+    import sys
+    import os
+    def calculate_long_sum(a,b,c,d,e,f):
+        return (a+b+c)*(d+e+f)  # messy
+    ```
+
+    Output examples:
+    ```python
+    # Formatted Code
+    import os
+    import sys
+    from datetime import datetime
+
+
+    def calculate_long_sum(a, b, c, d, e, f):
+        return (a + b + c) * (d + e + f)  # messy
+    ```

colablinter-0.0.1/src/colablinter.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+src/colablinter/__init__.py
+src/colablinter/magics.py
+src/colablinter.egg-info/PKG-INFO
+src/colablinter.egg-info/SOURCES.txt
+src/colablinter.egg-info/dependency_links.txt
+src/colablinter.egg-info/requires.txt
+src/colablinter.egg-info/top_level.txt

colablinter-0.0.1/src/colablinter.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

colablinter-0.0.1/src/colablinter.egg-info/requires.txt

@@ -0,0 +1,3 @@
+ipython>=7.34.0
+isort>=7.0.0
+ruff>=0.14.8

colablinter-0.0.1/src/colablinter.egg-info/top_level.txt

@@ -0,0 +1 @@
+colablinter