https://github.com/ruslanlap/emoji-styler
https://github.com/ruslanlap/emoji-styler
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ruslanlap/emoji-styler
- Owner: ruslanlap
- License: other
- Created: 2025-11-15T19:19:36.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-11-15T20:45:58.000Z (7 months ago)
- Last Synced: 2025-11-15T21:15:14.280Z (7 months ago)
- Language: TypeScript
- Size: 23.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Emoji Styler โจ
- ๐ **Web demo**: Try it online at [emoji-styler.vercel.app](https://emoji-styler.vercel.app/)
Transform boring text into fun emoji styles! Make your text stand out with kawaii, hacker, neon, cyberpunk, and minimal styles.
## Features
- ๐จ **5 unique styles**: cute, hacker, neon, cyberpunk, minimal
- ๐ **Python API**: Use in your Python projects
- ๐ป **CLI tool**: Style text from command line
- ๐ **Lightweight**: Zero dependencies
- ๐ **Web demo**: Try it online at [emoji-styler.vercel.app](https://emoji-styler-g3zyvdtk7-ruslantodo.vercel.app)
## Installation
```bash
pip install emoji-styler
```
## Quick Start
### Command Line
```bash
# Default cute style
emoji-styler "Hello world"
# โจ ๐ H ๐ซ e ๐ธ l ๐ l ๐ o ๐ w ๐ซ o ๐ธ r ๐ l ๐ d โจ
# Hacker style
emoji-styler "Hello world" --style hacker
# โก H3ll0 w0rld โก
# Cyberpunk style
emoji-styler "PowerToys Run" --style cyberpunk
# โก โจPโฉโจOโฉโจWโฉโจEโฉโจRโฉโจTโฉโจOโฉโจYโฉโจSโฉโกโจRโฉโจUโฉโจNโฉ โก
# List all styles
emoji-styler --list-styles
```
### Python API
```python
from emoji_styler import style_text, get_available_styles
# Style some text
result = style_text("Hello", style="cute")
print(result)
# โจ ๐ H ๐ซ e ๐ธ l ๐ l ๐ o โจ
# Get available styles
styles = get_available_styles()
print(styles)
# ['cute', 'hacker', 'neon', 'cyberpunk', 'minimal']
# Try different styles
for style in ['hacker', 'neon', 'minimal']:
print(f"{style}: {style_text('Hello', style)}")
```
## Available Styles
### Cute (default)
Kawaii aesthetic with hearts and sparkles
```
Input: Hello world
Output: โจ ๐ H ๐ซ e ๐ธ l ๐ l ๐ o ๐ w ๐ซ o ๐ธ r ๐ l ๐ d โจ
```
### Hacker
1337 speak with letter substitutions
```
Input: Hello world
Output: โก H3ll0 w0rld โก
```
### Neon
Rainbow glow vibes with uppercase
```
Input: Hello world
Output: ๐ H E L L O ๐ W O R L D ๐
```
### Cyberpunk
Futuristic brackets and lightning
```
Input: Hello world
Output: โก โจHโฉโจEโฉโจLโฉโจLโฉโจOโฉโกโจWโฉโจOโฉโจRโฉโจLโฉโจDโฉ โก
```
### Minimal
Clean aesthetic with dots
```
Input: Hello world
Output: Hใปeใปlใปlใปo ใปoใปrใปlใปd
```
## Web Demo
Try it online: [emoji-styler.vercel.app](https://emoji-styler.vercel.app)
The web demo is built with Next.js and TypeScript, featuring:
- Interactive text styling
- Beautiful Catppuccin Macchiato theme
- Mobile-friendly responsive design
- Live examples and presets
See [web/README.md](web/README.md) for development details.
## Project Structure
```
emoji-styler/
โโโ emoji_styler/ # Python package
โ โโโ __init__.py # Package exports
โ โโโ core.py # Main style_text() function
โ โโโ styles.py # Style implementations
โ โโโ cli.py # Command-line interface
โโโ tests/ # Python tests
โโโ web/ # Next.js web demo
โ โโโ app/ # Next.js pages
โ โโโ components/ # React components
โ โโโ lib/ # TypeScript styles (ported from Python)
โ โโโ README.md # Web demo docs
โโโ .github/
โ โโโ workflows/ # CI/CD pipelines
โ โโโ publish.yml # PyPI publishing
โ โโโ test.yml # Automated testing
โโโ pyproject.toml # Python package config
โโโ LICENSE # MIT license
โโโ README.md # This file
```
## Development
### Python Package
```bash
# Clone repository
git clone https://github.com/ruslanlap/emoji-styler.git
cd emoji-styler
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install in development mode
pip install -e ".[dev]"
# Run tests
pytest
# Run tests with coverage
pytest --cov=emoji_styler
```
### Web Demo
```bash
# Navigate to web directory
cd web
# Install dependencies
npm install
# Run development server
npm run dev
# Build for production
npm run build
```
See [web/README.md](web/README.md) for deployment instructions.
## Publishing
### To PyPI
Publishing is automated via GitHub Actions. To release a new version:
```bash
# 1. Update version in pyproject.toml
# 2. Commit and push
git add pyproject.toml
git commit -m "Bump version to 0.2.0"
git push
# 3. Create and push tag
git tag v0.2.0
git push origin v0.2.0
# 4. GitHub Actions will automatically:
# - Build package
# - Create GitHub release
# - Publish to PyPI
```
See [.github/RELEASE.md](.github/RELEASE.md) for detailed instructions.
### Web Demo to Vercel
```bash
cd web
vercel
# Follow prompts
```
Or connect your GitHub repo to Vercel dashboard for automatic deployments.
## Roadmap
- [x] Python package with CLI
- [x] Web demo with Next.js
- [x] Automated publishing to PyPI
- [ ] Telegram bot for styling messages
- [ ] VS Code extension
- [ ] More emoji styles (retro, space, nature)
- [ ] Custom style creator
- [ ] REST API endpoint
## Contributing
Contributions welcome! Feel free to:
- Suggest new styles
- Report bugs
- Submit pull requests
## License
MIT License - see [LICENSE](LICENSE) file for details
## Links
- ๐ฆ [PyPI](https://pypi.org/project/emoji-styler/)
- ๐ [GitHub](https://github.com/ruslanlap/emoji-styler)
- ๐ [Web Demo](https://emoji-styler.vercel.app) (coming soon)
- ๐ค [Telegram Bot](https://t.me/emoji_styler_bot) (coming soon)
---
Made with ๐ by [Ruslan](https://github.com/ruslanlap)