georgian-hyphenation 1.0.1

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 [შენი სახელი]
+
+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.

package/README.md

@@ -0,0 +1,318 @@
+# Georgian Language Hyphenation / ქართული ენის დამარცვლა
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)
+[![JavaScript](https://img.shields.io/badge/javascript-ES6+-yellow.svg)](https://www.ecma-international.org/)
+[![GitHub stars](https://img.shields.io/github/stars/guramzhgamadze/georgian-hyphenation?style=social)](https://github.com/guramzhgamadze/georgian-hyphenation)
+
+A comprehensive hyphenation library for the Georgian language, supporting multiple output formats including TeX, Hunspell, and web standards.
+
+ქართული ენის სრული დამარცვლის ბიბლიოთეკა, რომელიც მხარს უჭერს მრავალ ფორმატს: TeX, Hunspell და ვებ სტანდარტები.
+
+## Features / ფუნქციები
+
+- ✅ **Accurate syllabification** based on Georgian phonological rules
+- ✅ **Multiple output formats**: Soft hyphens (U+00AD), TeX patterns, Hunspell dictionary
+- ✅ **Python and JavaScript implementations** for maximum compatibility
+- ✅ **Web-ready** with HTML/CSS/JS demo
+- ✅ **Export capabilities**: JSON, CSV, TeX, Hunspell
+- ✅ **Well-tested** with comprehensive Georgian word corpus
+
+## Installation / ინსტალაცია
+
+### Python
+```
+# Install from PyPI
+pip install georgian-hyphenation
+
+# Or install from source
+git clone https://github.com/guramzhgamadze/georgian-hyphenation.git
+cd georgian-hyphenation
+pip install -e .
+```
+
+### JavaScript
+```
+npm install georgian-hyphenation  # Coming soon to NPM
+# For now, use directly from source
+```
+## Usage / გამოყენება
+
+### Python
+
+```python
+from georgian_hyphenation import GeorgianHyphenator
+
+# Initialize with soft hyphen (default)
+hyphenator = GeorgianHyphenator()
+
+# Hyphenate a word
+word = "საქართველო"
+result = hyphenator.hyphenate(word)
+print(result)  # სა­ქარ­თვე­ლო (with U+00AD soft hyphens)
+
+# Get syllables as a list
+syllables = hyphenator.getSyllables(word)
+print(syllables)  # ['სა', 'ქარ', 'თვე', 'ლო']
+
+# Use visible hyphens for display
+visible = GeorgianHyphenator('-')
+print(visible.hyphenate(word))  # სა-ქარ-თვე-ლო
+
+# Hyphenate entire text (if you add this method)
+text = "საქართველო არის ლამაზი ქვეყანა"
+words = text.split()
+hyphenated = ' '.join([hyphenator.hyphenate(w) for w in words])
+print(hyphenated)
+```
+
+### JavaScript
+
+```javascript
+// Initialize hyphenator
+const hyphenator = new GeorgianHyphenator();
+
+// Hyphenate a word
+const word = "საქართველო";
+const result = hyphenator.hyphenate(word);
+console.log(result);  // სა­ქარ­თვე­ლო (with U+00AD)
+
+// Get syllables
+const syllables = hyphenator.getSyllables(word);
+console.log(syllables);  // ['სა', 'ქარ', 'თვე', 'ლო']
+
+// Use visible hyphens
+const visible = new GeorgianHyphenator('-');
+console.log(visible.hyphenate(word));  // სა-ქარ-თვე-ლო
+
+// Hyphenate text
+const text = "საქართველო არის ლამაზი ქვეყანა";
+console.log(hyphenator.hyphenateText(text));
+```
+
+### HTML/CSS Integration
+
+```html
+<!DOCTYPE html>
+<html lang="ka">
+<head>
+    <style>
+        .hyphenated {
+            hyphens: manual;
+            text-align: justify;
+        }
+    </style>
+</head>
+<body>
+    <p class="hyphenated" id="text"></p>
+    
+    <script src="georgian-hyphenation.js"></script>
+    <script>
+        const hyphenator = new GeorgianHyphenator('\u00AD');
+        const text = "საქართველო არის ძალიან ლამაზი ქვეყანა";
+        document.getElementById('text').textContent = 
+            hyphenator.hyphenateText(text);
+    </script>
+</body>
+</html>
+```
+
+## Export Formats / ექსპორტის ფორმატები
+
+### TeX Patterns
+
+```python
+from georgian_hyphenation import TeXPatternGenerator
+
+hyphenator = GeorgianHyphenator()
+tex_gen = TeXPatternGenerator(hyphenator)
+
+words = ["საქართველო", "მთავრობა", "დედაქალაქი"]
+tex_gen.generate_patterns_file(words, "hyph-ka.tex")
+```
+
+Output (`hyph-ka.tex`):
+```tex
+% Georgian hyphenation patterns
+\patterns{
+  .სა1ქარ1თვე1ლო
+  .მთავ1რო1ბა
+  .დე1და1ქა1ლა1ქი
+}
+```
+
+### Hunspell Dictionary
+
+```python
+from georgian_hyphenation import HunspellDictionaryGenerator
+
+hunspell_gen = HunspellDictionaryGenerator(hyphenator)
+words = ["საქართველო", "მთავრობა"]
+hunspell_gen.generate_dictionary(words, "hyph_ka_GE")
+```
+
+Output (`hyph_ka_GE.dic`):
+```
+UTF-8
+2
+სა=ქარ=თვე=ლო
+მთავ=რო=ბა
+```
+
+### JSON Export
+
+```python
+from georgian_hyphenation import HyphenationExporter
+
+exporter = HyphenationExporter(hyphenator)
+words = ["საქართველო", "მთავრობა"]
+exporter.export_json(words, "georgian_hyphenation.json")
+```
+
+Output:
+```json
+{
+  "საქართველო": {
+    "syllables": ["სა", "ქარ", "თვე", "ლო"],
+    "hyphenated": "სა­ქარ­თვე­ლო"
+  },
+  "მთავრობა": {
+    "syllables": ["მთავ", "რო", "ბა"],
+    "hyphenated": "მთავ­რო­ბა"
+  }
+}
+```
+
+## Hyphenation Rules / დამარცვლის წესები
+
+The library implements Georgian syllabification rules based on phonological patterns:
+
+ბიბლიოთეკა იყენებს ქართული ფონოლოგიის წესებზე დაფუძნებულ მარცვლების გამოყოფას:
+
+1. **V+C+C+V** → VC|CV (ხმოვანი + თანხმოვანი + თანხმოვნები + ხმოვანი)
+2. **V+C+V+C+V** → VCV|CV
+3. **C+V+C+V** → CV|CV
+4. **V+V+V** → VV|V (სამი ხმოვანი ზედიზედ)
+5. Special rules for word boundaries (სიტყვის საზღვრების სპეციალური წესები)
+
+Where:
+- **V** = vowel (ხმოვანი): ა, ე, ი, ო, უ
+- **C** = consonant (თანხმოვანი): ბ, გ, დ, ვ, ზ, თ, კ, ლ, მ, ნ, პ, ჟ, რ, ს, ტ, ფ, ქ, ღ, ყ, შ, ჩ, ც, ძ, წ, ჭ, ხ, ჯ, ჰ
+
+## Examples / მაგალითები
+
+| Word (სიტყვა) | Syllables (მარცვლები) | Pattern |
+|---------------|----------------------|---------|
+| საქართველო | სა-ქარ-თვე-ლო | .სა1ქარ1თვე1ლო |
+| მთავრობა | მთავ-რო-ბა | .მთავ1რო1ბა |
+| დედაქალაქი | დე-და-ქა-ლა-ქი | .დე1და1ქა1ლა1ქი |
+| ტელევიზორი | ტე-ლე-ვი-ზო-რი | .ტე1ლე1ვი1ზო1რი |
+| კომპიუტერი | კომ-პი-უ-ტე-რი | .კომ1პი1უ1ტე1რი |
+| უნივერსიტეტი | უ-ნი-ვერ-სი-ტე-ტი | .უ1ნი1ვერ1სი1ტე1ტი |
+
+## Testing / ტესტირება
+
+```bash
+# Python tests
+python -m pytest tests/
+
+# JavaScript tests
+npm test
+
+# Run demo
+python georgian_hyphenation.py
+# or open demo.html in browser
+```
+
+## Contributing / წვლილის შეტანა
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+მოხარული ვიქნებით თქვენი წვლილით! გთხოვთ გამოგზავნოთ Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## Integration with Popular Tools / ინტეგრაცია პოპულარულ ხელსაწყოებთან
+
+### LibreOffice / OpenOffice
+
+1. Generate Hunspell dictionary files
+2. Copy to extensions directory:
+   - Linux: `~/.config/libreoffice/4/user/uno_packages/cache/`
+   - Windows: `%APPDATA%\LibreOffice\4\user\uno_packages\cache\`
+   - macOS: `~/Library/Application Support/LibreOffice/4/user/uno_packages/cache/`
+
+### LaTeX / XeLaTeX
+
+```latex
+\documentclass{article}
+\usepackage{polyglossia}
+\setmainlanguage{georgian}
+\usepackage{hyphenat}
+
+% Include generated patterns
+\input{hyph-ka.tex}
+
+\begin{document}
+საქართველო არის ძალიან ლამაზი ქვეყანა
+\end{document}
+```
+
+### Web Browsers (CSS)
+
+```css
+html {
+    lang: ka;
+}
+
+p {
+    hyphens: manual;  /* Use with soft hyphens */
+    /* or */
+    hyphens: auto;    /* If browser supports Georgian */
+    text-align: justify;
+}
+```
+
+## Roadmap / სამომავლო გეგმები
+
+- [ ] PyPI package release
+- [ ] NPM package release
+- [ ] Browser extension (Chrome, Firefox)
+- [ ] InDesign plugin
+- [ ] MS Word add-in
+- [ ] Submit to TeX Live hyphenation database
+- [ ] Submit to Unicode CLDR
+- [ ] Mobile apps (iOS, Android)
+- [ ] API service
+
+## License / ლიცენზია
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments / მადლობა
+
+- Based on Georgian phonological research
+- Inspired by TeX hyphenation patterns
+- Thanks to the Georgian linguistic community
+
+## Contact / კონტაქტი
+
+- GitHub Issues: [Report bugs or request features](https://github.com/guramzhgamadze/georgian-hyphenation/issues)
+- Email: guramzhgamadze@gmail.com
+
+## References / ლიტერატურა
+
+- Georgian Language Phonology and Syllable Structure
+- TeX Hyphenation Algorithm (Liang, 1983)
+- Hunspell Hyphenation Documentation
+- Unicode Standard for Georgian Script
+
+---
+
+Made with ❤️ for the Georgian language community
+
+შექმნილია ❤️-ით ქართული ენის საზოგადოებისთვის

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Georgian Language Hyphenation Library
+ * ქართული ენის დამარცვლის ბიბლიოთეკა
+ */
+
+export class GeorgianHyphenator {
+  /**
+   * Create a Georgian hyphenator
+   * @param hyphenChar - Character to use for hyphenation points (default: U+00AD soft hyphen)
+   */
+  constructor(hyphenChar?: string);
+
+  /**
+   * Hyphenate a Georgian word
+   * @param word - Georgian word to hyphenate
+   * @returns Word with hyphenation points inserted
+   */
+  hyphenate(word: string): string;
+
+  /**
+   * Get syllables for a Georgian word
+   * @param word - Georgian word
+   * @returns Array of syllables
+   */
+  getSyllables(word: string): string[];
+
+  /**
+   * Hyphenate entire text
+   * @param text - Georgian text
+   * @returns Hyphenated text
+   */
+  hyphenateText(text: string): string;
+}
+
+/**
+ * Convert word to TeX pattern format
+ * @param word - Georgian word
+ * @returns TeX pattern
+ */
+export function toTeXPattern(word: string): string;
+
+/**
+ * Convert word to Hunspell format
+ * @param word - Georgian word
+ * @returns Hunspell format
+ */
+export function toHunspellFormat(word: string): string;

package/dist/index.js

@@ -0,0 +1,199 @@
+/**
+ * Georgian Language Hyphenation Library (JavaScript)
+ * ქართული ენის დამარცვლის ბიბლიოთეკა
+ * 
+ * Usage:
+ *   const hyphenator = new GeorgianHyphenator();
+ *   const result = hyphenator.hyphenate("საქართველო");
+ *   // Result: "სა\u00ADქარ\u00ADთვე\u00ADლო"
+ */
+
+class GeorgianHyphenator {
+  /**
+   * Initialize Georgian Hyphenator
+   * @param {string} hyphenChar - Character to use for hyphenation (default: soft hyphen U+00AD)
+   */
+  constructor(hyphenChar = '\u00AD') {
+    this.hyphenChar = hyphenChar;
+    this.C = '[ბგდვზთკლმნპჟრსტფქღყშჩცძწჭხჯჰ]';  // Consonants
+    this.V = '[აეიოუ]';                          // Vowels
+    this.char = '[ა-ჰ]';                         // All Georgian letters
+  }
+
+  /**
+   * Count vowels in a word
+   * @param {string} word - Georgian word
+   * @returns {number} Number of vowels
+   */
+  countVowels(word) {
+    const vowels = 'აეიოუ';
+    let count = 0;
+    for (let v of vowels) {
+      count += (word.match(new RegExp(v, 'g')) || []).length;
+    }
+    return count;
+  }
+
+  /**
+   * Apply hyphenation rules with specified boundary markers
+   * @private
+   */
+  _applyRules(w, softhpn, startchar, endchar) {
+    const C = this.C;
+    const V = this.V;
+    const char = this.char;
+    
+    let t = w;
+    
+    // Rule 1: V+C+C++V → VC|CV
+    t = t.replace(new RegExp(`(${V})(${C})(${C}+)(${V})`, 'gu'), 
+                  `$1$2${softhpn}$3$4`);
+    
+    // Rule 2: V+C+V+C+V → VCV|CV
+    t = t.replace(new RegExp(`(${V})(${C})(${V})(${C})(${V})`, 'gu'), 
+                  `$1$2$3${softhpn}$4$5`);
+    
+    // Rule 3: C+V+C+V → CV|CV
+    t = t.replace(new RegExp(`(${C})(${V})(${C})(${V})`, 'gu'), 
+                  `$1$2${softhpn}$3$4`);
+    
+    // Rule 4: V+V+V → VV|V
+    t = t.replace(new RegExp(`(${V})(${V})(${V})`, 'gu'), 
+                  `$1$2${softhpn}$3`);
+    
+    // Rule 5: Word start - ^VCVCV
+    t = t.replace(new RegExp(`${startchar}(${V})(${C})(${V})(${C})(${V})`, 'gu'), 
+                  `$1$2$3${softhpn}$4$5`);
+    
+    // Rule 6: Word start - ^VCVCchar
+    t = t.replace(new RegExp(`${startchar}(${V})(${C})(${V})(${C})(${char})`, 'gu'), 
+                  `$1$2$3${softhpn}$4$5`);
+    
+    // Rule 7: Word start - ^C++CVCV
+    t = t.replace(new RegExp(`${startchar}(${C}+)(${V})(${C})(${V})`, 'gu'), 
+                  `$1$2${softhpn}$3$4`);
+    
+    // Rule 8: Word start - ^C++VVchar
+    t = t.replace(new RegExp(`${startchar}(${C}+)(${V})(${V})(${char})`, 'gu'), 
+                  `$1$2${softhpn}$3$4`);
+    
+    // Rule 9: Word end - charVVC++$
+    t = t.replace(new RegExp(`(${char})(${V})(${V})(${C}+)${endchar}`, 'gu'), 
+                  `$1$2${softhpn}$3$4`);
+    
+    // Rule 10: Word end - charVCV$
+    t = t.replace(new RegExp(`(${char})(${V})(${C})(${V})${endchar}`, 'gu'), 
+                  `$1$2${softhpn}$3$4`);
+    
+    // Rule 11: Word end - VCC++VC++$
+    t = t.replace(new RegExp(`(${V})(${C})(${C}+)(${V})(${C}+)${endchar}`, 'gu'), 
+                  `$1$2${softhpn}$3$4$5`);
+    
+    // Rule 12: Word end - charVCVC++$
+    t = t.replace(new RegExp(`(${char})(${V})(${C})(${V}+)(${C}+)${endchar}`, 'gu'), 
+                  `$1$2${softhpn}$3$4$5`);
+    
+    return t;
+  }
+
+  /**
+   * Hyphenate a single Georgian word
+   * @param {string} word - Georgian word to hyphenate
+   * @returns {string} Word with hyphenation points
+   */
+  hyphenate(word) {
+    // Don't hyphenate words with 0-1 vowels
+    if (this.countVowels(word) <= 1) {
+      return word;
+    }
+
+    const softhpn = this.hyphenChar;
+    
+    // Apply hyphenation rules with different boundary markers
+    let result = this._applyRules(word, softhpn, '^', '$');
+    result = this._applyRules(result, softhpn, '^', this._escapeRegex(softhpn));
+    result = this._applyRules(result, this._escapeRegex(softhpn), '$');
+    result = this._applyRules(result, this._escapeRegex(softhpn), this._escapeRegex(softhpn));
+    
+    // Remove duplicate hyphens
+    const escapedHyphen = this._escapeRegex(softhpn);
+    result = result.replace(new RegExp(`${escapedHyphen}+`, 'gu'), softhpn);
+    
+    return result;
+  }
+
+  /**
+   * Get array of syllables for a word
+   * @param {string} word - Georgian word
+   * @returns {string[]} Array of syllables
+   */
+  getSyllables(word) {
+    const hyphenated = this.hyphenate(word);
+    return hyphenated.split(this.hyphenChar);
+  }
+
+  /**
+   * Hyphenate entire text
+   * @param {string} text - Georgian text
+   * @returns {string} Hyphenated text
+   */
+  hyphenateText(text) {
+    const words = text.split(' ');
+    const hyphenatedWords = words.map(w => this.hyphenate(w));
+    return hyphenatedWords.join(' ');
+  }
+
+  /**
+   * Escape special regex characters
+   * @private
+   */
+  _escapeRegex(str) {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+  }
+}
+
+/**
+ * Convert word to TeX pattern format
+ * @param {string} word - Georgian word
+ * @returns {string} TeX pattern
+ */
+function toTeXPattern(word) {
+  const hyphenator = new GeorgianHyphenator();
+  const syllables = hyphenator.getSyllables(word);
+  if (syllables.length <= 1) {
+    return `.${word}`;
+  }
+  return '.' + syllables.join('1');
+}
+
+/**
+ * Convert word to Hunspell format
+ * @param {string} word - Georgian word
+ * @returns {string} Hunspell format
+ */
+function toHunspellFormat(word) {
+  const hyphenator = new GeorgianHyphenator();
+  const syllables = hyphenator.getSyllables(word);
+  return syllables.join('=');
+}
+
+// Export for use in Node.js or browser
+if (typeof module !== 'undefined' && module.exports) {
+  module.exports = {
+    GeorgianHyphenator,
+    toTeXPattern,
+    toHunspellFormat
+  };
+}
+
+// Demo usage
+if (typeof window !== 'undefined') {
+  window.GeorgianHyphenator = GeorgianHyphenator;
+  window.toTeXPattern = toTeXPattern;
+  window.toHunspellFormat = toHunspellFormat;
+}
+
+// Example usage:
+// const hyphenator = new GeorgianHyphenator('-'); // visible hyphens
+// console.log(hyphenator.hyphenate("საქართველო")); // "სა-ქარ-თვე-ლო"
+// console.log(hyphenator.getSyllables("საქართველო")); // ["სა", "ქარ", "თვე", "ლო"]

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "georgian-hyphenation",
+  "version": "1.0.1",
+  "description": "Georgian Language Hyphenation Library - ქართული ენის დამარცვლის ბიბლიოთეკა",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "node build.js",
+    "test": "node test.js",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/guramzhgamadze/georgian-hyphenation.git"
+  },
+  "keywords": [
+    "georgian",
+    "kartuli",
+    "ქართული",
+    "hyphenation",
+    "syllabification",
+    "nlp",
+    "natural-language-processing",
+    "linguistics",
+    "text-processing",
+    "i18n",
+    "localization"
+  ],
+  "author": "Guram Zhgamadze <guramzhgamadze@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/guramzhgamadze/georgian-hyphenation/issues"
+  },
+  "homepage": "https://github.com/guramzhgamadze/georgian-hyphenation#readme"
+}