uchr 0.3.0__tar.gz

uchr-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Miki Yutani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

uchr-0.3.0/PKG-INFO

@@ -0,0 +1,314 @@
+Metadata-Version: 2.3
+Name: uchr
+Version: 0.3.0
+Summary: Unicode character tools
+License: MIT
+Keywords: unicode,character,tools,cli
+Author: Miki Yutani
+Author-email: mkyutani@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing :: General
+Classifier: Topic :: Utilities
+Requires-Dist: requests (>=2.25.0,<3.0.0)
+Project-URL: Homepage, https://github.com/mkyutani/unicode-tools
+Project-URL: Repository, https://github.com/mkyutani/unicode-tools
+Description-Content-Type: text/markdown
+
+# Unicode Tools
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![Unicode](https://img.shields.io/badge/Unicode-15.0-green.svg)](https://unicode.org/)
+
+A powerful command-line tool for searching and exploring Unicode characters, emoji sequences, and character properties.
+
+## 🚀 Features
+
+- **Search by name**: Find characters by their Unicode name
+- **Search by code**: Look up characters by code point or range
+- **Search by character**: Reverse lookup from character to details
+- **Search by block**: Explore characters within Unicode blocks
+- **Emoji support**: Full support for emoji sequences and ZWJ sequences
+- **CJK details**: Enhanced descriptions for CJK characters using kDefinition
+- **Flexible output**: Multiple output formats for different use cases
+
+## 📖 Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Usage Examples](#usage-examples)
+- [Command Reference](#command-reference)
+- [Database Management](#database-management)
+- [Contributing](#contributing)
+- [License](#license)
+
+## 🛠 Installation
+
+### Install from source
+
+```bash
+git clone https://github.com/mkyutani/unicode-tools.git
+cd unicode-tools
+pip install -e .
+```
+
+### Initialize database
+
+Create the Unicode database (required for first use):
+
+```bash
+uchr db create
+```
+
+This downloads Unicode 15.0 data and creates a local SQLite database (~13MB) at:
+- Linux/macOS: `~/.local/share/unicode-tools/unicode.db`
+- Root users: Automatically chooses between system (`/var/lib/unicode-tools/`) or personal location
+
+## ⚡ Quick Start
+
+```bash
+# Search for ghost-related characters
+uchr search ghost
+
+# Find characters in a code range
+uchr search -c 1F47A-1F480
+
+# Search by character
+uchr search -x 👻
+
+# Search within a Unicode block
+uchr search -b "Emoticons"
+```
+
+## 📋 Usage Examples
+
+### Search by Name
+
+```bash
+uchr search goblin
+```
+```
+👺 1F47A JAPANESE GOBLIN
+```
+
+### Search by Code Range
+
+```bash
+uchr search -c 1F479-1F47B
+```
+```
+👹 1F479 JAPANESE OGRE
+👺 1F47A JAPANESE GOBLIN
+👻 1F47B GHOST
+```
+
+### Search by Character
+
+```bash
+uchr search -x 👻
+```
+```
+👻 1F47B GHOST
+```
+
+### Search by Unicode Block
+
+```bash
+uchr search -b "Misc_Pictographs"
+```
+
+### Search with Details (CJK Characters)
+
+```bash
+uchr search -d "pray for happiness"
+```
+```
+祝 795D CJK UNIFIED IDEOGRAPH-#; PRAY FOR HAPPINESS OR BLESSINGS
+```
+
+### Output Formatting
+
+```bash
+# Simple format (characters only)
+uchr search ghost -f simple
+👻
+
+# UTF-8 format
+uchr search ghost -f utf8
+👻 F0 9F 91 BB GHOST
+
+# Custom delimiter
+uchr search ghost -D "|"
+👻|1F47B|GHOST
+```
+
+## 🔧 Command Reference
+
+### uchr
+
+Main command with subcommands for all Unicode operations.
+
+#### uchr search
+
+Search Unicode characters with various criteria.
+
+| Option | Short | Description |
+|--------|-------|-------------|
+| `--name` | | Search by character name (default) |
+| `--code` | `-c` | Search by code point or range |
+| `--char` | `-x` | Search by character |
+| `--block` | `-b` | Search by Unicode block |
+| `--detail` | `-d` | Search in character details |
+| `--strict` | `-s` | Exact match (case insensitive) |
+| `--first` | `-1` | Show first result only |
+| `--format` | `-f` | Output format: `utf8`, `simple` |
+| `--delimiter` | `-D` | Custom delimiter (default: space) |
+
+#### uchr db
+
+Database management operations.
+
+| Subcommand | Description |
+|------------|-------------|
+| `uchr db create` | Create/update Unicode database |
+| `uchr db delete` | Remove Unicode database |
+| `uchr db info` | Show database location |
+
+## 💾 Database Management
+
+### Create Database
+```bash
+uchr db create
+```
+
+### Check Database Location
+```bash
+uchr db info
+```
+
+### Remove Database
+```bash
+uchr db delete
+```
+
+### Environment Variables
+
+- `UNICODE_DB_PATH`: Override default database location
+
+```bash
+export UNICODE_DB_PATH="/custom/path/unicode.db"
+uchr db create
+```
+
+## 🌟 Advanced Examples
+
+### Finding Emoji Sequences
+
+```bash
+# National flags
+uchr search -b "RGI_Emoji_Flag_Sequence"
+
+# Family emoji with ZWJ sequences
+uchr search family
+```
+
+### Terminal Display vs. Browser/Application Support
+
+Many terminals don't properly display complex emoji sequences, but the characters work correctly when copied to browsers or applications.
+
+#### National Flag Example
+
+When searching for flags, you might see separate letters in your terminal:
+
+```bash
+uchr search -b "RGI_Emoji_Flag_Sequence" | grep -i norway
+```
+```
+🇳🇴 1F1F3 1F1F4 flag: Norway
+```
+
+![Sample to copy Norway's flag in twitter](img/ucsearch-block-flag-norway.png)
+
+Even though you see two separate letters (🇳🇴) in the terminal, when you copy and paste them into a browser or application like Twitter, they combine to display the Norwegian flag 🇳🇴.
+
+![Sample to paste Norway's flag in twitter](img/twitter-norway.png)
+
+#### ZWJ Sequence Example
+
+The same applies to Zero Width Joiner (ZWJ) sequences. Complex emoji like family groups or professional emoji might not render correctly in terminals:
+
+```bash
+uchr search "polar bear"
+```
+
+In a terminal without proper font support:
+
+![Sample to copy polar bear in twitter](img/ucsearch-polarbear.png)
+
+But when pasted in Twitter or other applications:
+
+![Sample to paste polar bear in twitter](img/twitter-polarbear.png)
+
+> **💡 Tip**: This is expected behavior. The Unicode data is correct, and the characters will work properly in applications that support modern emoji rendering.
+
+### Pipe Operations
+
+```bash
+# Get just the character
+uchr search ghost -f simple
+
+# First match only
+uchr search snow -1
+
+# Custom format for scripting
+uchr search ghost -D "," | cut -d',' -f1
+```
+
+### Complex Searches
+
+```bash
+# CJK characters with specific meanings
+uchr search -d "dragon"
+
+# Characters in multiple blocks
+uchr search -b "Mathematical" | head -10
+```
+
+## 🏗 Data Sources
+
+This tool uses official Unicode 15.0 data:
+
+- [Unicode Character Database](https://www.unicode.org/Public/15.0.0/ucdxml/ucd.all.flat.zip)
+- [Emoji Sequences](https://www.unicode.org/Public/emoji/15.0/emoji-sequences.txt)
+- [Emoji ZWJ Sequences](https://www.unicode.org/Public/emoji/15.0/emoji-zwj-sequences.txt)
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- [Unicode Consortium](https://unicode.org/) for maintaining Unicode standards
+- Contributors and users of this project
+

uchr-0.3.0/README.md

@@ -0,0 +1,284 @@
+# Unicode Tools
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![Unicode](https://img.shields.io/badge/Unicode-15.0-green.svg)](https://unicode.org/)
+
+A powerful command-line tool for searching and exploring Unicode characters, emoji sequences, and character properties.
+
+## 🚀 Features
+
+- **Search by name**: Find characters by their Unicode name
+- **Search by code**: Look up characters by code point or range
+- **Search by character**: Reverse lookup from character to details
+- **Search by block**: Explore characters within Unicode blocks
+- **Emoji support**: Full support for emoji sequences and ZWJ sequences
+- **CJK details**: Enhanced descriptions for CJK characters using kDefinition
+- **Flexible output**: Multiple output formats for different use cases
+
+## 📖 Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Usage Examples](#usage-examples)
+- [Command Reference](#command-reference)
+- [Database Management](#database-management)
+- [Contributing](#contributing)
+- [License](#license)
+
+## 🛠 Installation
+
+### Install from source
+
+```bash
+git clone https://github.com/mkyutani/unicode-tools.git
+cd unicode-tools
+pip install -e .
+```
+
+### Initialize database
+
+Create the Unicode database (required for first use):
+
+```bash
+uchr db create
+```
+
+This downloads Unicode 15.0 data and creates a local SQLite database (~13MB) at:
+- Linux/macOS: `~/.local/share/unicode-tools/unicode.db`
+- Root users: Automatically chooses between system (`/var/lib/unicode-tools/`) or personal location
+
+## ⚡ Quick Start
+
+```bash
+# Search for ghost-related characters
+uchr search ghost
+
+# Find characters in a code range
+uchr search -c 1F47A-1F480
+
+# Search by character
+uchr search -x 👻
+
+# Search within a Unicode block
+uchr search -b "Emoticons"
+```
+
+## 📋 Usage Examples
+
+### Search by Name
+
+```bash
+uchr search goblin
+```
+```
+👺 1F47A JAPANESE GOBLIN
+```
+
+### Search by Code Range
+
+```bash
+uchr search -c 1F479-1F47B
+```
+```
+👹 1F479 JAPANESE OGRE
+👺 1F47A JAPANESE GOBLIN
+👻 1F47B GHOST
+```
+
+### Search by Character
+
+```bash
+uchr search -x 👻
+```
+```
+👻 1F47B GHOST
+```
+
+### Search by Unicode Block
+
+```bash
+uchr search -b "Misc_Pictographs"
+```
+
+### Search with Details (CJK Characters)
+
+```bash
+uchr search -d "pray for happiness"
+```
+```
+祝 795D CJK UNIFIED IDEOGRAPH-#; PRAY FOR HAPPINESS OR BLESSINGS
+```
+
+### Output Formatting
+
+```bash
+# Simple format (characters only)
+uchr search ghost -f simple
+👻
+
+# UTF-8 format
+uchr search ghost -f utf8
+👻 F0 9F 91 BB GHOST
+
+# Custom delimiter
+uchr search ghost -D "|"
+👻|1F47B|GHOST
+```
+
+## 🔧 Command Reference
+
+### uchr
+
+Main command with subcommands for all Unicode operations.
+
+#### uchr search
+
+Search Unicode characters with various criteria.
+
+| Option | Short | Description |
+|--------|-------|-------------|
+| `--name` | | Search by character name (default) |
+| `--code` | `-c` | Search by code point or range |
+| `--char` | `-x` | Search by character |
+| `--block` | `-b` | Search by Unicode block |
+| `--detail` | `-d` | Search in character details |
+| `--strict` | `-s` | Exact match (case insensitive) |
+| `--first` | `-1` | Show first result only |
+| `--format` | `-f` | Output format: `utf8`, `simple` |
+| `--delimiter` | `-D` | Custom delimiter (default: space) |
+
+#### uchr db
+
+Database management operations.
+
+| Subcommand | Description |
+|------------|-------------|
+| `uchr db create` | Create/update Unicode database |
+| `uchr db delete` | Remove Unicode database |
+| `uchr db info` | Show database location |
+
+## 💾 Database Management
+
+### Create Database
+```bash
+uchr db create
+```
+
+### Check Database Location
+```bash
+uchr db info
+```
+
+### Remove Database
+```bash
+uchr db delete
+```
+
+### Environment Variables
+
+- `UNICODE_DB_PATH`: Override default database location
+
+```bash
+export UNICODE_DB_PATH="/custom/path/unicode.db"
+uchr db create
+```
+
+## 🌟 Advanced Examples
+
+### Finding Emoji Sequences
+
+```bash
+# National flags
+uchr search -b "RGI_Emoji_Flag_Sequence"
+
+# Family emoji with ZWJ sequences
+uchr search family
+```
+
+### Terminal Display vs. Browser/Application Support
+
+Many terminals don't properly display complex emoji sequences, but the characters work correctly when copied to browsers or applications.
+
+#### National Flag Example
+
+When searching for flags, you might see separate letters in your terminal:
+
+```bash
+uchr search -b "RGI_Emoji_Flag_Sequence" | grep -i norway
+```
+```
+🇳🇴 1F1F3 1F1F4 flag: Norway
+```
+
+![Sample to copy Norway's flag in twitter](img/ucsearch-block-flag-norway.png)
+
+Even though you see two separate letters (🇳🇴) in the terminal, when you copy and paste them into a browser or application like Twitter, they combine to display the Norwegian flag 🇳🇴.
+
+![Sample to paste Norway's flag in twitter](img/twitter-norway.png)
+
+#### ZWJ Sequence Example
+
+The same applies to Zero Width Joiner (ZWJ) sequences. Complex emoji like family groups or professional emoji might not render correctly in terminals:
+
+```bash
+uchr search "polar bear"
+```
+
+In a terminal without proper font support:
+
+![Sample to copy polar bear in twitter](img/ucsearch-polarbear.png)
+
+But when pasted in Twitter or other applications:
+
+![Sample to paste polar bear in twitter](img/twitter-polarbear.png)
+
+> **💡 Tip**: This is expected behavior. The Unicode data is correct, and the characters will work properly in applications that support modern emoji rendering.
+
+### Pipe Operations
+
+```bash
+# Get just the character
+uchr search ghost -f simple
+
+# First match only
+uchr search snow -1
+
+# Custom format for scripting
+uchr search ghost -D "," | cut -d',' -f1
+```
+
+### Complex Searches
+
+```bash
+# CJK characters with specific meanings
+uchr search -d "dragon"
+
+# Characters in multiple blocks
+uchr search -b "Mathematical" | head -10
+```
+
+## 🏗 Data Sources
+
+This tool uses official Unicode 15.0 data:
+
+- [Unicode Character Database](https://www.unicode.org/Public/15.0.0/ucdxml/ucd.all.flat.zip)
+- [Emoji Sequences](https://www.unicode.org/Public/emoji/15.0/emoji-sequences.txt)
+- [Emoji ZWJ Sequences](https://www.unicode.org/Public/emoji/15.0/emoji-zwj-sequences.txt)
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgments
+
+- [Unicode Consortium](https://unicode.org/) for maintaining Unicode standards
+- Contributors and users of this project

uchr-0.3.0/pyproject.toml

@@ -0,0 +1,53 @@
+[tool.poetry]
+name = "uchr"
+version = "0.3.0"
+description = "Unicode character tools"
+authors = ["Miki Yutani <mkyutani@gmail.com>"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://github.com/mkyutani/unicode-tools"
+repository = "https://github.com/mkyutani/unicode-tools"
+keywords = ["unicode", "character", "tools", "cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Text Processing :: General",
+    "Topic :: Utilities",
+]
+packages = [{include = "unicode_tools", from = "src"}]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+requests = "^2.25.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.0.0"
+black = "^23.0.0"
+ruff = "^0.1.0"
+
+[tool.poetry.scripts]
+uchr = "unicode_tools.uchr:uchr"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+
+[tool.ruff]
+target-version = "py38"
+line-length = 88
+select = ["E", "F", "W", "I", "N", "UP", "B", "A", "C4", "T20"]
+ignore = ["E501"]  # Line too long (handled by black)