# zalgo-cli
A simple command line tool and [Gradio app](https://huggingface.co/spaces/tddschn/zalgo-gradio) to generate zalgo texts, or de-zalgo texts.
- [zalgo-cli](#zalgo-cli)
- [Demo](#demo)
- [CLI](#cli)
- [Gradio](#gradio)
- [Installation](#installation)
- [pipx](#pipx)
- [pip](#pip)
- [zalgo-gradio](#zalgo-gradio)
- [Usage](#usage)
- [CLI](#cli-1)
- [Gradio](#gradio-1)
- [Library](#library)
- [Develop](#develop)
- [Credits](#credits)
## Demo
### CLI
```
$ zalgo test -n 20
ṯe͕sͫť t̿e̵s͍t̐ t̜e̼s̗tͨ ẗe̮s̼tͥ
t͋e̞śt̪ t̊e̎s̮t͈ ṯe͊s̗t̍ t̄e̬śt͗
t͕e͓s͜t͕ tͯe̙s͙t͍ t̀e̊s̏t̲ t̰ẽs̕t̗
t̘e͐s̞t̿ ẗeͣs͆t̸ t͙e͉s̑t̤ t̀e͙s̐t̋
t͆e̟s̈́tͦ t̛e͏s̛t͕ t̆eͮs̠tͮ t͋e̱s͎tͦ
```
```
# accept input from stdin, adding tons of the zalgo-thingys
# output is too crazy to be put here
$ echo 'hello world' | zalgo -n 5 -o -a1000
```
**Specifying a list of unicode codepoints to zalgo-fy the text**
See https://www.compart.com/en/unicode/block/U+0300
```
# add `t' diacratic marks (U+036D) on t 100 times, then add `c' diacratic marks on c 100 times
$ zalgo 'tc' -a100 -c '0x036D 0x0368'
tͭͭͭcͨͨͨ
```
**De-zalgo-fy the text**
```
$ zalgo -z 'Z̐ȃļg̡ò'
Zalgo
```
### Gradio
https://huggingface.co/spaces/tddschn/zalgo-gradio
```
$ zalgo-gradio
```
## Installation
### pipx
This is the recommended installation method.
```
$ pipx install zalgo-cli
```
### [pip](https://pypi.org/project/zalgo-cli/)
```
$ pip install zalgo-cli
```
### zalgo-gradio
`zalgo-gradio` requires an extra dependency to run, you can install it with `pipx install zalgo-cli[gradio]` or `pip install zalgo-cli[gradio]`.
## Usage
### CLI
You can use either `zalgo` or `zalgo-cli` to run the program.
```
$ zalgo --help
usage: zalgo [-h] [-a int] [-l int] [-n int] [-o] [-c str] [-d] [-z] [-V]
[str]
Generate or De-Zalgo text
positional arguments:
str Initial string to Zalgo-fy or De-Zalgo-fy. If not
provided, read from stdin (default: None)
options:
-h, --help show this help message and exit
-a int, --adds-per-char int
Number of additions per character (default: 1)
-l int, --char-limit int
Character limit [0 for no limit] (default: 0)
-n int, --amount int Amount of Zalgo text to generate (default: 1)
-o, -1, --one-per-line
Output one Zalgo-fied string per line (default: False)
-c str, --codepoints str
Codepoints to Add (space-separated hex values, e.g.,
'0x036D 0x0368') (default: )
-d, --debug Enable debug logging (default: False)
-z, --dezalgo De-Zalgo-fy the input string (default: False)
-V, --version show program's version number and exit
```
### Gradio
```
$ zalgo-gradio
```
Or use the hosted version at https://huggingface.co/spaces/tddschn/zalgo-gradio .
### Library
Codes are split into separate files so that you can use it as a library too without hassle.
There's only one core function that you might want to use:
```python
from zalgo_cli import zalgo
```
Read the source code to see how to use it.
## Develop
```
$ git clone https://github.com/tddschn/zalgo-cli.git
$ cd zalgo-cli
$ poetry install
```
## Credits
Initial development of this project was inspired by https://github.com/n-1x/zalgo-cli .
Raw data
{
"_id": null,
"home_page": "https://github.com/tddschn/zalgo-cli",
"name": "zalgo-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "zalgo",
"author": "Teddy Xinyuan Chen",
"author_email": "45612704+tddschn@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/f6/e3/8c3c0e08ef1733cc64e3d21a0e487b3d81d43591d9d5b9020c25b9a9d3ce/zalgo_cli-0.5.0.tar.gz",
"platform": null,
"description": "# zalgo-cli\n\nA simple command line tool and [Gradio app](https://huggingface.co/spaces/tddschn/zalgo-gradio) to generate zalgo texts, or de-zalgo texts.\n\n- [zalgo-cli](#zalgo-cli)\n - [Demo](#demo)\n - [CLI](#cli)\n - [Gradio](#gradio)\n - [Installation](#installation)\n - [pipx](#pipx)\n - [pip](#pip)\n - [zalgo-gradio](#zalgo-gradio)\n - [Usage](#usage)\n - [CLI](#cli-1)\n - [Gradio](#gradio-1)\n - [Library](#library)\n - [Develop](#develop)\n - [Credits](#credits)\n\n## Demo\n\n### CLI\n\n```\n$ zalgo test -n 20\n\nt\u0331e\u0355s\u036bt\u030c\tt\u033fe\u0335s\u034dt\u0310\tt\u031ce\u033cs\u0317t\u0368\tt\u0308e\u032es\u033ct\u0365\t\nt\u034be\u031es\u0341t\u032a\tt\u030ae\u030es\u032et\u0348\tt\u0331e\u034as\u0317t\u030d\tt\u0304e\u032cs\u0341t\u0357\t\nt\u0355e\u0353s\u035ct\u0355\tt\u036fe\u0319s\u0359t\u034d\tt\u0340e\u030as\u030ft\u0332\tt\u0330e\u0303s\u0315t\u0317\t\nt\u0318e\u0350s\u031et\u033f\tt\u0308e\u0363s\u0346t\u0338\tt\u0359e\u0349s\u0311t\u0324\tt\u0300e\u0359s\u0310t\u030b\t\nt\u0346e\u031fs\u0344t\u0366\tt\u031be\u034fs\u031bt\u0355\tt\u0306e\u036es\u0320t\u036e\tt\u034be\u0331s\u034et\u0366\t\n```\n\n```\n# accept input from stdin, adding tons of the zalgo-thingys\n# output is too crazy to be put here\n$ echo 'hello world' | zalgo -n 5 -o -a1000\n```\n\n**Specifying a list of unicode codepoints to zalgo-fy the text**\n\nSee https://www.compart.com/en/unicode/block/U+0300\n\n```\n# add `t' diacratic marks (U+036D) on t 100 times, then add `c' diacratic marks on c 100 times\n$ zalgo 'tc' -a100 -c '0x036D 0x0368'\nt\u036d\u036d\u036dc\u0368\u0368\u0368\t\n```\n\n**De-zalgo-fy the text**\n\n```\n$ zalgo -z 'Z\u0310\u0203\u013cg\u0321\u00f2'\nZalgo\n```\n\n### Gradio\n\nhttps://huggingface.co/spaces/tddschn/zalgo-gradio\n\n```\n$ zalgo-gradio\n```\n\n\n\n## Installation\n\n### pipx\n\nThis is the recommended installation method.\n\n```\n$ pipx install zalgo-cli\n```\n\n### [pip](https://pypi.org/project/zalgo-cli/)\n\n```\n$ pip install zalgo-cli\n```\n\n### zalgo-gradio\n\n`zalgo-gradio` requires an extra dependency to run, you can install it with `pipx install zalgo-cli[gradio]` or `pip install zalgo-cli[gradio]`.\n\n## Usage\n\n### CLI\n\nYou can use either `zalgo` or `zalgo-cli` to run the program.\n\n```\n$ zalgo --help\n\nusage: zalgo [-h] [-a int] [-l int] [-n int] [-o] [-c str] [-d] [-z] [-V]\n [str]\n\nGenerate or De-Zalgo text\n\npositional arguments:\n str Initial string to Zalgo-fy or De-Zalgo-fy. If not\n provided, read from stdin (default: None)\n\noptions:\n -h, --help show this help message and exit\n -a int, --adds-per-char int\n Number of additions per character (default: 1)\n -l int, --char-limit int\n Character limit [0 for no limit] (default: 0)\n -n int, --amount int Amount of Zalgo text to generate (default: 1)\n -o, -1, --one-per-line\n Output one Zalgo-fied string per line (default: False)\n -c str, --codepoints str\n Codepoints to Add (space-separated hex values, e.g.,\n '0x036D 0x0368') (default: )\n -d, --debug Enable debug logging (default: False)\n -z, --dezalgo De-Zalgo-fy the input string (default: False)\n -V, --version show program's version number and exit\n\n\n```\n\n### Gradio\n\n```\n$ zalgo-gradio\n```\n\nOr use the hosted version at https://huggingface.co/spaces/tddschn/zalgo-gradio .\n\n### Library\n\nCodes are split into separate files so that you can use it as a library too without hassle.\n\nThere's only one core function that you might want to use:\n\n```python\nfrom zalgo_cli import zalgo\n```\n\nRead the source code to see how to use it.\n\n## Develop\n\n```\n$ git clone https://github.com/tddschn/zalgo-cli.git\n$ cd zalgo-cli\n$ poetry install\n```\n\n## Credits\n\nInitial development of this project was inspired by https://github.com/n-1x/zalgo-cli .",
"bugtrack_url": null,
"license": "MIT",
"summary": "Zalgo Text Generator CLI",
"version": "0.5.0",
"project_urls": {
"Bug Tracker": "https://github.com/tddschn/zalgo-cli/issues",
"Homepage": "https://github.com/tddschn/zalgo-cli",
"Repository": "https://github.com/tddschn/zalgo-cli"
},
"split_keywords": [
"zalgo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53aae8dee8f11fb33c68e5e5ad61e27f8ac58da7852cc4877238e83cb3affcb7",
"md5": "45449c7eb312990b5f07dbb9a3d610c8",
"sha256": "cdae87f32b8cea7fa6180156a9608ce85812022c196191477bf971678a6132b9"
},
"downloads": -1,
"filename": "zalgo_cli-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45449c7eb312990b5f07dbb9a3d610c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 7102,
"upload_time": "2024-06-12T13:52:42",
"upload_time_iso_8601": "2024-06-12T13:52:42.122907Z",
"url": "https://files.pythonhosted.org/packages/53/aa/e8dee8f11fb33c68e5e5ad61e27f8ac58da7852cc4877238e83cb3affcb7/zalgo_cli-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f6e38c3c0e08ef1733cc64e3d21a0e487b3d81d43591d9d5b9020c25b9a9d3ce",
"md5": "1fe4ad1f96c12f7805f1c94bc381c9cd",
"sha256": "0914be2ec1b83378d373040f3d58c9dc038670d5b57274c379ae5efa012c886b"
},
"downloads": -1,
"filename": "zalgo_cli-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "1fe4ad1f96c12f7805f1c94bc381c9cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 5509,
"upload_time": "2024-06-12T13:52:43",
"upload_time_iso_8601": "2024-06-12T13:52:43.821639Z",
"url": "https://files.pythonhosted.org/packages/f6/e3/8c3c0e08ef1733cc64e3d21a0e487b3d81d43591d9d5b9020c25b9a9d3ce/zalgo_cli-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-12 13:52:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tddschn",
"github_project": "zalgo-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "zalgo-cli"
}
JSON
