beautiful-traceback 0.1.0__tar.gz → 0.2.0__tar.gz

{beautiful_traceback-0.1.0 → beautiful_traceback-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: beautiful-traceback
-Version: 0.1.0
+Version: 0.2.0
 Summary: Beautiful, readable Python tracebacks with colors and formatting
 Keywords: traceback,error,debugging,formatting
 Author: Michael Bianco
@@ -10,14 +10,17 @@ Requires-Python: >=3.9
 Project-URL: Repository, https://github.com/iloveitaly/beautiful-traceback
 Description-Content-Type: text/markdown
 
-# Beautiful Traceback
+# Beautiful, Readable Python Stack Traces
 
-> **Note:** This is a fork of the [pretty-traceback](https://github.com/mbarkhau/pretty-traceback) repo with simplified development and improvements for better integration with FastAPI, [structlog](https://github.com/iloveitaly/structlog-config), IPython, pytest, and more. This project is used in [python-starter-template](https://github.com/iloveitaly/python-starter-template) to provide better debugging experience in production environments.
+[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.md)
+[![Python Versions](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
 
 Human readable stacktraces for Python.
 
-[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.md)
-[![Python Versions](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+![Comparison of standard Python traceback vs Beautiful Traceback](comparison.webp)
+
+> [!NOTE]
+> This is a fork of the [pretty-traceback](https://github.com/mbarkhau/pretty-traceback) repo with simplified development and improvements for better integration with FastAPI, [structlog](https://github.com/iloveitaly/structlog-config), IPython, pytest, and more. This project is used in [python-starter-template](https://github.com/iloveitaly/python-starter-template) to provide better debugging experience in production environments.
 
 ## Quick Start
 
@@ -34,7 +37,6 @@ uv run examples/simple.py
 
 Beautiful Traceback groups together what belongs together, adds coloring and alignment. All of this makes it easier for you to see patterns and filter out the signal from the noise. This tabular format is best viewed in a wide terminal.
 
-![Comparison of standard Python traceback vs Beautiful Traceback](comparison.webp)
 
 ## Installation
 
@@ -202,7 +204,27 @@ This gives you full control over the log format while adding beautiful traceback
 
 You can enable beautiful-traceback across all Python projects without modifying any source code by using a `.pth` file. Python automatically executes import statements in `.pth` files during interpreter startup, making this perfect for development environments.
 
-Add this function to your `.zshrc` or `.bashrc`:
+### Using the CLI Command
+
+The easiest way to inject beautiful-traceback into your current virtual environment:
+
+```bash
+beautiful-traceback
+```
+
+This command:
+- Only works within virtual environments (for safety)
+- Installs the `.pth` file into your current environment's site-packages
+- Displays the installation path every time it runs
+
+Output:
+```
+Beautiful traceback injection installed: /path/to/.venv/lib/python3.11/site-packages/beautiful_traceback_injection.pth
+```
+
+### Using a Shell Function (Alternative)
+
+Alternatively, add this function to your `.zshrc` or `.bashrc`:
 
 ```bash
 # Create a file to automatically import beautiful-traceback on startup
@@ -216,7 +238,7 @@ python-inject-beautiful-traceback() {
 def run_startup_script():
   try:
     import beautiful_traceback
-    beautiful_traceback.install()
+    beautiful_traceback.install(only_tty=False)
   except ImportError:
     pass
 
@@ -249,4 +271,4 @@ Beautiful Traceback is heavily inspired by the backtrace module by [nir0s](https
 
 ## License
 
-MIT License - see [LICENSE.md](LICENSE.md) for details.
+[MIT License](LICENSE.md)

{beautiful_traceback-0.1.0 → beautiful_traceback-0.2.0}/README.md

@@ -1,11 +1,14 @@
-# Beautiful Traceback
+# Beautiful, Readable Python Stack Traces
 
-> **Note:** This is a fork of the [pretty-traceback](https://github.com/mbarkhau/pretty-traceback) repo with simplified development and improvements for better integration with FastAPI, [structlog](https://github.com/iloveitaly/structlog-config), IPython, pytest, and more. This project is used in [python-starter-template](https://github.com/iloveitaly/python-starter-template) to provide better debugging experience in production environments.
+[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.md)
+[![Python Versions](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
 
 Human readable stacktraces for Python.
 
-[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.md)
-[![Python Versions](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+![Comparison of standard Python traceback vs Beautiful Traceback](comparison.webp)
+
+> [!NOTE]
+> This is a fork of the [pretty-traceback](https://github.com/mbarkhau/pretty-traceback) repo with simplified development and improvements for better integration with FastAPI, [structlog](https://github.com/iloveitaly/structlog-config), IPython, pytest, and more. This project is used in [python-starter-template](https://github.com/iloveitaly/python-starter-template) to provide better debugging experience in production environments.
 
 ## Quick Start
 
@@ -22,7 +25,6 @@ uv run examples/simple.py
 
 Beautiful Traceback groups together what belongs together, adds coloring and alignment. All of this makes it easier for you to see patterns and filter out the signal from the noise. This tabular format is best viewed in a wide terminal.
 
-![Comparison of standard Python traceback vs Beautiful Traceback](comparison.webp)
 
 ## Installation
 
@@ -190,7 +192,27 @@ This gives you full control over the log format while adding beautiful traceback
 
 You can enable beautiful-traceback across all Python projects without modifying any source code by using a `.pth` file. Python automatically executes import statements in `.pth` files during interpreter startup, making this perfect for development environments.
 
-Add this function to your `.zshrc` or `.bashrc`:
+### Using the CLI Command
+
+The easiest way to inject beautiful-traceback into your current virtual environment:
+
+```bash
+beautiful-traceback
+```
+
+This command:
+- Only works within virtual environments (for safety)
+- Installs the `.pth` file into your current environment's site-packages
+- Displays the installation path every time it runs
+
+Output:
+```
+Beautiful traceback injection installed: /path/to/.venv/lib/python3.11/site-packages/beautiful_traceback_injection.pth
+```
+
+### Using a Shell Function (Alternative)
+
+Alternatively, add this function to your `.zshrc` or `.bashrc`:
 
 ```bash
 # Create a file to automatically import beautiful-traceback on startup
@@ -204,7 +226,7 @@ python-inject-beautiful-traceback() {
 def run_startup_script():
   try:
     import beautiful_traceback
-    beautiful_traceback.install()
+    beautiful_traceback.install(only_tty=False)
   except ImportError:
     pass
 
@@ -237,4 +259,4 @@ Beautiful Traceback is heavily inspired by the backtrace module by [nir0s](https
 
 ## License
 
-MIT License - see [LICENSE.md](LICENSE.md) for details.
+[MIT License](LICENSE.md)

{beautiful_traceback-0.1.0 → beautiful_traceback-0.2.0}/beautiful_traceback/__init__.py

@@ -5,7 +5,7 @@ from .formatting import LoggingFormatterMixin
 
 from ._extension import load_ipython_extension  # noqa: F401
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"
 
 
 # retain typo for backward compatibility

beautiful_traceback-0.2.0/beautiful_traceback/cli.py

@@ -0,0 +1,73 @@
+"""CLI commands for beautiful-traceback installation and configuration."""
+
+import sys
+from pathlib import Path
+
+
+def inject_pth() -> None:
+    """
+    Inject beautiful-traceback into the current Python environment via .pth file.
+
+    Creates a .pth file in site-packages that automatically imports beautiful_traceback
+    on interpreter startup. Only works within virtual environments.
+    """
+    if not _is_in_venv():
+        print("Error: Not running in a virtual environment", file=sys.stderr)
+        print(
+            "Beautiful traceback pth injection only works in virtual environments",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+
+    site_packages = _get_site_packages()
+    pth_file = site_packages / "beautiful_traceback_injection.pth"
+    py_file = site_packages / "_beautiful_traceback_injection.py"
+
+    _create_injection_files(py_file, pth_file)
+
+    print(f"Beautiful traceback injection installed: {pth_file}")
+
+
+def _is_in_venv() -> bool:
+    """Check if running in a virtual environment."""
+    return hasattr(sys, "real_prefix") or (
+        hasattr(sys, "base_prefix") and sys.base_prefix != sys.prefix
+    )
+
+
+def _get_site_packages() -> Path:
+    """Get the site-packages directory for the current Python environment."""
+    import site
+
+    site_packages_list = site.getsitepackages()
+
+    if not site_packages_list:
+        print("Error: Could not find site-packages directory", file=sys.stderr)
+        sys.exit(1)
+
+    return Path(site_packages_list[0])
+
+
+def _create_injection_files(py_file: Path, pth_file: Path) -> None:
+    """Create the Python injection file and .pth file."""
+    py_content = """def run_startup_script():
+  try:
+    import beautiful_traceback
+    beautiful_traceback.install(only_tty=False)
+  except ImportError:
+    pass
+
+run_startup_script()
+"""
+
+    py_file.write_text(py_content)
+    pth_file.write_text("import _beautiful_traceback_injection\n")
+
+
+def main() -> None:
+    """Main CLI entrypoint."""
+    inject_pth()
+
+
+if __name__ == "__main__":
+    main()

{beautiful_traceback-0.1.0 → beautiful_traceback-0.2.0}/beautiful_traceback/formatting.py

@@ -460,7 +460,7 @@ def exc_to_traceback_str(
 
     cur_exc_value: BaseException = exc_value
     cur_traceback: types.TracebackType = traceback
-    
+
     # Track seen exceptions to prevent infinite loops from circular references
     seen_exceptions: typ.Set[int] = set()
 
@@ -471,7 +471,7 @@ def exc_to_traceback_str(
             # Circular reference detected, break the loop
             break
         seen_exceptions.add(exc_id)
-        
+
         next_cause = getattr(cur_exc_value, "__cause__", None)
         next_context = getattr(cur_exc_value, "__context__", None)
 

{beautiful_traceback-0.1.0 → beautiful_traceback-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "beautiful-traceback"
-version = "0.1.0"
+version = "0.2.0"
 description = "Beautiful, readable Python tracebacks with colors and formatting"
 keywords = ["traceback", "error", "debugging", "formatting"]
 readme = "README.md"
@@ -9,6 +9,9 @@ dependencies = ["colorama>=0.4.6"]
 authors = [{ name = "Michael Bianco", email = "mike@mikebian.co" }]
 urls = { "Repository" = "https://github.com/iloveitaly/beautiful-traceback" }
 
+[project.scripts]
+beautiful-traceback = "beautiful_traceback.cli:main"
+
 [build-system]
 requires = ["uv_build>=0.8.11,<0.9.0"]
 build-backend = "uv_build"
@@ -18,9 +21,16 @@ build-backend = "uv_build"
 module-root = ""
 
 [dependency-groups]
-dev = ["pytest>=8.3.3"]
+dev = [
+    "pytest>=8.3.3",
+    "ruff>=0.8.0",
+    "pyright>=1.1.380",
+]
 
 [project.entry-points.pytest11]
 beautiful_traceback = "beautiful_traceback.pytest_plugin"
 
+[tool.pyright]
+exclude = ["examples/", ".venv"]
+