semvec/pypi-packages huggingface dataset:
araste 3.3
Convert persian text to ascii art
Keywords: figlet

<div align="center">
  <h1> Araste </h1>
  <h2> making ascii-art out of Persian/Arabic text </h2>
</div>

Similar to the figlet and toilet tools, but for Persian and Arabic texts.

usage:

```bash
araste <your text>
```

use `-f` switch to choose font

```bash
araste 'your persian/arabic text' -f 'fontpath or fontname'
```

to get a list of installed fonts:

```bash
araste --list
```

for now, there are a few fonts that you can use:
```
aipara
aipara_mini
zivar
nima
```

it can also read text from stdin. so you can do something like this:

```bash
echo 'آراسته' | araste
```

to get help:

```bash
araste -h
```


an output with the default font (aipara):

```
                                      ██████
        ████                ██        ██
  ████                      ██          ██
  ████    ██    ██  ██  ██  ██    ██    ██
    ██████████████████████  ██    ██    ██
                                  ██
                                ██
```


### filters

araste has various filters for decorating the output. use filters with `-F` switch.

for instance, you can use `rainbow` filter like this:

```bash
$ araste 'colorful text' -F rainbow
```

also you can concatenate several filters. to do so, just type their names one by one after `-F` switch.

for instance:

```bash
$ araste نوشته -F hmirror box
```

output:
```
╔════════════════════════════════════╗
║              ██                    ║
║██            ████      ████        ║
║                              ████  ║
║██  ████  ██  ██  ██    ██    ████  ║
║████████  ██████████████████████    ║
║    ██                              ║
║      ██                            ║
║                                    ║
╚════════════════════════════════════╝
```

to get a list of available filters, use `--filter-list` switch:

```bash
$ araste --filter-list
```



## Install and Usage

for installing you only need to execute following command.

````bash
pip install araste
````
Note: if you get the following error: externally-managed-environment, you can install araste using pipx (Make sure that python-pipx is installed on your system.)
````bash
pipx install araste
````

2. or to build it yourself:

```bash
git clone 'https://github.com/ekm507/araste/'
cd araste
python3 setup.py bdist_wheel
pip install ./dist/araste-1.2.1-py3-none-any.whl
```

## Instaling Fonts
For Installing Fonts You Can Use araste-get
````bash
araste-get FontName
````
## Unistall

to uninstall araste, simply use pip.

```bash
pip uninstall araste
```
Or pipx:
````bash
pipx uninstall araste
````

## Creating New Fonts!

To get additional fonts for araste or to create your own custom fonts, use tools and manuals in [araste-fonts](https://github.com/ekm507/araste-fonts) repo.

## Todos

Todos have been moved to a separate file. [TODOS](https://github.com/ekm507/araste/blob/main/TODOS_EN.md)