plantcv icon indicating copy to clipboard operation
plantcv copied to clipboard

Executable scripts

Open dschneiderch opened this issue 4 years ago • 1 comments

Describe your changes Creates executable scripts for plantcv-workflow.py, plantcv-utils.py, and plantcv-train.py for all platforms using the setuptools.setup(entry_point={'console_scripts': in setup.py. Replaces the use of setuptools.setup(scripts=

See #616 for discussion.

Type of update This is an enhancement primarily for Windows users because it simplifies the use of the plantcv-workflow and co scripts and adheres to packaging best-practices. Particularly useful for those switching between Windows and Linux because now the syntax is the same.

Associated issues #616

Additional context It's not backwards compatible for Windows users because now they have to call plantcv-workflow instead of python %CONDA_PREFIX%/Scripts/plantcv-workflow.py. plantcv-workflow.py is no longer available on Windows.

From a semantic versioning POV it'd make the most sense to wait until PCV4 but selfishly I'd like to see it in 3.10 since there have been other breaking changes in point releases :-)

We would want to modify #607 accordingly.

I assume placing the scripts in a subpackage means we should and can test them. I can do that if you want to approve this pull request.

dschneiderch avatar Sep 03 '20 17:09 dschneiderch

Codecov Report

Merging #617 into master will decrease coverage by 3.12%. The diff coverage is 0.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #617      +/-   ##
==========================================
- Coverage   99.86%   96.73%   -3.13%     
==========================================
  Files         125      129       +4     
  Lines        5876     6066     +190     
==========================================
  Hits         5868     5868              
- Misses          8      198     +190     
Flag Coverage Δ
#unittests 96.73% <0.00%> (-3.13%) :arrow_down:

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

Impacted Files Coverage Δ
plantcv/cli/__init__.py 0.00% <0.00%> (ø)
plantcv/cli/train.py 0.00% <ø> (ø)
plantcv/cli/utils.py 0.00% <ø> (ø)
plantcv/cli/workflow.py 0.00% <ø> (ø)

codecov[bot] avatar Sep 03 '20 17:09 codecov[bot]

Console scripts merged into release-4.0

nfahlgren avatar Jun 13 '23 21:06 nfahlgren