search

NRLMMD-GEOIPS / geoips

Main Geolocated Information Processing System code base with basic functionality enabled.
https://nrlmmd-geoips.github.io/geoips/
Other
13 stars 10 forks source link

Update ``geoips get / describe`` to add source code link for package retrieved #571

Closed evrose54 closed 3 weeks ago

evrose54 commented 1 month ago

Requested Update

Description

We should update the command geoips get package (later to be geoips describe package) to include in its output a link to the corresponding GeoIPS Package Source Code (repo code). . For example, if we were to run geoips get package geoips, we'd also include an attribute called source_code (or something similar) which would be a url to the corresponding source code for such package (in this case https://github.com/NRLMMD-GEOIPS/geoips).

Background and Motivation

This stemmed from a conversation about #444.

jsolbrig commented 1 month ago

This can probably be done along with #579.

evrose54 commented 1 month ago

This is already done actually. The name attribute name could probably be changed from Documentation Link to Source Code, however the functionality is all in place.

(geoips) (base) [evan@spring geoips]$ geoips get package geoips_clavrx

Docstring: GeoIPS CLAVR-x plugin.
Documentation Link: https://github.com/NRLMMD-GEOIPS/geoips_clavrx
GeoIPS Package: geoips_clavrx
Package Path: /local/home/evan/geoips/geoips_packages/geoips_clavrx/geoips_clavrx
Version Number: 1.12.2a0

WARNING: The GeoIPS CLI is currently under development and is subject to change.
Until this warning is removed, do not rely on the CLI to be static.
Please feel free to test the CLI and report any bugs or comments as an issue here:
https://github.com/NRLMMD-GEOIPS/geoips/issues/new/choose
evrose54 commented 1 month ago

Just spoke with @jsolbrig and we're going to name this Source Code