Metadata-Version: 2.4
Name: persian-figlet
Version: 0.1.2
Summary: Figlet-style ASCII art for Persian text (Python port of moh3n9595/persian-figlet)
Author: Hamidreza Sadeghi
License: MIT License
        
        Copyright (c) 2025 Mohsen
        
        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.
        
Project-URL: Homepage, https://github.com/horrhamid/persian-figlet
Project-URL: Repository, https://github.com/horrhamid/persian-figlet
Project-URL: Bug Tracker, https://github.com/horrhamid/persian-figlet/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Text Processing :: Fonts
Classifier: Topic :: Text Processing :: Linguistic
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Persian Figlet (Python)

Figlet-style ASCII art for Persian (Farsi) text with contextual shaping and RTL handling. Python port of [`moh3n9595/persian-figlet`](https://github.com/moh3n9595/persian-figlet).

## Install

```bash
pip install persian-figlet
```

## Usage

### CLI

```bash
persian-figlet "سلام"
```

Options:
- `--font standard` – font name or path to a JSON font file
- `--silent` – suppress console output

### API

```python
from persian_figlet import render

# Prints to stdout
render("سلام")

# Returns the ASCII art string
art = render("سلام", silent=True)
```

## Development

- Install dev tools: `python -m pip install -e .[dev]` (or just `pip install -e .` if you only need the package).
- Run tests: `python -m pytest`

## License

MIT License. Original work by Mohsen Madani; Python port by Hamidreza Sadeghi.
