koreanwritingsystem 1.0.0__tar.gz

koreanwritingsystem-1.0.0/LICENSE

@@ -0,0 +1,9 @@
+Korean Writing System — CC0 1.0 Universal
+
+This software is released under the Creative Commons Zero v1.0 Universal (CC0 1.0) license.
+
+To the extent possible under law, the author has waived all copyright and related or neighboring rights to this work.
+You may copy, modify, distribute, and use this software for any purpose, including commercial purposes, without asking permission.
+
+Full legal text:
+https://creativecommons.org/publicdomain/zero/1.0/

koreanwritingsystem-1.0.0/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: koreanwritingsystem
+Version: 1.0.0
+Summary: Decompose Hangul into Jamo. Compose Jamo into Hangul or compose Jamo indexes into Hangul.
+Author: Nagao Yuji
+License: CC0-1.0
+Project-URL: homepage, https://github.com/DukaCrazy/koreanwritingsystem
+Project-URL: repository, https://github.com/DukaCrazy/koreanwritingsystem
+Keywords: hangul,korean,jamo,compose hangul,decompose jamo
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Korean Writing System
+The modern Korean writing system is remarkably logical, consistent, and well‑designed.
+This module implements the fundamental structure of Hangul: decomposing syllables into jamo and composing jamo back into syllables.
+
+Special thanks to **Joe Becker, Lee Collins, Mark Davis, and the teams** who created and maintain Unicode.
+
+Developed by **N. Y**.  
+This code was created with support from **Microsoft Copilot**.
+Reviewed by **N. Y**.
+
+Compatible with Python **≥ 3.0**
+Distributed under the **CC0‑1.0** license
+
+Main functions:
+
+Decompose Hangul into Jamo
+Compose Jamo into Hangul
+Compose Jamo indexes into Hangul
+
+```python
+# In: Hangul >>> Out: [CHOSEONG, JUNGSEONG, JONGSEONG]
+print(KoreanWritingSystem.decompose_hangul_to_jamo('가'))
+#In: [CHOSEONG, JUNGSEONG, JONGSEONG] >>> Out: Hangul
+print(KoreanWritingSystem.compose_hangul_with_jamo('ㄱ','ㅏ',''))
+#In: [i, j, k] >>> Out: Hangul
+print(KoreanWritingSystem.compose_hangul_with_number(0,0,0))
+```

koreanwritingsystem-1.0.0/README.md

@@ -0,0 +1,27 @@
+# Korean Writing System
+The modern Korean writing system is remarkably logical, consistent, and well‑designed.
+This module implements the fundamental structure of Hangul: decomposing syllables into jamo and composing jamo back into syllables.
+
+Special thanks to **Joe Becker, Lee Collins, Mark Davis, and the teams** who created and maintain Unicode.
+
+Developed by **N. Y**.  
+This code was created with support from **Microsoft Copilot**.
+Reviewed by **N. Y**.
+
+Compatible with Python **≥ 3.0**
+Distributed under the **CC0‑1.0** license
+
+Main functions:
+
+Decompose Hangul into Jamo
+Compose Jamo into Hangul
+Compose Jamo indexes into Hangul
+
+```python
+# In: Hangul >>> Out: [CHOSEONG, JUNGSEONG, JONGSEONG]
+print(KoreanWritingSystem.decompose_hangul_to_jamo('가'))
+#In: [CHOSEONG, JUNGSEONG, JONGSEONG] >>> Out: Hangul
+print(KoreanWritingSystem.compose_hangul_with_jamo('ㄱ','ㅏ',''))
+#In: [i, j, k] >>> Out: Hangul
+print(KoreanWritingSystem.compose_hangul_with_number(0,0,0))
+```

koreanwritingsystem-1.0.0/koreanwritingsystem/__init__.py

@@ -0,0 +1,82 @@
+# ---------------------------------------------------------
+#Tuple
+# CHOSEONG -> 0-18 -> LEADING_CONSONANT
+# JUNGSEONG -> 0-20 -> VOWEL
+# JONGSEONG -> 0-27 -> TRAILING_CONSONANT
+
+# JAMO = CHOSEONG, JUNGSEONG and JONGSEONG
+
+# ---------------------------------------------------------
+class KoreanWritingSystem:
+    # LEADING_CONSONANT
+    CHOSEONG = (
+        "ㄱ","ㄲ","ㄴ","ㄷ","ㄸ","ㄹ","ㅁ","ㅂ","ㅃ","ㅅ",
+        "ㅆ","ㅇ","ㅈ","ㅉ","ㅊ","ㅋ","ㅌ","ㅍ","ㅎ"
+    )
+    # VOWEL
+    JUNGSEONG = (
+        "ㅏ","ㅐ","ㅑ","ㅒ","ㅓ","ㅔ","ㅕ","ㅖ","ㅗ","ㅘ",
+        "ㅙ","ㅚ","ㅛ","ㅜ","ㅝ","ㅞ","ㅟ","ㅠ","ㅡ","ㅢ","ㅣ"
+    )
+    # TRAILING_CONSONANT
+    JONGSEONG = (
+        "", "ㄱ","ㄲ","ㄳ","ㄴ","ㄵ","ㄶ","ㄷ","ㄹ","ㄺ",
+        "ㄻ","ㄼ","ㄽ","ㄾ","ㄿ","ㅀ","ㅁ","ㅂ","ㅄ","ㅅ",
+        "ㅆ","ㅇ","ㅈ","ㅊ","ㅋ","ㅌ","ㅍ","ㅎ"
+    )
+
+    UNICODE_START_POSITION = 0xAC00
+    N_LEADING_CONSONANT = 19   # choseong
+    N_VOWEL = 21   # jungseong
+    N_TRAILING_CONSONANT = 28   # jongseong 
+
+    JAMO = set(CHOSEONG) | set(JUNGSEONG) | set(JONGSEONG)
+
+    def decompose_hangul_to_jamo(hangul_or_jamo: str):
+        """
+        Decomposes:
+        - Hangul syllables (AC00–D7A3) → (initial, vowel, final)
+        - isolated jamos (1100–11FF) → returns the jamo itself
+        - anything else → That's not an accepted character. This method only works with Hangul and Jamo.
+        """
+
+        characters_position = ord(hangul_or_jamo)
+        
+        # 1. Hangul >>> 11.172 possibilities
+        if 0xAC00 <= characters_position <= 0xD7A3:
+            S = characters_position - 0xAC00
+            lc = S // 588
+            v = (S % 588) // 28
+            tc = S % 28
+            return [KoreanWritingSystem.CHOSEONG[lc], KoreanWritingSystem.JUNGSEONG[v], KoreanWritingSystem.JONGSEONG[tc]]
+
+        # 2. Jamos >>> 78 possibilities
+        if hangul_or_jamo in KoreanWritingSystem.JAMO:
+            return [hangul_or_jamo]
+
+        # Other
+        return "That's not an accepted character. This method only works with Hangul and Jamo."
+
+
+    def compose_hangul_with_number(leading_consonant: int, vowel:int, trailing_consonant:int):
+        """
+        Recomposes a Hangul syllable using the leading_consonant, vowel, trailing_consonant indexes.
+        leading_consonant = 0–18
+        vowel = 0–20
+        trailing_consonant = 0–27
+        """
+        codepoint = KoreanWritingSystem.UNICODE_START_POSITION + (leading_consonant * KoreanWritingSystem.N_VOWEL * KoreanWritingSystem.N_TRAILING_CONSONANT) + (vowel * KoreanWritingSystem.N_TRAILING_CONSONANT) + trailing_consonant
+        return chr(codepoint)
+
+    def compose_hangul_with_jamo(leading_consonant: str, vowel:str, trailing_consonant:str):
+        """
+        leading_consonant >>> "ㄱ","ㄲ","ㄴ","ㄷ","ㄸ","ㄹ","ㅁ","ㅂ","ㅃ","ㅅ","ㅆ","ㅇ","ㅈ","ㅉ","ㅊ","ㅋ","ㅌ","ㅍ","ㅎ"
+        vowel >>> "ㅏ","ㅐ","ㅑ","ㅒ","ㅓ","ㅔ","ㅕ","ㅖ","ㅗ","ㅘ","ㅙ","ㅚ","ㅛ","ㅜ","ㅝ","ㅞ","ㅟ","ㅠ","ㅡ","ㅢ","ㅣ"
+        trailing_consonant >>> "", "ㄱ","ㄲ","ㄳ","ㄴ","ㄵ","ㄶ","ㄷ","ㄹ","ㄺ","ㄻ","ㄼ","ㄽ","ㄾ","ㄿ","ㅀ","ㅁ","ㅂ","ㅄ","ㅅ","ㅆ","ㅇ","ㅈ","ㅊ","ㅋ","ㅌ","ㅍ","ㅎ"
+        """
+        if leading_consonant in KoreanWritingSystem.JAMO and vowel in KoreanWritingSystem.JAMO and trailing_consonant in KoreanWritingSystem.JAMO:
+            codepoint = KoreanWritingSystem.UNICODE_START_POSITION + (KoreanWritingSystem.CHOSEONG.index(leading_consonant) * KoreanWritingSystem.N_VOWEL * KoreanWritingSystem.N_TRAILING_CONSONANT) + (KoreanWritingSystem.JUNGSEONG.index(vowel) * KoreanWritingSystem.N_TRAILING_CONSONANT) + KoreanWritingSystem.JONGSEONG.index(trailing_consonant)
+            return chr(codepoint)
+
+        # Other
+        return "That's not an accepted character. This method only works with Jamo."

koreanwritingsystem-1.0.0/koreanwritingsystem.egg-info/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: koreanwritingsystem
+Version: 1.0.0
+Summary: Decompose Hangul into Jamo. Compose Jamo into Hangul or compose Jamo indexes into Hangul.
+Author: Nagao Yuji
+License: CC0-1.0
+Project-URL: homepage, https://github.com/DukaCrazy/koreanwritingsystem
+Project-URL: repository, https://github.com/DukaCrazy/koreanwritingsystem
+Keywords: hangul,korean,jamo,compose hangul,decompose jamo
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Korean Writing System
+The modern Korean writing system is remarkably logical, consistent, and well‑designed.
+This module implements the fundamental structure of Hangul: decomposing syllables into jamo and composing jamo back into syllables.
+
+Special thanks to **Joe Becker, Lee Collins, Mark Davis, and the teams** who created and maintain Unicode.
+
+Developed by **N. Y**.  
+This code was created with support from **Microsoft Copilot**.
+Reviewed by **N. Y**.
+
+Compatible with Python **≥ 3.0**
+Distributed under the **CC0‑1.0** license
+
+Main functions:
+
+Decompose Hangul into Jamo
+Compose Jamo into Hangul
+Compose Jamo indexes into Hangul
+
+```python
+# In: Hangul >>> Out: [CHOSEONG, JUNGSEONG, JONGSEONG]
+print(KoreanWritingSystem.decompose_hangul_to_jamo('가'))
+#In: [CHOSEONG, JUNGSEONG, JONGSEONG] >>> Out: Hangul
+print(KoreanWritingSystem.compose_hangul_with_jamo('ㄱ','ㅏ',''))
+#In: [i, j, k] >>> Out: Hangul
+print(KoreanWritingSystem.compose_hangul_with_number(0,0,0))
+```

koreanwritingsystem-1.0.0/koreanwritingsystem.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+LICENSE
+README.md
+pyproject.toml
+koreanwritingsystem/__init__.py
+koreanwritingsystem.egg-info/PKG-INFO
+koreanwritingsystem.egg-info/SOURCES.txt
+koreanwritingsystem.egg-info/dependency_links.txt
+koreanwritingsystem.egg-info/top_level.txt

koreanwritingsystem-1.0.0/koreanwritingsystem.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

koreanwritingsystem-1.0.0/koreanwritingsystem.egg-info/top_level.txt

@@ -0,0 +1 @@
+koreanwritingsystem

koreanwritingsystem-1.0.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "koreanwritingsystem"
+version = "1.0.0"
+description = "Decompose Hangul into Jamo. Compose Jamo into Hangul or compose Jamo indexes into Hangul."
+authors = [
+    { name = "Nagao Yuji" }
+]
+
+requires-python = ">=3.0"
+
+keywords = [
+    "hangul",
+    "korean",
+    "jamo",
+    "compose hangul",
+    "decompose jamo"
+]
+
+readme = "README.md"
+license = { text = "CC0-1.0" }
+
+[project.urls]
+homepage = "https://github.com/DukaCrazy/koreanwritingsystem"
+repository = "https://github.com/DukaCrazy/koreanwritingsystem"

koreanwritingsystem-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+