hamnosys 0.1.0

A Python library for converting HamNoSys codes to SiGML.

🤟 hamnosys

A lightweight Python library for converting HamNoSys tokens into SiGML XML.

---

✨ Features

• Robust Tokenization: Handles individual hex codes, names, or contiguous raw unicode streams smoothly.
• Fast Dictionary Lookups: In-memory conversion map loaded once for rapid sequence mapping.
• Customizable Glosses: Easily append optional semantic word glosses to the SiGML output.
• Standardized XML: Formats and pretty-prints SiGML suitable for direct avatar rendering.

📦 Installation

Option 1: Install the library to use it

pip install hamnosys

Or install it directly from GitHub:

python -m pip install "git+https://github.com/24-mohamedyehia/hamnosys.git"

🚀 Basic Usage

from hamnosys import HamToSigml

converter = HamToSigml()

ham_code = ""
word = "again"

sigml_result = converter.convert(ham_code, gloss=word)
print(sigml_result)

🤝 Contributing

Contributing to this project is welcome! Please feel free to submit issues or pull requests on GitHub.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙌 Acknowledgements

Special thanks to the Institute of German Sign Language and Communication of the Deaf (IDGS) at the University of Hamburg for developing and releasing the Hamburg Notation System (HamNoSys), which is the foundational phonetic transcription system for sign languages used in this toolkit.