Merge pull request #19 from timmahrt/pysle_4.0.1

Pysle 4.0.1
timmahrt · Jul 15, 2023 · 4c50bed · 4c50bed
2 parents 8ebb702 + 121f5a8
commit 4c50bed
Show file tree

Hide file tree

Showing 25 changed files with 6,627 additions and 6,970 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,9 @@
 
 *Pysle uses semantic versioning (Major.Minor.Patch)*
 
+Ver 4.0.1 (July 15, 2023)
+- pin praatio version to 6.0
+
 Ver 4.0 (Jan 3, 2022)
 - lazy load the isleDict; boot up time changed from ~20s to ~0.5s
 - refactor code to be object-oriented

diff --git a/DEVELOP.md b/DEVELOP.md
@@ -0,0 +1,28 @@
+
+These are development notes for myself
+
+## Documentation
+
+Documentation is generated with the following command:
+`pdoc pysle -d google -o docs`
+
+A live version can be seen with
+`pdoc pysle -d google`
+
+pdoc will read from pysle, as installed on the computer, so you may need to run `pip install .` if you want to generate documentation from a locally edited version of pysle.
+
+## Tests
+
+Tests are run with
+
+`pytest --cov=pysle tests/`
+
+## Release
+
+Releases are built and deployed with:
+
+`python setup.py bdist_wheel sdist`
+
+`twine upload dist/*`
+
+Don't forget to tag the release.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ canonical dictionary pronunciation).
 4. [Requirements](#requirements)
 5. [ISLE Dictionary](#isle-dictionary)
 6. [Installation](#installation)
-7. [Version 3 to 4 Migration](#version-3-to-4-migration)
+7. [Upgrading](#upgrading)
 8. [Usage](#usage)
 9. [Common Use Cases](#common-use-cases)
 10. [Tests](#tests)
@@ -37,9 +37,6 @@ Automatically generated pdocs can be found here:
 
 http://timmahrt.github.io/pysle/
 
-The documentation is generated with the following command:
-`pdoc ./pysle -d google -o docs`
-
 ## Tutorials
 
 There are tutorials available for learning how to use Pysle.  These
@@ -102,16 +99,9 @@ If python is not in your path, you'll need to enter the full path e.g.
 
     C:\Python36\python.exe setup.py install
 
-## Version 3 to 4 Migration
-
-The iterface to isle dictionaries, praattools, and pronunciationtools haven't changed so
-much except for a bit of renaming.
+## Upgrading
 
-The expected return types have completely changed however--shifting to datatypes now defined
-in `phonetics.py`. If you are struggling with migrating to version 4, please let me know.
-
-Looking over changes to the example files may help show the changes that need to be made
-to get the same results.
+Please view [UPGRADING.md](https://github.com/timmahrt/pysle/blob/main/UPGRADING.md) for detailed information about how to upgrade from earlier versions.
 
 ## Usage
 
@@ -167,13 +157,6 @@ What can you do with this library?
     pysle.syllabifyTextgrid(isleDict, praatioTextgrid, "words", "phones")
     ```
 
-## Tests
-
-I run tests with the following command (this requires pytest and pytest-cov to be installed):
-
-`pytest --cov=pysle tests/`
-
-
 ## Citing pysle
 
 

diff --git a/UPGRADING.md b/UPGRADING.md
@@ -0,0 +1,20 @@
+
+This guide outlines steps to upgrading between versions.
+
+For more information about the most recent version of Pysle, please see the documentation linked in the README file.
+
+If you are having difficulty upgrading, please don't hesistate to open an issue or contact me.
+
+# Table of contents
+1. [Version 3 to 4](#version-3-to-4-migration)
+
+## Version 3 to 4 Migration
+
+The iterface to isle dictionaries, praattools, and pronunciationtools haven't changed so
+much except for a bit of renaming.
+
+The expected return types have completely changed however--shifting to datatypes now defined
+in `phonetics.py`.
+
+Looking over changes to the example files may help show the changes that need to be made
+to get the same results.
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/pysle.html b/docs/pysle.html
diff --git a/docs/pysle/isletool.html b/docs/pysle/isletool.html
diff --git a/docs/pysle/phonetics.html b/docs/pysle/phonetics.html
diff --git a/docs/pysle/praattools.html b/docs/pysle/praattools.html
diff --git a/docs/pysle/pronunciationtools.html b/docs/pysle/pronunciationtools.html
diff --git a/docs/pysle/utilities.html b/docs/pysle/utilities.html
diff --git a/docs/pysle/utilities/constants.html b/docs/pysle/utilities/constants.html
diff --git a/docs/pysle/utilities/errors.html b/docs/pysle/utilities/errors.html
diff --git a/docs/pysle/utilities/isle_io.html b/docs/pysle/utilities/isle_io.html
diff --git a/docs/pysle/utilities/phonetic_constants.html b/docs/pysle/utilities/phonetic_constants.html
diff --git a/docs/pysle/utilities/search.html b/docs/pysle/utilities/search.html
diff --git a/docs/pysle/utilities/utils.html b/docs/pysle/utilities/utils.html
diff --git a/docs/search.js b/docs/search.js
diff --git a/examples/syllabify_textgrid.py b/examples/syllabify_textgrid.py
@@ -29,9 +29,9 @@
     stressDetectionErrorMode="warning",
     syllabificationErrorMode="warning",
 )
-tg.addTier(syllableTG.tierDict["syllable"])
-tg.addTier(syllableTG.tierDict["tonicSyllable"])
-tg.addTier(syllableTG.tierDict["tonicVowel"])
+tg.addTier(syllableTG.getTier("syllable"))
+tg.addTier(syllableTG.getTier("tonicSyllable"))
+tg.addTier(syllableTG.getTier("tonicVowel"))
 
 tg.save(
     join(root, "pumpkins_with_syllables.TextGrid"),

diff --git a/examples/textgrid_alignment_example.py b/examples/textgrid_alignment_example.py
@@ -38,7 +38,7 @@
 
 tg = textgrid.openTextgrid(inputFN, includeEmptyIntervals=False)
 
-for tierName in tg.tierNameList[:]:
+for tierName in tg.tierNames[:]:
     if tierName == utteranceTierName:
         continue
     tg.removeTier(tierName)

diff --git a/pysle/isletool.py b/pysle/isletool.py
@@ -126,8 +126,8 @@ def getLength(self, word: str, maxFlag: bool) -> Tuple[float, float]:
         syllableCountList = []
         phoneCountList = []
 
-        entryList = self.lookup(word)
-        for entry in entryList:
+        entries = self.lookup(word)
+        for entry in entries:
             syllableList = []
             phoneList = []
             for syllabification in entry.syllabificationList:
@@ -253,11 +253,11 @@ def transcribe(
         transcribedWordsList: List[phonetics.PhonemeList] = []
         wordList = sentenceTxt.split(" ")
         for word in wordList:
-            entryList = self.lookup(word)
+            entries = self.lookup(word)
 
             phoneListsOrderedByEntry = [
                 syllabification.desyllabify()
-                for entry in entryList
+                for entry in entries
                 for syllabification in entry.syllabificationList
             ]
             numPhones = [len(phoneList) for phoneList in phoneListsOrderedByEntry]
@@ -271,8 +271,8 @@ def transcribe(
             transcribedWordsList.append(phoneListsOrderedByEntry[i])
 
         def cleanPron(pron):
-            for val in [u"ˈ", u"ˌ", u" "]:
-                pron = pron.replace(val, u"")
+            for val in ["ˈ", "ˌ", " "]:
+                pron = pron.replace(val, "")
             return pron
 
         words: List[str] = [