Metadata-Version: 2.4
Name: bannerforge
Version: 0.1.0
Summary: Colorful terminal banner generator with automatic rendering.
Author-email: Himanta Bhuyan <realximanta@users.noreply.github.com>
License: See LICENSE
Project-URL: Homepage, https://github.com/realximanta/bannerforge
Project-URL: Repository, https://github.com/realximanta/bannerforge
Keywords: banner,terminal,cli,ascii,cfonts
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Topic :: Terminals
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cfonts
Requires-Dist: colorama
Dynamic: license-file

# bannerforge

Colorful terminal banners. One line, one print, done.

```
██╗  ██╗███████╗██╗     ██╗      ██████╗
██║  ██║██╔════╝██║     ██║     ██╔═══██╗
███████║█████╗  ██║     ██║     ██║   ██║
██╔══██║██╔══╝  ██║     ██║     ██║   ██║
██║  ██║███████╗███████╗███████╗╚██████╔╝
╚═╝  ╚═╝╚══════╝╚══════╝╚══════╝ ╚═════╝
                                      World
```

## install

```bash
pip install bannerforge
```

## usage

```python
from bannerforge import banner

banner("HELLO", "World")
```

That's it. No `print()`, no assignment, no ceremony. The banner renders on
its own.

### alignment

```python
banner("HELLO", "World").left()
banner("HELLO", "World").right()
banner("HELLO", "World").center()
```

Only the subtitle moves. The main text is always centered.

### no subtitle

```python
banner("HELLO")
```

## how it works

The banner object renders itself in `__del__`. When you don't bind the
return value, Python drops the reference immediately and the banner
prints. If you *do* bind it, the banner waits until the variable goes
out of scope.

```python
# prints immediately
banner("HELLO", "World")

# prints when x goes out of scope / program ends
x = banner("HELLO", "World")
```

## license

Custom Attribution License — see [LICENSE](./LICENSE).

You can use, modify, and redistribute this code freely. If you do, you
must credit **Himanta Bhuyan** and link back to this repository.

## author

Himanta Bhuyan — [@realximanta](https://github.com/realximanta)
