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

Add show_versions function for easier bug reporting #460

Closed
weiji14 opened this issue May 26, 2020 · 1 comment · Fixed by #466
Closed

Add show_versions function for easier bug reporting #460

weiji14 opened this issue May 26, 2020 · 1 comment · Fixed by #466
Labels
feature request New feature wanted good first issue Good for newcomers help wanted Helping hands are appreciated

Comments

@weiji14
Copy link
Member

weiji14 commented May 26, 2020

Description of the desired feature

Quite a few PyData projects have a show_versions methods that prints out a list of versions for Python packages (see e.g. geopandas/geopandas#899, corteva/rioxarray#106). This would make it easier for people filing bug reports to submit their system information (as required in our bug report template).

Currently we have pygmt.print_clib_info() that prints GMT specific information, but not Python packages. At a minimum, we should have it print the versions for:

  • Operating System
  • python
  • pygmt
  • gmt
  • numpy
  • pandas
  • xarray
  • netcdf
  • etc

For examples on how this could be implemented, see pydata/xarray#1485, https://github.com/pandas-dev/pandas/blob/v1.0.3/pandas/util/_print_versions.py#L61-L124, etc. Should update the bug report template to use this new pygmt.show_versions() function too.

Are you willing to help implement and maintain this feature?

Would be happy to review a Pull Request, as long as you don't put it into utils.py 😉

@weiji14 weiji14 added good first issue Good for newcomers help wanted Helping hands are appreciated feature request New feature wanted labels May 26, 2020
@seisman
Copy link
Member

seisman commented May 26, 2020

It sounds a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature wanted good first issue Good for newcomers help wanted Helping hands are appreciated
Projects
None yet
2 participants