Metadata-Version: 2.4
Name: jchars
Version: 0.1.0
Summary: Japanese character utilities
Author-email: Mario Moratilla <mariomoratilla@gmail.com>
License: Copyright 2026 Mario Moratilla
        
        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.
        
Project-URL: Homepage, https://github.com/mariomoratilla/jchars
Keywords: japanese,kanji,hiragana,katakana,characters,jouyou,joyo,jinmeiyou,jinmeiyo,hyougaiji,hyogaiji
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Dynamic: license-file

# jchars

jchars is a Python library for working with Japanese characters.
Its main purpose is to automatically match each character in a kanji word to its reading.
All available functions are explained in detail in the documentation.


## Documentation

Full documentation: https://mariomoratilla.github.io/jchars/


## Installation

From PyPI:
```bash
pip install jchars
```

From GitHub:
```bash
git clone https://github.com/mariomoratilla/jchars.git
cd jchars
pip install -e .
```


## Usage

```python
import jchars

jchars.match_kanji_to_hiragana("食べ物", "たべもの")
# Example output:
# (True, '', [['食', 'た'], ['べ', 'べ'], ['物', 'もの']])
```


## Author

Mario Moratilla
mariomoratilla@gmail.com


## License

This project is licensed under the MIT License - see the LICENSE file for details


## Version History

* 0.1.0
    * Initial Release
