Skip to content

Add show_versions function for easier bug reporting #460

@weiji14

Description

@weiji14

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 😉

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions