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

Replace command-line scripts with console scripts #1099

Merged
merged 13 commits into from
Apr 11, 2023

Conversation

nfahlgren
Copy link
Member

@nfahlgren nfahlgren commented Mar 29, 2023

Describe your changes
The currently included plantcv-workflow.py, plantcv-utils.py, and plantcv-train.py scripts do not work well on Windows systems. Additionally, the minimal code in these scripts are not tested (the important underlying code is already).

This PR replaces these scripts with cli modules that are used to build installable programs (console scripts) at the time of installation. After installation the programs are now named: plantcv-run-workflow, plantcv-train, and plantcv-utils.

Type of update
Is this a: New feature or feature enhancement

Associated issues
Supersedes #617
Closes #616

For the reviewer
See this page for instructions on how to review the pull request.

  • PR functionality reviewed in a Jupyter Notebook
  • All tests pass
  • Test coverage remains 100%
  • Documentation tested
  • New documentation pages added to plantcv/mkdocs.yml
  • Changes to function input/output signatures added to updating.md
  • Code reviewed
  • PR approved

@nfahlgren nfahlgren added enhancement Enhancements to existing features bugfix Bug fixes work in progress Mark work in progress labels Mar 29, 2023
@nfahlgren nfahlgren added this to the PlantCV v4.0 milestone Mar 29, 2023
@nfahlgren nfahlgren added this to Pull Requests in PlantCV4 via automation Mar 29, 2023
@codecov
Copy link

codecov bot commented Mar 29, 2023

Codecov Report

Merging #1099 (5cb6cd4) into release-4.0 (89cfe7b) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff               @@
##           release-4.0     #1099    +/-   ##
==============================================
  Coverage       100.00%   100.00%            
==============================================
  Files              161       164     +3     
  Lines             6875      7004   +129     
==============================================
+ Hits              6875      7004   +129     
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
plantcv/learn/cli.py 100.00% <ø> (ø)
plantcv/parallel/cli.py 100.00% <ø> (ø)
plantcv/utils/cli.py 100.00% <ø> (ø)

@nfahlgren nfahlgren added ready to review and removed work in progress Mark work in progress labels Mar 30, 2023
@HaleySchuhl HaleySchuhl self-requested a review April 6, 2023 15:02
@nfahlgren nfahlgren merged commit fb3222a into release-4.0 Apr 11, 2023
5 checks passed
PlantCV4 automation moved this from Pull Requests to Done Apr 11, 2023
@nfahlgren nfahlgren deleted the add-console-scripts branch April 11, 2023 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix Bug fixes enhancement Enhancements to existing features ready to review
Projects
PlantCV4
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants