# dressuplite
**dressuplite** is a Python 3.11 package to convert strings to use Unicode formatting. It can for instance replace "words" into "๐ด๐ฌ๐ฏ๐ก๐ฐ", "๐๐
พ๐๐
ณ๐", and "๐๐ธ๐ป๐ญ๐ผ". It is a lightweight fork of the original package [`dressup`](https://github.com/paw-lu/dressup/), but without any third-party runtime dependencies.
As a disclaimer, this package has no association with `dressup`.
[](https://github.com/impredicative/dressuplite/actions?query=workflow%3Acicd+branch%3Amaster)
## Links
| Caption | Link |
|-----------|-------------------------------------------------------|
| Repo | https://github.com/impredicative/dressuplite/ |
| Changelog | https://github.com/impredicative/dressuplite/releases |
| Package | https://pypi.org/project/dressuplite/ |
## Development
For software development purposes only, the project can be set up on Ubuntu as below.
```bash
make setup-ppa
make install-py
make setup-venv
source ./venv/bin/activate
make install
make test
```
## Installation
Python โฅ3.11 is required due to the use of [`tomllib`](https://docs.python.org/3/library/tomllib.html). This is due ot the use of TOML in the original package.
To install, run:
$ pip install dressuplite
## Usage
To convert characters:
```python
>>> import dressuplite
>>> dressuplite.convert("Hello", unicode_type="negative circle")
'๐
๐
๐
๐
๐
'
```
To show all possible conversions:
```python
>>> import dressuplite
>>> for unicode_type, text in dressuplite.show_all("Hello").items():
... print(f'{unicode_type.lower()}: {text}')
...
circle: โฝโโโโ
negative circle: ๐
๐
๐
๐
๐
monospace: ๏ผจ๏ฝ
๏ฝ๏ฝ๏ฝ
math bold: ๐๐๐ฅ๐ฅ๐จ
math bold fraktur: ๐ณ๐๐๐๐
math bold italic: ๐ฏ๐๐๐๐
math bold script: ๐๐ฎ๐ต๐ต๐ธ
math double struck: โ๐๐๐๐
math monospace: ๐ท๐๐๐๐
math sans: ๐ง๐พ๐
๐
๐
math sans bold: ๐๐ฒ๐น๐น๐ผ
math sans bold italic: ๐๐๐ก๐ก๐ค
math sans italic: ๐๐ฆ๐ญ๐ญ๐ฐ
parenthesized: โฃโ โงโงโช
square: ๐ท๐ด๐ป๐ป๐พ
negative square: ๐
ท๐
ด๐
ป๐
ป๐
พ
cute: Hรฉฤบฤบล
math fraktur: โ๐ข๐ฉ๐ฉ๐ฌ
rock dots: แธฆรซแธทแธทรถ
small caps: สแดสสแด
stroked: ฤฆษลลรธ
subscript: โโโโโ
superscript: แดดแตหกหกแต
inverted: ษฅวืืo
reversed: Hษโ
โ
o
```
Character mappings are precomputed and defined in [`translator.toml`](dressuplite/translator.toml).
Raw data
{
"_id": null,
"home_page": "https://github.com/impredicative/dressuplite/",
"name": "dressuplite",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "unicode text",
"author": "Ouroboros Chrysopoeia",
"author_email": "impredicative@users.nomail.github.com",
"download_url": "https://files.pythonhosted.org/packages/46/42/584a10e17fb1cdc0469120d45b3b287b83bf64063a4cc12667147c3ab52d/dressuplite-0.1.2.tar.gz",
"platform": null,
"description": "# dressuplite\n**dressuplite** is a Python 3.11 package to convert strings to use Unicode formatting. It can for instance replace \"words\" into \"\ud835\udd34\ud835\udd2c\ud835\udd2f\ud835\udd21\ud835\udd30\", \"\ud83c\udd86\ud83c\udd7e\ud83c\udd81\ud83c\udd73\ud83c\udd82\", and \"\ud835\udd00\ud835\udcf8\ud835\udcfb\ud835\udced\ud835\udcfc\". It is a lightweight fork of the original package [`dressup`](https://github.com/paw-lu/dressup/), but without any third-party runtime dependencies.\n\nAs a disclaimer, this package has no association with `dressup`.\n\n[](https://github.com/impredicative/dressuplite/actions?query=workflow%3Acicd+branch%3Amaster)\n\n\n## Links\n| Caption | Link |\n|-----------|-------------------------------------------------------|\n| Repo | https://github.com/impredicative/dressuplite/ |\n| Changelog | https://github.com/impredicative/dressuplite/releases |\n| Package | https://pypi.org/project/dressuplite/ |\n\n\n## Development\nFor software development purposes only, the project can be set up on Ubuntu as below.\n```bash\nmake setup-ppa\nmake install-py\nmake setup-venv\nsource ./venv/bin/activate\nmake install\nmake test\n```\n\n## Installation\nPython \u22653.11 is required due to the use of [`tomllib`](https://docs.python.org/3/library/tomllib.html). This is due ot the use of TOML in the original package.\n\nTo install, run:\n\n $ pip install dressuplite\n\n## Usage\nTo convert characters:\n```python\n>>> import dressuplite\n\n>>> dressuplite.convert(\"Hello\", unicode_type=\"negative circle\")\n'\ud83c\udd57\ud83c\udd54\ud83c\udd5b\ud83c\udd5b\ud83c\udd5e'\n```\n\nTo show all possible conversions:\n```python\n>>> import dressuplite\n\n>>> for unicode_type, text in dressuplite.show_all(\"Hello\").items():\n... print(f'{unicode_type.lower()}: {text}')\n... \ncircle: \u24bd\u24d4\u24db\u24db\u24de\nnegative circle: \ud83c\udd57\ud83c\udd54\ud83c\udd5b\ud83c\udd5b\ud83c\udd5e\nmonospace: \uff28\uff45\uff4c\uff4c\uff4f\nmath bold: \ud835\udc07\ud835\udc1e\ud835\udc25\ud835\udc25\ud835\udc28\nmath bold fraktur: \ud835\udd73\ud835\udd8a\ud835\udd91\ud835\udd91\ud835\udd94\nmath bold italic: \ud835\udc6f\ud835\udc86\ud835\udc8d\ud835\udc8d\ud835\udc90\nmath bold script: \ud835\udcd7\ud835\udcee\ud835\udcf5\ud835\udcf5\ud835\udcf8\nmath double struck: \u210d\ud835\udd56\ud835\udd5d\ud835\udd5d\ud835\udd60\nmath monospace: \ud835\ude77\ud835\ude8e\ud835\ude95\ud835\ude95\ud835\ude98\nmath sans: \ud835\udda7\ud835\uddbe\ud835\uddc5\ud835\uddc5\ud835\uddc8\nmath sans bold: \ud835\udddb\ud835\uddf2\ud835\uddf9\ud835\uddf9\ud835\uddfc\nmath sans bold italic: \ud835\ude43\ud835\ude5a\ud835\ude61\ud835\ude61\ud835\ude64\nmath sans italic: \ud835\ude0f\ud835\ude26\ud835\ude2d\ud835\ude2d\ud835\ude30\nparenthesized: \u24a3\u24a0\u24a7\u24a7\u24aa\nsquare: \ud83c\udd37\ud83c\udd34\ud83c\udd3b\ud83c\udd3b\ud83c\udd3e\nnegative square: \ud83c\udd77\ud83c\udd74\ud83c\udd7b\ud83c\udd7b\ud83c\udd7e\ncute: H\u00e9\u013a\u013a\u0151\nmath fraktur: \u210c\ud835\udd22\ud835\udd29\ud835\udd29\ud835\udd2c\nrock dots: \u1e26\u00eb\u1e37\u1e37\u00f6\nsmall caps: \u029c\u1d07\u029f\u029f\u1d0f\nstroked: \u0126\u0247\u0142\u0142\u00f8\nsubscript: \u2095\u2091\u2097\u2097\u2092\nsuperscript: \u1d34\u1d49\u02e1\u02e1\u1d52\ninverted: \u0265\u01dd\u05df\u05dfo\nreversed: H\u0258\u2143\u2143o\n```\n\nCharacter mappings are precomputed and defined in [`translator.toml`](dressuplite/translator.toml).\n",
"bugtrack_url": null,
"license": "",
"summary": "Dependency-free lightweight fork of the package \"dressup\" to convert strings to use Unicode formatting",
"version": "0.1.2",
"split_keywords": [
"unicode",
"text"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "300f731d35a18cfcd4264da482d11858",
"sha256": "b33d6a241771d74154d896b1f03cac16cb49389eb268fc98db10f1ab8cdaa9f3"
},
"downloads": -1,
"filename": "dressuplite-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "300f731d35a18cfcd4264da482d11858",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 11818,
"upload_time": "2022-12-06T02:53:08",
"upload_time_iso_8601": "2022-12-06T02:53:08.019956Z",
"url": "https://files.pythonhosted.org/packages/c2/31/dc67d4d613eaec9ab887e8d9073e84ad9c34b78573e7aeec0fcbed5349fc/dressuplite-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "643280f8ff091864a31d45f511c4c14f",
"sha256": "23e0b013a7e0770a281dd44352927ee8a45d5fe7fdd9fa6635302e5876623b42"
},
"downloads": -1,
"filename": "dressuplite-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "643280f8ff091864a31d45f511c4c14f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 12762,
"upload_time": "2022-12-06T02:53:09",
"upload_time_iso_8601": "2022-12-06T02:53:09.469209Z",
"url": "https://files.pythonhosted.org/packages/46/42/584a10e17fb1cdc0469120d45b3b287b83bf64063a4cc12667147c3ab52d/dressuplite-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-06 02:53:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "impredicative",
"github_project": "dressuplite",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dressuplite"
}
JSON
