Metadata-Version: 2.4
Name: burmalda
Version: 1.0.0
Summary: Print Burmalda when a Python program crashes.
Project-URL: Homepage, https://github.com/multivarka1/burmalda
Project-URL: Issues, https://github.com/multivarka1/burmalda/issues
Author: Burmalda maintainers
License-Expression: MIT
License-File: LICENSE
Keywords: console,errors,excepthook,exception
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# burmalda

`burmalda` is a tiny Python library that prints `Burmalda` to the console when
your program exits because of an unhandled exception.

## Installation

```bash
pip install burmalda
```

## Usage

Install the exception hook near the start of your program:

```python
import burmalda

burmalda.install()

raise RuntimeError("Something broke")
```

The program will still show the normal Python traceback, and `Burmalda` will be
printed to standard error before it.

## API

### `burmalda.install(message="Burmalda")`

Installs the global exception hook and returns the previous `sys.excepthook`.
Calling it more than once is safe.

### `burmalda.uninstall()`

Restores the exception hook that was active before `burmalda.install()`.

### `burmalda.burmalda(message="Burmalda")`

A context manager that installs the hook temporarily:

```python
import burmalda

with burmalda.burmalda():
    raise RuntimeError("Something broke")
```

