setup: add all executable modules as `entry_points/console_scripts` by jhkennedy · Pull Request #659 · insarlab/MintPy

jhkennedy · 2021-09-09T23:26:50Z

Description of proposed changes

This add all currently executable modules as console_scripts entry_points in setup.py, addressing Task 3 in #652 and (I think) finished off #497. This comment gives a detailed explination of how entrypoints work, and how it changes develoment workflows.

*I have not extensively tested these scripts beyond making sure arguments are passed through appropriately and all can be called with --help.

Note: I've not added tropo_pyaps.py as I believe it's a legacy script that's been superseded by tropo_pyaps3.py.

Other thoughts:

It might be worth rearranging the setup.py file (e.g., move the packages and entry_points arguments to the bottom)

Reminders

Pass Codacy code review (green)
Pass Circle CI test (green)
Make sure that your code follows our style. Use the other functions/files as a basis.
If modifying functionality, describe changes to function behavior and arguments in a comment below the function declaration.
If adding new functionality, add a detailed description to the documentation and/or an example.

…gs so --help or missing args exit gracefully

…rguments are provided.

… traceback when no arguments are provided.

welcome · 2021-09-09T23:26:52Z

💖 Thanks for opening this pull request! Please check out our contributing guidelines. 💖
Keep in mind that all new features should be documented. It helps to write the comments next to the code or below your functions describing all arguments, and return types before writing the code. This will help you think about your code design and usually results in better code.

jhkennedy · 2021-09-09T23:30:34Z

Oh, I also have not addressed any installation, etc. type documentation -- that could be addressed here, or in conjunction with documentation about conda-forge after this has been vetted more.

mintpy/save_gbis.py

mintpy/multi_transect.py

mintpy/add_attribute.py

mintpy/tsview.py

setup.py

yunjunz · 2021-09-10T05:09:21Z

It might be worth rearranging the setup.py file (e.g., move the packages and entry_points arguments to the bottom)

Sounds good to me, please do it as you see fit.

yunjunz · 2021-09-10T05:12:19Z

Oh, I also have not addressed any installation, etc. type documentation -- that could be addressed here, or in conjunction with documentation about conda-forge after this has been vetted more.

Yep, there will be big (good) changes in the installation. I would prefer to do it in another PR when conda-forge is ready and this PR is tested more as you said.

…t__" This reverts commit b86c4cf.

jhkennedy · 2021-09-10T21:52:06Z

It might be worth rearranging the setup.py file (e.g., move the packages and entry_points arguments to the bottom)

Sounds good to me, please do it as you see fit.

Done!

yunjunz

Looks all good to me. I will do more testings on the weekend before merging it. Thank you @jhkennedy!

yunjunz · 2021-09-11T23:34:32Z

I installed and tested mintpy as below on macOS. Everything looks good to me.

# download
cd ~/tools
git clone https://github.com/insarlab/MintPy.git
# install
conda create --name test
conda activate test
conda install --file tools/MintPy/docs/requirements.txt pysolid pyaps3 gdal">=3"
cd ~/tools/MintPy
python setup.py install
# test
python ~/tools/MintPy/tests/test_smallbaselineApp.py

welcome · 2021-09-11T23:41:33Z

🎉 🎉 🎉 Congrats on merging your first pull request! We here at behaviorbot are proud of you! 🎉 🎉 🎉

jhkennedy · 2021-09-13T17:19:30Z

@yunjunz Just a note -- python -m pip install should be preferred over python setup.py install as setup.py invokes the old and depreciated egg protocol.

yunjunz · 2021-09-13T19:57:36Z

Good to know, thanks.

+ simplify the installation since now `pyaps3` and `pysolid` are available via conda-forge, so they are no longer need to be manually cloned and installed anymore. This simplifies the environment setup files and installation notes. + since #659, there's no longer a need to manipulate PATH or PYTHONPATH for mintpy anymore, as a "pip install" will correctly place the mintpy package and all executable scripts to be available in the environment. Co-authored-by: Zhang Yunjun <yunjunzgeo@gmail.com>

jhkennedy added 5 commits September 9, 2021 14:31

Add all working entrypoints

6a9719c

Move tsview.py command line parsing to timeseriesViewer.__init__

b86c4cf

move save_gbis.py print cmd_line_parse iargs to after parser.parse_ar…

979dab6

…gs so --help or missing args exit gracefully

Allow main(None) so usage gets printed instead of traceback when no a…

0571550

…rguments are provided.

Allow main(None) in add_attribute.py so usage gets printed instead of…

3e243ec

… traceback when no arguments are provided.

jhkennedy added the enhancement label Sep 9, 2021

jhkennedy changed the title ~~Add all currently executable modules as console_scripts entry_point in setup.py~~ Add all currently executable modules as console_scripts entry_points in setup.py Sep 9, 2021

jhkennedy commented Sep 9, 2021

View reviewed changes

mintpy/save_gbis.py Show resolved Hide resolved

mintpy/multi_transect.py Show resolved Hide resolved

mintpy/add_attribute.py Show resolved Hide resolved

mintpy/tsview.py Outdated Show resolved Hide resolved

yunjunz self-requested a review September 10, 2021 00:56

yunjunz reviewed Sep 10, 2021

View reviewed changes

mintpy/tsview.py Show resolved Hide resolved

yunjunz reviewed Sep 10, 2021

View reviewed changes

setup.py Outdated Show resolved Hide resolved

yunjunz changed the title ~~Add all currently executable modules as console_scripts entry_points in setup.py~~ setup: add all executable modules as entry_points/console_scripts Sep 10, 2021

jhkennedy added 4 commits September 10, 2021 13:33

Revert "Move tsview.py command line parsing to timeseriesViewer.__ini…

c192101

…t__" This reverts commit b86c4cf.

Allow iargs=None in tsview.timeseriesViewer.__init__

97ccb51

Enable all entrypoints

ca48d85

Reorganize setup.py, drop depreciated depedency_links

8f826ba

Update tsview.py

64db66c

yunjunz approved these changes Sep 10, 2021

View reviewed changes

yunjunz merged commit 65fe5eb into insarlab:main Sep 11, 2021

jhkennedy deleted the entrypints branch November 13, 2021 06:13

jhkennedy mentioned this pull request Nov 15, 2021

Automatically build and push a docker image #696

Merged

6 tasks

jhkennedy mentioned this pull request Nov 19, 2021

update installation note, env setup and circle-ci testing #700

Merged

6 tasks

Conversation

jhkennedy commented Sep 9, 2021 • edited by yunjunz Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

welcome bot commented Sep 9, 2021

Uh oh!

jhkennedy commented Sep 9, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yunjunz commented Sep 10, 2021

Uh oh!

yunjunz commented Sep 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jhkennedy commented Sep 10, 2021

Uh oh!

yunjunz left a comment

Choose a reason for hiding this comment

Uh oh!

yunjunz commented Sep 11, 2021

Uh oh!

welcome bot commented Sep 11, 2021

Uh oh!

jhkennedy commented Sep 13, 2021

Uh oh!

yunjunz commented Sep 13, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jhkennedy commented Sep 9, 2021 •

edited by yunjunz

Loading

yunjunz commented Sep 10, 2021 •

edited

Loading