<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)
Raw data
{
"_id": null,
"home_page": "https://github.com/ekm507/araste",
"name": "araste",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "figlet",
"author": "Erfan Kheirollahi",
"author_email": "ekm507@gmail.com",
"download_url": "",
"platform": null,
"description": "<div align=\"center\">\n <h1> Araste </h1>\n <h2> making ascii-art out of Persian/Arabic text </h2>\n</div>\n\nSimilar to the figlet and toilet tools, but for Persian and Arabic texts.\n\nusage:\n\n```bash\naraste <your text>\n```\n\nuse `-f` switch to choose font\n\n```bash\naraste 'your persian/arabic text' -f 'fontpath or fontname'\n```\n\nto get a list of installed fonts:\n\n```bash\naraste --list\n```\n\nfor now, there are a few fonts that you can use:\n```\naipara\naipara_mini\nzivar\nnima\n```\n\nit can also read text from stdin. so you can do something like this:\n\n```bash\necho '\u0622\u0631\u0627\u0633\u062a\u0647' | araste\n```\n\nto get help:\n\n```bash\naraste -h\n```\n\n\nan output with the default font (aipara):\n\n```\n \u2588\u2588\u2588\u2588\u2588\u2588\n \u2588\u2588\u2588\u2588 \u2588\u2588 \u2588\u2588\n \u2588\u2588\u2588\u2588 \u2588\u2588 \u2588\u2588\n \u2588\u2588\u2588\u2588 \u2588\u2588 \u2588\u2588 \u2588\u2588 \u2588\u2588 \u2588\u2588 \u2588\u2588 \u2588\u2588\n \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588 \u2588\u2588 \u2588\u2588 \u2588\u2588\n \u2588\u2588\n \u2588\u2588\n```\n\n\n### filters\n\naraste has various filters for decorating the output. use filters with `-F` switch.\n\nfor instance, you can use `rainbow` filter like this:\n\n```bash\n$ araste 'colorful text' -F rainbow\n```\n\nalso you can concatenate several filters. to do so, just type their names one by one after `-F` switch.\n\nfor instance:\n\n```bash\n$ araste \u0646\u0648\u0634\u062a\u0647 -F hmirror box\n```\n\noutput:\n```\n\u2554\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2557\n\u2551 \u2588\u2588 \u2551\n\u2551\u2588\u2588 \u2588\u2588\u2588\u2588 \u2588\u2588\u2588\u2588 \u2551\n\u2551 \u2588\u2588\u2588\u2588 \u2551\n\u2551\u2588\u2588 \u2588\u2588\u2588\u2588 \u2588\u2588 \u2588\u2588 \u2588\u2588 \u2588\u2588 \u2588\u2588\u2588\u2588 \u2551\n\u2551\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588 \u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588\u2588 \u2551\n\u2551 \u2588\u2588 \u2551\n\u2551 \u2588\u2588 \u2551\n\u2551 \u2551\n\u255a\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u2550\u255d\n```\n\nto get a list of available filters, use `--filter-list` switch:\n\n```bash\n$ araste --filter-list\n```\n\n\n\n## Install and Usage\n\nfor installing you only need to execute following command.\n\n````bash\npip install araste\n````\nNote: 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.)\n````bash\npipx install araste\n````\n\n2. or to build it yourself:\n\n```bash\ngit clone 'https://github.com/ekm507/araste/'\ncd araste\npython3 setup.py bdist_wheel\npip install ./dist/araste-1.2.1-py3-none-any.whl\n```\n\n## Instaling Fonts\nFor Installing Fonts You Can Use araste-get\n````bash\naraste-get FontName\n````\n## Unistall\n\nto uninstall araste, simply use pip.\n\n```bash\npip uninstall araste\n```\nOr pipx:\n````bash\npipx uninstall araste\n````\n\n## Creating New Fonts!\n\nTo 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.\n\n## Todos\n\nTodos have been moved to a separate file. [TODOS](https://github.com/ekm507/araste/blob/main/TODOS_EN.md)\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Convert persian text to ascii art",
"version": "3.3",
"project_urls": {
"Homepage": "https://github.com/ekm507/araste"
},
"split_keywords": [
"figlet"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc1401a857e753bddfbcacae278f032b637cf822654d09c6a0708e5da95cb2d0",
"md5": "a0bbc31a80aff0b629ef8e39f437a4b4",
"sha256": "04f6bd4a68290b935bb5ee19c5b055faabcc6c9d79577b9eb9390c3c9b29388b"
},
"downloads": -1,
"filename": "araste-3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0bbc31a80aff0b629ef8e39f437a4b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 49057,
"upload_time": "2024-03-19T10:52:53",
"upload_time_iso_8601": "2024-03-19T10:52:53.571759Z",
"url": "https://files.pythonhosted.org/packages/dc/14/01a857e753bddfbcacae278f032b637cf822654d09c6a0708e5da95cb2d0/araste-3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 10:52:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ekm507",
"github_project": "araste",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "argparse",
"specs": []
},
{
"name": "requests",
"specs": []
}
],
"lcname": "araste"
}
JSON
