allows installing as python library with pip

clarinsi · Aug 5, 2023 · 16863c5 · 16863c5
1 parent d3fbaae
commit 16863c5
Show file tree

Hide file tree

Showing 17 changed files with 51 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+slovene_g2p.egg-info
+build
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+recursive-include slovene_g2p/resources/ *
diff --git a/README.md b/README.md
@@ -1,2 +1,16 @@
 # slovene_g2p
 A converter that converts Slovene words to their IPA and/or SAMPA transcriptions.
+
+## installation
+
+pip install .
+
+## usage
+
+```
+from slovene_g2p import SloveneG2P
+g2p = SloveneG2P()
+g2p.convert_to_phonetic_transcription(word="govoriti", msd_sl="Ggdd-em", morphological_pattern_code="G1.2.d")
+```
+
+both msd_sl and morphological_pattern_code are available in sloleks 3.0 and provided by classla python package
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,3 @@
+nltk>=3.6.7
+classla>=1.1.0
+reldi-tokeniser>=1.0.1
diff --git a/setup.py b/setup.py
@@ -0,0 +1,11 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='slovene_g2p',
+    version='0.1',
+    packages=find_packages(),
+    install_requires=[
+        # Add any required external dependencies here
+    ],
+    include_package_data=True,
+)
diff --git a/slovene_g2p.egg-info/PKG-INFO b/slovene_g2p.egg-info/PKG-INFO
@@ -0,0 +1,4 @@
+Metadata-Version: 2.1
+Name: slovene-g2p
+Version: 0.1
+License-File: LICENSE
diff --git a/slovene_g2p.egg-info/SOURCES.txt b/slovene_g2p.egg-info/SOURCES.txt
@@ -0,0 +1,14 @@
+LICENSE
+MANIFEST.in
+README.md
+setup.py
+slovene_g2p.egg-info/PKG-INFO
+slovene_g2p.egg-info/SOURCES.txt
+slovene_g2p.egg-info/dependency_links.txt
+slovene_g2p.egg-info/top_level.txt
+slovene_g2p/resources/SloveneG2P_phoneme_set.json
+slovene_g2p/resources/schwa_rules.tsv
+slovene_g2p/resources/table_of_consonant_phonemes.tsv
+slovene_g2p/resources/table_of_obstruent_conversions.tsv
+slovene_g2p/resources/table_of_other_symbols.tsv
+slovene_g2p/resources/table_of_vowel_phonemes.tsv
diff --git a/slovene_g2p.egg-info/dependency_links.txt b/slovene_g2p.egg-info/dependency_links.txt
@@ -0,0 +1 @@
+
diff --git a/slovene_g2p.egg-info/top_level.txt b/slovene_g2p.egg-info/top_level.txt
@@ -0,0 +1 @@
+
diff --git a/SloveneG2P.py → slovene_g2p/SloveneG2P.py b/SloveneG2P.py → slovene_g2p/SloveneG2P.py
diff --git a/slovene_g2p/__init__.py b/slovene_g2p/__init__.py
diff --git a/resources/SloveneG2P_phoneme_set.json → ...g2p/resources/SloveneG2P_phoneme_set.json b/resources/SloveneG2P_phoneme_set.json → ...g2p/resources/SloveneG2P_phoneme_set.json
diff --git a/resources/schwa_rules.tsv → slovene_g2p/resources/schwa_rules.tsv b/resources/schwa_rules.tsv → slovene_g2p/resources/schwa_rules.tsv
diff --git a/resources/table_of_consonant_phonemes.tsv → ...resources/table_of_consonant_phonemes.tsv b/resources/table_of_consonant_phonemes.tsv → ...resources/table_of_consonant_phonemes.tsv
diff --git a/resources/table_of_obstruent_conversions.tsv → ...ources/table_of_obstruent_conversions.tsv b/resources/table_of_obstruent_conversions.tsv → ...ources/table_of_obstruent_conversions.tsv
diff --git a/resources/table_of_other_symbols.tsv → ..._g2p/resources/table_of_other_symbols.tsv b/resources/table_of_other_symbols.tsv → ..._g2p/resources/table_of_other_symbols.tsv
diff --git a/resources/table_of_vowel_phonemes.tsv → ...g2p/resources/table_of_vowel_phonemes.tsv b/resources/table_of_vowel_phonemes.tsv → ...g2p/resources/table_of_vowel_phonemes.tsv