rms-pds4indextools 1.0.1

pds4indextools

Introduction

pds4indextools is a set of programs and modules for parsing PDS4 XML labels. They were created and are maintained by the Ring-Moon Systems Node of NASA's Planetary Data System (PDS).

The following tools are currently available:

• pds4_create_xml_index: A command-line program to scrape information from a series of PDS4 XML labels, usually in a single collection, and generate a summary index file.

Installation

pds4indextools is available via the rms-pds4indextools package on PyPI and can be installed with:

pip install rms-pds4indextools

Note that this will install pds4indextools into your current system Python, or into your currently activated virtual environment (venv), if any. You may also install using pipx, which will isolate the installation from your system Python without requiring the creation of a virtual environment. To install pipx, please see the installation instructions. Once pipx is available, you may install pds4indextools with:

pipx install rms-pds4indextools

Getting Started With pds4_create_xml_index

Once pds4indextools has been installed, you may access the pds4_create_index_tools program directly from the command line.

The simplest use scrapes all XML labels from a collection and generates an index file:

pds4_create_xml_index <collection_dir> "**/*.xml"

Many options are available to customize the scraping and generation process, including limiting which XML elements are scrape, changing the format of the resulting index file, and generating a PDS4-compliant label. A summary of available options is available by typing:

pds4_create_xml_index --help

Complete documentation is available here

Contributing

Information on contributing to this package can be found in the Contributing Guide.

Links

• Documentation
• Repository
• Issue tracker
• PyPi

Licensing

This code is licensed under the Apache License v2.0.