Support Python 3 by chrisbrickhouse · Pull Request #49 · JoFrhwld/FAVE

chrisbrickhouse · 2020-05-17T20:10:34Z

Python 2.7 has been retired in favor of Python 3. This pull request implements FAVE in Python 3 along with a number of improvements to code style and code documentation.

Modularization
- FAAValign and FAAVextract have been moved to modules fave.align and fave.extract respectively
- The shared dependencies of praat.py and cmu(dictionary).py have been merged and moved to the root module directory as fave.praat and fave.cmudictionary respectively
- Praat scripts have been moved to their own directory fave/praatScripts
- fave.extract configuration files have been moved to the fave/extract/config directory
- Wherever I noticed, references to package resources like praat scripts, config files, and default dictionaries have been replaced with pkg_resources which is a system and implementation independent way of accessing these files
- fave.align has cross-module logging using the standard logging library allowing users to specify verbosity in a more fine-grained manner
- Because of the above, end users must run python -m pip install -e /path/to/FAVE/directory or python -m pip install /path/to/fave/wheel/file so that the modules can work together appropriately
Packaging
- The repository is set up as a standard PyPI package including automated package building and dependency management using poetry
- Python package distributions in tar.gz and .whl are included and may be installed by end users with python -m pip install fave-2.0.0.dev0-py3-none-any.whl
- An eventual goal is to distribute these via the Python Package Index so end users can run pip install fave from any machine
Documentation
- Code documentation is automatically generated using Sphinx An example can be seen at https://chrisbrickhouse.github.io/FAVE
- Commits to master automatically build documentation and publish it to github pages.

The FAAValign.py script has been broken up into three files each covering different aspects of the program. The file cmudictionary.py handles operations related to the dictionary. The file transcriptprocessor.py handles the processing of the input tsv file. The main module, aligner.py, handles the aspects related to force alignment and serves as a wrapper for interfacing with the previous two modules. In the process of modularizing the code, it has been rewritten to run under Python3 since Python2 is no longer supported. The new modules have been linted to comply with PEP standards, and the linter configuration is included as .pylintrc in the root directory.

Set up auto documentation of code based on method docstrings and introspection. Still needs the user-facing documentation created, and the code's actual documentation needs to be improved.

Sets up Continuous Integration for building documentation on push.

The FAAValign.py script has been broken up into three files each covering different aspects of the program. The file cmudictionary.py handles operations related to the dictionary. The file transcriptprocessor.py handles the processing of the input tsv file. The main module, aligner.py, handles the aspects related to force alignment and serves as a wrapper for interfacing with the previous two modules. In the process of modularizing the code, it has been rewritten to run under Python3 since Python2 is no longer supported. The new modules have been linted to comply with PEP standards, and the linter configuration is included as .pylintrc in the root directory.

Set up auto documentation of code based on method docstrings and introspection. Still needs the user-facing documentation created, and the code's actual documentation needs to be improved.

…documentation

FAVE has been modularized into fave.extract and fave.align, and the common dependencies, praat.py and cmu(dictionary).py have been merged and placed in the main fave module. The python files have been updated to work with python 3, and the wrapper scripts for end users have been updated to use these new modules with minimal changes to the interface. Squashed commit of the following: commit 8d8d9c1c084c790624bca26a35ddc8ee0def4121 Author: Christian <ctb77@stanford.edu> Date: Sun May 17 12:25:37 2020 -0700 Update documentation and minor fixes commit fa563c3a035fd863e7de53d5150536729bd189c2 Merge: 00373bd bd35b29 Author: Christian <ctb77@stanford.edu> Date: Sun May 17 11:38:31 2020 -0700 Merge branch 'modular' into documentation commit bd35b29b7cd663dac1aca876031aa66de4fc1cc0 Author: Christian <ctb77@stanford.edu> Date: Sun May 17 01:31:46 2020 -0700 Get FAAVextract.py script working commit 41c49ee Author: Christian <ctb77@stanford.edu> Date: Fri May 15 21:30:07 2020 -0700 Working FAAValign.py script commit 25d6e2f Author: Christian <ctb77@stanford.edu> Date: Fri May 15 21:29:41 2020 -0700 Merge cmu.py and cmudictionary.py commit d785972 Author: Christian <ctb77@stanford.edu> Date: Fri May 15 14:23:12 2020 -0700 Packaging: Set up poetry and add wheel file for install commit 2bd2266 Merge: 62f04e7 52d857c Author: Christian <ctb77@stanford.edu> Date: Fri May 15 14:02:54 2020 -0700 Merge branch 'modular' of github.com:chrisbrickhouse/FAVE into modular commit 62f04e7 Author: Christian <ctb77@stanford.edu> Date: Fri May 15 13:46:30 2020 -0700 Reorganize commit f9fb50d Author: Christian <ctb77@stanford.edu> Date: Fri May 15 13:31:05 2020 -0700 Rename so import path is sane commit a077268 Merge: 2ee5b3b db0d35f Author: Christian <ctb77@stanford.edu> Date: Fri May 15 13:27:56 2020 -0700 Merge branch 'documentation' into modular commit 2ee5b3b Author: Christian <ctb77@stanford.edu> Date: Thu May 14 22:29:41 2020 -0700 Modularize FAAValign Most of the core files are properly linted. The praat module still needs linted, and a replacement for the FAAValign.py script still needs written. commit 7ab28e6 Author: Christian <ctb77@stanford.edu> Date: Thu May 14 17:28:24 2020 -0700 WIP: Modularize FAAValign The pieces all work together and it will align files. The remaining steps are to get the remaining stray bugs and lint warnings commit c772676 Author: Christian <ctb77@stanford.edu> Date: Thu May 14 01:18:15 2020 -0700 WIP: Modularize FAAValign Most of the pieces fit together now. The main pipeline works up until the actual alignment. commit 9d29e81 Author: Christian <ctb77@stanford.edu> Date: Wed May 13 19:19:32 2020 -0700 WIP: Modularize FAAV-align Putting the pieces back together. Works up to the dictionary checking, but none of the words can be found in the dictionary. commit a0a06d1 Author: Christian <ctb77@stanford.edu> Date: Wed May 13 19:05:12 2020 -0700 WIP: Rename so import path is sane commit bbc70cb Author: Christian <ctb77@stanford.edu> Date: Wed May 13 18:13:38 2020 -0700 WIP: Modularize FAAV-align praat.py is linted. Final step is to put the pieces back together commit b4342c0 Author: Christian <ctb77@stanford.edu> Date: Wed May 13 15:00:51 2020 -0700 WIP: Modularize FAAValign Everything except praat.py is linted. Next step is to lint that module and then make sure all the pieces work together commit 786bbae Author: Christian <ctb77@stanford.edu> Date: Wed May 13 14:32:37 2020 -0700 WIP: Modularize FAAValign FAVE-align/align.py is linted and has no outstanding errors other than that it cannot import the other modules which have errors. commit d082b75 Author: Christian <ctb77@stanford.edu> Date: Tue May 12 23:54:32 2020 -0700 WIP: Modularize FAAValign Everything seems to be in the right places, dependencies still need to be added back and the pieces fit together. Still in the process of linting commit cf904de Author: Christian <ctb77@stanford.edu> Date: Tue May 12 01:02:46 2020 -0700 WIP: Modularize FAAValign Start moving back-end aligning methods to their own class and file. Move things around. Still need to finish sorting back-end and front-end; finishing touches like proper logging, checking dependencies, and testing that everything fits together properly still far off. commit 4e8fd56 Author: Christian <ctb77@stanford.edu> Date: Wed May 6 23:35:39 2020 -0700 WIP: Modularize FAAValign Separate out functions for working with the CMU Dictionary and processing the transcript commit 52d857c Author: Christian <ctb77@stanford.edu> Date: Thu May 14 22:29:41 2020 -0700 Modularize FAAValign Most of the core files are properly linted. The praat module still needs linted, and a replacement for the FAAValign.py script still needs written. commit e1a8596 Author: Christian <ctb77@stanford.edu> Date: Thu May 14 17:28:24 2020 -0700 WIP: Modularize FAAValign The pieces all work together and it will align files. The remaining steps are to get the remaining stray bugs and lint warnings commit b6495f2 Author: Christian <ctb77@stanford.edu> Date: Thu May 14 01:18:15 2020 -0700 WIP: Modularize FAAValign Most of the pieces fit together now. The main pipeline works up until the actual alignment. commit c2099ad Author: Christian <ctb77@stanford.edu> Date: Wed May 13 19:19:32 2020 -0700 WIP: Modularize FAAV-align Putting the pieces back together. Works up to the dictionary checking, but none of the words can be found in the dictionary. commit 7716008 Author: Christian <ctb77@stanford.edu> Date: Wed May 13 19:05:12 2020 -0700 WIP: Rename so import path is sane commit a09d195 Author: Christian <ctb77@stanford.edu> Date: Wed May 13 18:13:38 2020 -0700 WIP: Modularize FAAV-align praat.py is linted. Final step is to put the pieces back together commit ab8eb47 Author: Christian <ctb77@stanford.edu> Date: Wed May 13 15:00:51 2020 -0700 WIP: Modularize FAAValign Everything except praat.py is linted. Next step is to lint that module and then make sure all the pieces work together commit e114344 Author: Christian <ctb77@stanford.edu> Date: Wed May 13 14:32:37 2020 -0700 WIP: Modularize FAAValign FAVE-align/align.py is linted and has no outstanding errors other than that it cannot import the other modules which have errors. commit bb640d2 Author: Christian <ctb77@stanford.edu> Date: Tue May 12 23:54:32 2020 -0700 WIP: Modularize FAAValign Everything seems to be in the right places, dependencies still need to be added back and the pieces fit together. Still in the process of linting commit 8b62eae Author: Christian <ctb77@stanford.edu> Date: Tue May 12 01:02:46 2020 -0700 WIP: Modularize FAAValign Start moving back-end aligning methods to their own class and file. Move things around. Still need to finish sorting back-end and front-end; finishing touches like proper logging, checking dependencies, and testing that everything fits together properly still far off. commit 1765281 Author: Christian <ctb77@stanford.edu> Date: Wed May 6 23:35:39 2020 -0700 WIP: Modularize FAAValign Separate out functions for working with the CMU Dictionary and processing the transcript

chrisbrickhouse · 2020-05-18T23:31:14Z

Incidentally, this also fixes #46

chrisbrickhouse and others added 11 commits May 13, 2020 17:54

Add contributors file to simplify attribution

0b07273

WIP: Document code

38dbfaa

Set up auto documentation of code based on method docstrings and introspection. Still needs the user-facing documentation created, and the code's actual documentation needs to be improved.

Create main.yml

165a2ed

Sets up Continuous Integration for building documentation on push.

WIP: Document code

10fa331

Set up auto documentation of code based on method docstrings and introspection. Still needs the user-facing documentation created, and the code's actual documentation needs to be improved.

WIP: Docs: Add three more modules, change theme

45ec4b8

Merge branch 'documentation' of github.com:chrisbrickhouse/FAVE into …

8d96ad2

…documentation

More sensible name, also allows CI to run properly

db0d35f

Try to get github pages working

00373bd

JoFrhwld merged commit 3206359 into JoFrhwld:dev Oct 26, 2020

chrisbrickhouse mentioned this pull request Aug 22, 2022

extractFormants.py cant find praat on ubuntu. #46

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Python 3#49

Support Python 3#49
JoFrhwld merged 11 commits intoJoFrhwld:devfrom
chrisbrickhouse:master

chrisbrickhouse commented May 17, 2020

Uh oh!

chrisbrickhouse commented May 18, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

chrisbrickhouse commented May 17, 2020

Uh oh!

chrisbrickhouse commented May 18, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants