Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workflows install and cache dependencies, use poetry #83

Merged
merged 9 commits into from
Oct 17, 2022

Conversation

chrisbrickhouse
Copy link
Collaborator

Update poetry lock and pyproject.toml with the pytest and flake8 dependencies used by the CI workflow. Update the workflow jobs so that they install dependencies like numpy, and use poetry to run tests and linting.

squashed commit of:

ipa column

aeh to ae:

working on docs

markdown depend

ipa column

aeh to ae:

poetry lock woes

move from rst to myst

conversion cleanup

Add myst-parser to docs/requirements.txt for build

The Github workflow uses the requirements.txt to figure out what
dependencies are needed for the documentation build.

Migrate documentation from ReStructured Text to MarkDown (#1)

* readme

* ipa column

* aeh to ae:

* working on docs

* markdown depend

* Update deps, expand author info in toml

(cherry picked from commit 6bc72a4)

* Docs: write migration guide and doc updates

Update documentation for FAVE 2:
 * Include warning for old users on reading migration guide.
 * Write migration guide with FAQ
 * Simplify TOC code
 * Add index.rst for code and usage sections of docs
 * Add sphinx-project module into conf to make doc updates easier

* Add cmu_dict... test and fix write error

This commit adds some testing for the cmudictionary.py module.

In testing cmudictionary.CMU_Dictionary.add_dictionary_entries()
a bug was uncovered in .check_transcription() which caused the
output file to have more spaces than necessary. The cause was that
function did not split the phone string when it was supposed to.
This commit fixes the error and includes the test to prevent regression.

* Fix unintended overwrite of add_dict

An error in cmudictionary.py caused add_dict to be overwritten and
change type when a transcribed word was not in the cmu dictionary and
had not yet been added to the output dictionary. This led to an obvious
type error and a not obvious failure to add custom dictionaries. This
commit fixes the issue by adding the given word as a key to add_dict
and adds a test to prevent regressions.

Resolves JoFrhwld#59

* Squashed commit of the following:

commit 6bc72a4
Author: Christian Brickhouse <brickhouse@stanford.edu>
Date:   Wed Aug 17 23:10:36 2022 -0700

    Update deps, expand author info in toml

commit 694ba50
Author: Christian Brickhouse <brickhouse@stanford.edu>
Date:   Wed Aug 17 23:09:34 2022 -0700

    Bump version to 2.0.2-dev

commit 716f95e
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Wed Aug 17 22:43:25 2022 -0700

    Fix unintended overwrite of add_dict

    An error in cmudictionary.py caused add_dict to be overwritten and
    change type when a transcribed word was not in the cmu dictionary and
    had not yet been added to the output dictionary. This led to an obvious
    type error and a not obvious failure to add custom dictionaries. This
    commit fixes the issue by adding the given word as a key to add_dict
    and adds a test to prevent regressions.

    Resolves JoFrhwld#59

commit 40503a6
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Wed Aug 17 22:31:34 2022 -0700

    Add cmu_dict... test and fix write error

    This commit adds some testing for the cmudictionary.py module.

    In testing cmudictionary.CMU_Dictionary.add_dictionary_entries()
    a bug was uncovered in .check_transcription() which caused the
    output file to have more spaces than necessary. The cause was that
    function did not split the phone string when it was supposed to.
    This commit fixes the error and includes the test to prevent regression.

* not appropriate to log git versions anymore

* fixing a copy-paste error from elsewhere

* fixing the tqdm pbar update

* updating

* ipa column

* aeh to ae:

* poetry lock woes

* move from rst to myst

* conversion cleanup

* Add myst-parser to docs/requirements.txt for build

The Github workflow uses the requirements.txt to figure out what
dependencies are needed for the documentation build.

Co-authored-by: Christian Brickhouse <brickhouse@stanford.edu>
Co-authored-by: Christian Brickhouse <brickhouse@stanforf.edu>

Update deps, expand author info in toml
Add pytest and flake8 to dev deps

Lock new deps
Squashed commit of the following:

commit 9e92400
Merge: dfc6f8c 4a956d1
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:44:18 2022 -0700

    Merge branch 'master' into workflows

commit 4a956d1
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:14:26 2022 -0700

    Update dev deps and poetry.lock

    Poetry lock update

    Add pytest and flake8 to dev deps

    Lock new deps

commit dfc6f8c
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:29:27 2022 -0700

    run tests and lint using poetry

commit e35ca2f
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:27:09 2022 -0700

    Lock new deps

commit e596d94
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:26:46 2022 -0700

    Add pytest and flake8 to dev deps

commit e1d9ea4
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:19:23 2022 -0700

    try poetry env use

commit 8918232
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:14:26 2022 -0700

    Poetry lock update

commit c1ed2e4
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:08:15 2022 -0700

    rearrange to match documentation

commit bae7507
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:02:38 2022 -0700

    Workflow install poetry deps

commit 7e7b2bf
Merge: dd34199 2dcf530
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 13:52:55 2022 -0700

    Merge branch 'master' into workflows

commit dd34199
Merge: 46a7c9b 3088b9e
Author: Christian <brickhouse@stanford.edu>
Date:   Wed Oct 5 15:47:42 2022 -0700

    Merge branch 'master' into workflows

commit 46a7c9b
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:22:32 2022 -0700

    Make workflow names more intuitive

commit e168e20
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:17:54 2022 -0700

    Remove bash conditional that caused windows runs to fail.

commit 8b0c587
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:11:40 2022 -0700

    Fix yml error

commit e0520fe
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:10:27 2022 -0700

    Add additional OS tests.

commit 255bd1b
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:04:08 2022 -0700

    Configure pytest so it finds the fave module.

commit fa11b96
Merge: cac8c3e 6adfde3
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:01:33 2022 -0700

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

commit cac8c3e
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 13:58:33 2022 -0700

    Add flake8 config

commit 06f6121
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 13:41:59 2022 -0700

    Set to run on this branch

commit ffb7328
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Mon Jul 11 18:16:15 2022 -0700

    Add basic tests for TranscriptProcessor

commit 356867d
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Mon Jul 11 16:38:33 2022 -0700

    Add basic python package CI workflow

commit 6adfde3
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 13:41:59 2022 -0700

    Set to run on this branch

commit 77be18d
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Mon Jul 11 18:16:15 2022 -0700

    Add basic tests for TranscriptProcessor

commit 348963d
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Mon Jul 11 16:38:33 2022 -0700

    Add basic python package CI workflow
Add pytest and flake8 to dev deps

Lock new deps
Squashed commit of the following:

commit 9e92400
Merge: dfc6f8c 4a956d1
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:44:18 2022 -0700

    Merge branch 'master' into workflows

commit 4a956d1
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:14:26 2022 -0700

    Update dev deps and poetry.lock

    Poetry lock update

    Add pytest and flake8 to dev deps

    Lock new deps

commit dfc6f8c
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:29:27 2022 -0700

    run tests and lint using poetry

commit e35ca2f
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:27:09 2022 -0700

    Lock new deps

commit e596d94
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:26:46 2022 -0700

    Add pytest and flake8 to dev deps

commit e1d9ea4
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:19:23 2022 -0700

    try poetry env use

commit 8918232
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:14:26 2022 -0700

    Poetry lock update

commit c1ed2e4
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:08:15 2022 -0700

    rearrange to match documentation

commit bae7507
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 14:02:38 2022 -0700

    Workflow install poetry deps

commit 7e7b2bf
Merge: dd34199 2dcf530
Author: Christian <brickhouse@stanford.edu>
Date:   Mon Oct 10 13:52:55 2022 -0700

    Merge branch 'master' into workflows

commit dd34199
Merge: 46a7c9b 3088b9e
Author: Christian <brickhouse@stanford.edu>
Date:   Wed Oct 5 15:47:42 2022 -0700

    Merge branch 'master' into workflows

commit 46a7c9b
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:22:32 2022 -0700

    Make workflow names more intuitive

commit e168e20
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:17:54 2022 -0700

    Remove bash conditional that caused windows runs to fail.

commit 8b0c587
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:11:40 2022 -0700

    Fix yml error

commit e0520fe
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:10:27 2022 -0700

    Add additional OS tests.

commit 255bd1b
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:04:08 2022 -0700

    Configure pytest so it finds the fave module.

commit fa11b96
Merge: cac8c3e 6adfde3
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 14:01:33 2022 -0700

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

commit cac8c3e
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 13:58:33 2022 -0700

    Add flake8 config

commit 06f6121
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 13:41:59 2022 -0700

    Set to run on this branch

commit ffb7328
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Mon Jul 11 18:16:15 2022 -0700

    Add basic tests for TranscriptProcessor

commit 356867d
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Mon Jul 11 16:38:33 2022 -0700

    Add basic python package CI workflow

commit 6adfde3
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Tue Jul 12 13:41:59 2022 -0700

    Set to run on this branch

commit 77be18d
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Mon Jul 11 18:16:15 2022 -0700

    Add basic tests for TranscriptProcessor

commit 348963d
Author: Christian Brickhouse <brickhouse@stanforf.edu>
Date:   Mon Jul 11 16:38:33 2022 -0700

    Add basic python package CI workflow
Lock and update dev deps

Add pytest and flake8 to dev deps

Lock new deps
@chrisbrickhouse chrisbrickhouse merged commit 25d7563 into JoFrhwld:dev Oct 17, 2022
@JoFrhwld
Copy link
Owner

Do we need to merge this all the way into master to get the checks to start passing?

Also, I’d been holding off with reviewing & merging this until I could get around to fixing things with the docs branches, since I think a lot of those changes are actually in this PR, but I think the changes I’d’ve wanted to get accurately reflected in doc-fix are in this PR anyway.

@chrisbrickhouse
Copy link
Collaborator Author

Do we need to merge this all the way into master to get the checks to start passing?

I don't think so. As long as future PRs are based on this one, it should run the proper checks.

I’d been holding off with reviewing & merging this until I could get around to fixing things with the docs branches, since I think a lot of those changes are actually in this PR

I actually didn't realize that the doc changes were included here, and I intended for this to be atomic. I guess my dev branch and your dev branch diverged. I'll revert and submit a new PR to keep the commit clean, especially since it involves major changes to the lock file and docs that really shouldn't be mixed.

chrisbrickhouse added a commit that referenced this pull request Oct 18, 2022
chrisbrickhouse added a commit that referenced this pull request Oct 18, 2022
chrisbrickhouse added a commit to chrisbrickhouse/FAVE that referenced this pull request Mar 13, 2024
* Update workflows to install package dependencies like numpy for use in tests
* Cache installed dependencies so that future runs are faster
* Upgrade setup-python to v4 from v3
chrisbrickhouse added a commit to chrisbrickhouse/FAVE that referenced this pull request Mar 13, 2024
chrisbrickhouse added a commit that referenced this pull request Mar 29, 2024
* Update workflows to install package dependencies like numpy for use in tests
* Cache installed dependencies so that future runs are faster
* Upgrade setup-python to v4 from v3
chrisbrickhouse added a commit that referenced this pull request Mar 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants