Git Product home page Git Product logo

dressup's Introduction

Dress up

Dress up logo

Tests Codecov PyPI Python Version Read the Docs License Code style: black

Convert your strings to various Unicode characters. Turn "words" into "๐”ด๐”ฌ๐”ฏ๐”ก๐”ฐ", "๐Ÿ††๐Ÿ…พ๐Ÿ†๐Ÿ…ณ๐Ÿ†‚", and "๐”€๐“ธ๐“ป๐“ญ๐“ผ".

usage animation


Documentation: https://dressup.readthedocs.io/


Contents

  1. Installation
  2. Usage
  3. Contributing

Installation

To install Dress up, run this command in your terminal

โฏ python -m pip install dressup

If you're using it primarily as a command-line tool, it's recommended you install it via pipx

โฏ pipx install dressup

Usage

There are two primary ways to use Dress upโ€”as a command-line tool, or as Python library.

Command-line usage

Display all possible transformations by running:

โฏ dressup Hello
Circle

โ’ฝโ“”โ“›โ“›โ“ž

Negative circle

๐Ÿ…—๐Ÿ…”๐Ÿ…›๐Ÿ…›๐Ÿ…ž

Monospace

๏ผจ๏ฝ…๏ฝŒ๏ฝŒ๏ฝ

Math bold

๐‡๐ž๐ฅ๐ฅ๐จ

...

Return only a specific transformation by using the --type flag.

โฏ dressup Vibes --type inverted
๐Œกฤฑqวs

Autocompletion

autocompletion animation

Dress up supports argument completions along with live previews. To enable autocompletion run.

โฏ dressup --install-completion zsh
zsh completion installed in /Users/username/.zshrc.

Completion will take effect once you restart the terminal.

zsh may be replaced with bash, fish, powershell, or pwsh. Along with typical autocompletion, when typing in a value for --type if [TAB] is pressed the matching parameter values will be displayed below along with a preview of the conversion.

โฏ dressup Words --type math [TAB]
math-bold              -- ๐–๐จ๐ซ๐๐ฌ
math-bold-fraktur      -- ๐–‚๐–”๐–—๐–‰๐–˜
math-bold-italic       -- ๐‘พ๐’๐’“๐’…๐’”
math-bold-script       -- ๐“ฆ๐“ธ๐“ป๐“ญ๐“ผ
math-double-struck     -- ๐•Ž๐• ๐•ฃ๐••๐•ค
math-fraktur           -- ๐”š๐”ฌ๐”ฏ๐”ก๐”ฐ
math-monospace         -- ๐š†๐š˜๐š›๐š๐šœ
math-sans              -- ๐–ถ๐—ˆ๐—‹๐–ฝ๐—Œ
math-sans-bold         -- ๐—ช๐—ผ๐—ฟ๐—ฑ๐˜€
math-sans-bold-italic  -- ๐™’๐™ค๐™ง๐™™๐™จ
math-sans-italic       -- ๐˜ž๐˜ฐ๐˜ณ๐˜ฅ๐˜ด

Library usage

To convert characters, use convert.

import dressup

dressup.convert("Hello", unicode_type="negative circle")
'๐Ÿ…—๐Ÿ…”๐Ÿ…›๐Ÿ…›๐Ÿ…ž'

To return all possible conversions, use show_all.

import dressup

dressup.show_all("Hello")
{'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'}

Contributing

All character mappings are stored in translator.toml. Want to add a new mapping or tweak an existing one? Simply edit translator.toml and create a pull request.

Check out CONTRIBUTING.md for general contribution guidelines.

dressup's People

Contributors

dependabot-preview[bot] avatar paw-lu avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.