Distribution Statement
# # # This source code is subject to the license referenced at

Command Line Interface#

GeoIPS CLI

The GeoIPS Command Line Interface (CLI) is currently under development, but we’ll keep updated instructions in this documentation that reflect the current state of the CLI.

The GeoIPS CLI is used to interrogate / utilize GeoIPS artifacts in a user-friendly manner. A GeoIPS artifact is an term used to reflect the chosen piece of data or functionality implemented in GeoIPS. This could be a GeoIPS Interface, Package, Plugin, Family, Test Script, Test Dataset, etc. that is used and/or implemented throughout the GeoIPS Environment.

The CLI is split up into two groups as of right now. CLI commands which retrieve information from GeoIPS and CLI commands which perform processes via GeoIPS. We’ll dive into each of those sections now.

CLI Use Cases#

For your ease of use, we’ve provided a complete listing of all available GeoIPS CLI commands below. This diagrams what commands are available, and the required and/or optional arguments that go alongside these commands.

GeoIPS CLI Commands

Usage: geoips

geoips#

usage: geoips [-h] [-log {debug,info,warning,interactive,error,critical}]
              {config,cfg,describe,desc,list,ls,run,test,tree,validate,val}
              ...
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

geoips config#

Various configuration-based commands for setting up your geoips environment. Currently supports geoips config install <test_dataset_name> command.

usage: To use, type `geoips config <cmd> <sub-command> ...`
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

To use, type geoips config <cmd> <sub-command> … install#

Install the appropriate test dataset and/or package based on the arguments provided. To see a list of available test datasets for install, run geoips list test-datasets. If wanting to install data to a location different that $GEOIPS_TESTDATA_DIR, then use the -o (outdir) option and provide a full path to the directory you desire to install data in.

usage: To use, type `geoips config install <test_dataset_name> -o <full_path>`.
test_dataset_name#

GeoIPS Test Dataset to Install.

-h, --help#

show this help message and exit

-o <outdir>, --outdir <outdir>#

The full path to the directory you want to install this data to.

geoips config#

Various configuration-based commands for setting up your geoips environment. Currently supports geoips config install <test_dataset_name> command.

usage: To use, type `geoips config <cmd> <sub-command> ...`
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

To use, type geoips config <cmd> <sub-command> … install#

Install the appropriate test dataset and/or package based on the arguments provided. To see a list of available test datasets for install, run geoips list test-datasets. If wanting to install data to a location different that $GEOIPS_TESTDATA_DIR, then use the -o (outdir) option and provide a full path to the directory you desire to install data in.

usage: To use, type `geoips config install <test_dataset_name> -o <full_path>`.
test_dataset_name#

GeoIPS Test Dataset to Install.

-h, --help#

show this help message and exit

-o <outdir>, --outdir <outdir>#

The full path to the directory you want to install this data to.

geoips describe#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

To use, type geoips describe <interface_name> <sub-cmd> …. algorithms#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. algorithms#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. algorithms#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. algorithms#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. coverage-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. coverage-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. colormappers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. colormappers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. colormappers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. colormappers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. coverage-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. coverage-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. databases#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. databases#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. databases#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. databases#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. feature-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. feature-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. feature-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. feature-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. filename-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. filename-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. filename-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. filename-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. gridline-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. gridline-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. gridline-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. gridline-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. interpolators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. interpolators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. interpolators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. interpolators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. package#

Retrieve the appropriate GeoIPS Package alongside descriptive information of that package. See output_info for each datum provided when this command is called. For a listing of available GeoIPS packages, run: geoips list packages.

usage: To use, type `geoips describe package <package_name>`, where <package_name> is a
valid GeoIPS Package.
package_name#

GeoIPS Package to retrieve.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. procflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. procflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. package#

Retrieve the appropriate GeoIPS Package alongside descriptive information of that package. See output_info for each datum provided when this command is called. For a listing of available GeoIPS packages, run: geoips list packages.

usage: To use, type `geoips describe package <package_name>`, where <package_name> is a
valid GeoIPS Package.
package_name#

GeoIPS Package to retrieve.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. procflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. procflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. products#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. products#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. products#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. products#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. readers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. readers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. readers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. readers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-adjusters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-adjusters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sectors#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sectors#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sectors#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-adjusters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-adjusters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-metadata-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-metadata-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-spec-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-spec-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sectors#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-metadata-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-metadata-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-spec-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-spec-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. title-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. title-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. title-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. title-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. workflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. workflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. workflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. workflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

geoips describe#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

To use, type geoips describe <interface_name> <sub-cmd> …. algorithms#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. algorithms#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. algorithms#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. algorithms#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. coverage-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. coverage-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. colormappers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. colormappers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. colormappers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. colormappers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. coverage-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. coverage-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. databases#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. databases#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. databases#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. databases#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. feature-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. feature-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. feature-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. feature-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. filename-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. filename-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. filename-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. filename-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. gridline-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. gridline-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. gridline-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. gridline-annotators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. interpolators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. interpolators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. interpolators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. interpolators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-checkers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. output-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. package#

Retrieve the appropriate GeoIPS Package alongside descriptive information of that package. See output_info for each datum provided when this command is called. For a listing of available GeoIPS packages, run: geoips list packages.

usage: To use, type `geoips describe package <package_name>`, where <package_name> is a
valid GeoIPS Package.
package_name#

GeoIPS Package to retrieve.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. procflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. procflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. package#

Retrieve the appropriate GeoIPS Package alongside descriptive information of that package. See output_info for each datum provided when this command is called. For a listing of available GeoIPS packages, run: geoips list packages.

usage: To use, type `geoips describe package <package_name>`, where <package_name> is a
valid GeoIPS Package.
package_name#

GeoIPS Package to retrieve.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. procflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. procflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. products#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. products#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. products#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. product-defaults#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. products#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. readers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. readers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. readers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. readers#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-adjusters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-adjusters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sectors#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sectors#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sectors#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-adjusters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-adjusters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-metadata-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-metadata-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-spec-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-spec-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sectors#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-metadata-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-metadata-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-spec-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. sector-spec-generators#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. title-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. title-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. title-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. title-formatters#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. workflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. workflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. workflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

To use, type geoips describe <interface_name> <sub-cmd> …. workflows#

Retrieve information about a GeoIPS artifact. For this command, an artifact is one of [‘interface’, ‘plugin’, ‘family’]. To get more information on how to retrieve these artifacts, see below.

  • Interface:
    • Command Signature:
      • geoips describe <interface_name>

    • Artifact Listing:
      • geoips list interfaces

    • output_info:
      • Absolute Path

      • Docstring

      • Interface Name

      • Interface Type

      • Supported Families

  • Plugin:
    • Command Signature:
      • geoips describe <interface_name> <plugin_name>

    • Artifact Listing:
      • geoips list plugins <-p> <package_name>

    • Output Info:
      • Docstring

      • Family Name

      • GeoIPS Package

      • Interface Name

      • Plugin Type

      • call_sig / source_names / Product Defaults (dependent on Plugin Type)

      • Relative Path

  • Family:
    • Command Signature:
      • geoips describe <interface_name> family <family_name>

    • Artifact Listing:
      • geoips list interfaces –columns interface supported_families

    • Output Info:
      • Docstring

      • Family Name

      • Family Path

      • Interface Name

      • Interface Type

      • Required Arguments / Schema

usage: To use, type `geoips describe <interface_name> <sub-cmd> ...`.
plugin_name#

GeoIPS Plugin to select from the provided interface.

family_name#

GeoIPS Family to select from the provided interface.

-h, --help#

show this help message and exit

geoips list#

List off available GeoIPS artifacts provided further commands. Current artifacts available for listing are: [“algorithms”, “colormappers”, “coverage_checkers”, “databases”, “filename_formatters”, “interpolators”, “output_checkers”, “output_formatters”, “procflows”, “readers”, “sector_adjusters”, “sector_metadata_generators”, “sector_spec_generators”, “title_formatters”, “feature_annotators”, “gridline_annotators”, “product_defaults”, “products”, “sectors”, “interfaces”, “packages”, “plugins”, “scripts”, “test-datasets”, “unit-tests”].

usage: To use, type `geoips list <cmd> <sub-cmd>`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

To use, type geoips list <cmd> <sub-cmd>. algorithms#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. algorithms#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. algorithms#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. algorithms#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. coverage-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. coverage-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. colormappers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. colormappers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. colormappers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. colormappers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. coverage-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. coverage-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. databases#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. databases#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. databases#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. databases#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. feature-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. feature-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. feature-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. feature-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. filename-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. filename-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. filename-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. filename-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. gridline-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. gridline-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. gridline-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. gridline-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. interfaces#

List off every GeoIPS Interface. This is useful for seeing what is available throughout GeoIPS, but can also be extended to see what interfaces have been implemented in other geoips package, or just a certain package. This information can then be used with geoips describe <interface_name> to retrieve more information about a certain interface.

usage: To use, type `geoips list interfaces`. Optionally includes `-i` and `-p` flags for
seeing what has been implemented (-i) in a certain package (-p), or all packages.
For example, to see what interfaces have been implemented in a certain package,
run `geoips list interfaces -i -p <pkg_name>`, or you can remove the `-p` flag to
see what's been implemented in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

--implemented, -i#

Flag to list what’s implemented in each package, rather than what’s available.

To use, type geoips list <cmd> <sub-cmd>. interpolators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. interpolators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. interpolators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. interpolators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. packages#

List off packages found under the GeoIPS Namespace, alongside their path and top-level docstring. This command will list every GeoIPS Package found, provided it has already been installed.

usage: To use, type `geoips list packages`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. procflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. procflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. packages#

List off packages found under the GeoIPS Namespace, alongside their path and top-level docstring. This command will list every GeoIPS Package found, provided it has already been installed.

usage: To use, type `geoips list packages`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. plugins#

List off plugins found under all, or a specified GeoIPS package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list plugins`. Optionally includes `-p` flag for
seeing what plugins are in a certain package (-p). For example, to see what
plugins have been created in a single package, run
`geoips list plugins -p <pkg_name>`, or you can remove the `-p` flag to see what's
been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. plugins#

List off plugins found under all, or a specified GeoIPS package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list plugins`. Optionally includes `-p` flag for
seeing what plugins are in a certain package (-p). For example, to see what
plugins have been created in a single package, run
`geoips list plugins -p <pkg_name>`, or you can remove the `-p` flag to see what's
been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. procflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. procflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. products#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. products#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. products#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. products#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. readers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. readers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. readers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. readers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-adjusters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-adjusters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. scripts#

List off scripts found under all, or a specified GeoIPS package. This information can then be used with geoips run <package_name> <script_name> to run a certain process workflow, defined in a bash script.

usage: To use, type `geoips list scripts`. Optionally includes `-p` flag for
seeing what scripts are in a certain package (-p). For example, to see what
scripts have been created in a single package, run
`geoips list scripts -p <pkg_name>`, or you can remove the `-p` flag to see what's
been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sectors#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sectors#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sectors#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-adjusters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-adjusters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-metadata-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-metadata-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-spec-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-spec-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sectors#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-metadata-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-metadata-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. source-names#

List off source_names of reader plugins found under all, or a specified GeoIPS package. This information can then be used in creating product plugins which will use the aforementioned source_names for product creation.

usage: To use, type `geoips list source-names`. Optionally includes `-p` flag for
seeing what source-names are in a certain package (-p). For example, to see what
source-names are attributed to a single package, run
`geoips list source-names -p <pkg_name>`, or you can remove the `-p` flag to see
what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. source-names#

List off source_names of reader plugins found under all, or a specified GeoIPS package. This information can then be used in creating product plugins which will use the aforementioned source_names for product creation.

usage: To use, type `geoips list source-names`. Optionally includes `-p` flag for
seeing what source-names are in a certain package (-p). For example, to see what
source-names are attributed to a single package, run
`geoips list source-names -p <pkg_name>`, or you can remove the `-p` flag to see
what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-spec-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-spec-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. test-datasets#

List off test-datasets used for testing GeoIPS and other GeoIPS Packages. This data is used for running tests via geoips run <pkg_name> <script_name>.

usage: To use, type `geoips list test-datasets`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. title-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. title-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. title-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. title-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. unit-tests#

List off unit-tests used in a certain GeoIPS Package. This data can be used to run unit tests via geoips test unit-test ….

usage: To use, type `geoips list unit-tests -p <package_name>`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. workflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. workflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. workflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. workflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

geoips list#

List off available GeoIPS artifacts provided further commands. Current artifacts available for listing are: [“algorithms”, “colormappers”, “coverage_checkers”, “databases”, “filename_formatters”, “interpolators”, “output_checkers”, “output_formatters”, “procflows”, “readers”, “sector_adjusters”, “sector_metadata_generators”, “sector_spec_generators”, “title_formatters”, “feature_annotators”, “gridline_annotators”, “product_defaults”, “products”, “sectors”, “interfaces”, “packages”, “plugins”, “scripts”, “test-datasets”, “unit-tests”].

usage: To use, type `geoips list <cmd> <sub-cmd>`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

To use, type geoips list <cmd> <sub-cmd>. algorithms#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. algorithms#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. algorithms#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. algorithms#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. coverage-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. coverage-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. colormappers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. colormappers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. colormappers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. colormappers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. coverage-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. coverage-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. databases#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. databases#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. databases#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. databases#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. feature-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. feature-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. feature-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. feature-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. filename-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. filename-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. filename-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. filename-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. gridline-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. gridline-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. gridline-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. gridline-annotators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. interfaces#

List off every GeoIPS Interface. This is useful for seeing what is available throughout GeoIPS, but can also be extended to see what interfaces have been implemented in other geoips package, or just a certain package. This information can then be used with geoips describe <interface_name> to retrieve more information about a certain interface.

usage: To use, type `geoips list interfaces`. Optionally includes `-i` and `-p` flags for
seeing what has been implemented (-i) in a certain package (-p), or all packages.
For example, to see what interfaces have been implemented in a certain package,
run `geoips list interfaces -i -p <pkg_name>`, or you can remove the `-p` flag to
see what's been implemented in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

--implemented, -i#

Flag to list what’s implemented in each package, rather than what’s available.

To use, type geoips list <cmd> <sub-cmd>. interpolators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. interpolators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. interpolators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. interpolators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-checkers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. output-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. packages#

List off packages found under the GeoIPS Namespace, alongside their path and top-level docstring. This command will list every GeoIPS Package found, provided it has already been installed.

usage: To use, type `geoips list packages`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. procflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. procflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. packages#

List off packages found under the GeoIPS Namespace, alongside their path and top-level docstring. This command will list every GeoIPS Package found, provided it has already been installed.

usage: To use, type `geoips list packages`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. plugins#

List off plugins found under all, or a specified GeoIPS package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list plugins`. Optionally includes `-p` flag for
seeing what plugins are in a certain package (-p). For example, to see what
plugins have been created in a single package, run
`geoips list plugins -p <pkg_name>`, or you can remove the `-p` flag to see what's
been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. plugins#

List off plugins found under all, or a specified GeoIPS package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list plugins`. Optionally includes `-p` flag for
seeing what plugins are in a certain package (-p). For example, to see what
plugins have been created in a single package, run
`geoips list plugins -p <pkg_name>`, or you can remove the `-p` flag to see what's
been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. procflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. procflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. products#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. products#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. products#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. product-defaults#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. products#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. readers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. readers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. readers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. readers#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-adjusters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-adjusters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. scripts#

List off scripts found under all, or a specified GeoIPS package. This information can then be used with geoips run <package_name> <script_name> to run a certain process workflow, defined in a bash script.

usage: To use, type `geoips list scripts`. Optionally includes `-p` flag for
seeing what scripts are in a certain package (-p). For example, to see what
scripts have been created in a single package, run
`geoips list scripts -p <pkg_name>`, or you can remove the `-p` flag to see what's
been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sectors#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sectors#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sectors#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-adjusters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-adjusters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-metadata-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-metadata-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-spec-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-spec-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sectors#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-metadata-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-metadata-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. source-names#

List off source_names of reader plugins found under all, or a specified GeoIPS package. This information can then be used in creating product plugins which will use the aforementioned source_names for product creation.

usage: To use, type `geoips list source-names`. Optionally includes `-p` flag for
seeing what source-names are in a certain package (-p). For example, to see what
source-names are attributed to a single package, run
`geoips list source-names -p <pkg_name>`, or you can remove the `-p` flag to see
what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. source-names#

List off source_names of reader plugins found under all, or a specified GeoIPS package. This information can then be used in creating product plugins which will use the aforementioned source_names for product creation.

usage: To use, type `geoips list source-names`. Optionally includes `-p` flag for
seeing what source-names are in a certain package (-p). For example, to see what
source-names are attributed to a single package, run
`geoips list source-names -p <pkg_name>`, or you can remove the `-p` flag to see
what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-spec-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. sector-spec-generators#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. test-datasets#

List off test-datasets used for testing GeoIPS and other GeoIPS Packages. This data is used for running tests via geoips run <pkg_name> <script_name>.

usage: To use, type `geoips list test-datasets`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. title-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. title-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. title-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. title-formatters#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. unit-tests#

List off unit-tests used in a certain GeoIPS Package. This data can be used to run unit tests via geoips test unit-test ….

usage: To use, type `geoips list unit-tests -p <package_name>`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. workflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. workflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. workflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

To use, type geoips list <cmd> <sub-cmd>. workflows#

List off plugins found under this interface. This is useful for seeing what plugins have been implemented through all, or a certain, GeoIPS Package. This information can then be used with geoips describe <interface_name> <plugin_name> to retrieve more information about a certain plugin.

usage: To use, type `geoips list <interface_name>`. Optionally includes `-p`
flag for seeing what plugins are in a certain package (-p). For example, to see
what plugins under a certain interface have been created in a single package,
run `geoips list <interface_name> -p <pkg_name>`, or you can remove the
`-p` flag to see what's been created in every package.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--package_name {geoips}, -p {geoips}#

The GeoIPS package to list from.

--long, -l#

Flag representing the ‘long’ listing of a certain command.

--columns <columns>, -c <columns>#

Specific Headers of Data you’d like to see listed. For more in formation on headers available, run ‘geoips list <cmd> <positional_args> –columns help’.

geoips run#

Run a specified geoips process workflow (procflow) plugin. See ‘geoips run single_source’ or ‘geoips run data_fusion’ for more information of what arguments to provide.

usage: To use, type `geoips run <procflow_name> **<procflow_arguments>`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

To use, type geoips run <procflow_name> **<procflow_arguments>. config_based#

Run the config based process workflow. For more information of the arguments available, either run ‘geoips run config_basd -h’, or view the arguments set up in geoips.commandline.args:add_args

usage: To use, type `geoips run data_fusion **<data_fusion_args>`.
filenames#

Fully qualified paths to data files to be processed.

-h, --help#

show this help message and exit

-o <outdir>, --outdir <outdir>#

Path to write output files. Defaults to GEOIPS_OUTDIRS.

-l {INTERACTIVE,INFO,DEBUG,WARNING,ERROR,CRITICAL}, --logging_level {INTERACTIVE,INFO,DEBUG,WARNING,ERROR,CRITICAL}#

Specify logging config level for GeoIPS commands.

--rebuild_registries {True,False}#

Whether or not you want to rebuild plugin registries if you encounter a failure when retrieving a plugin.

--sector_adjuster <sector_adjuster>#

Specify sector adjuster to be used within processing, located in: <package>.plugins.modules.sector_adjusters. <myadjuster>.<myadjuster>

--sector_adjuster_kwargs <sector_adjuster_kwargs>#

Specify sector_adjuster kwargs that should be used for this sector_adjuster. Should be formatted as a json dictionary string

--window_start_time <window_start_time>#

If specified, only include data between window_start_time and window_end_time. Must be specified with window_end_time. This option will override any default time ranges determined based on potential dynamic sector times. Defaults to None (include all data).

--window_end_time <window_end_time>#

If specified, only include data between window_start_time and window_end_time. Must be specified with window_start_time. This option will override any default time ranges determined based on potential dynamic sector times. Defaults to None (include all data).

--tc_spec_template <tc_spec_template>#

YAML plugin for creating appropriate TC sector using shape/resolution from current storm location.

--trackfiles <trackfiles>#

Specify TC trackfiles to include in processing If –trackfile_sector_list is included, limit to the storms in list If –trackfile_sector_list is not included, process all storms

--trackfile_parser <trackfile_parser>#

Specify TC trackfile parser to use with trackfiles, located in: geoips*.plugins.modules.sector_metadata_generators . myparsername.myparsername, The trackfile_parser string should be the parser module name (no .py)

--trackfile_sector_list <trackfile_sector_list>#

A list of sector names found specified trackfiles to include in processing. Of format: tc2020io01amphan

--tcdb_sector_list <tcdb_sector_list>#

A list of sector names found in tc database to include in processing. Of format: tc2020io01amphan

--tcdb#

Call with –tcdb to include the matching TC database sectors within processing If –tcdb_sector_list is also included, limit the storms to those in list If –tcdb_sector_list is not included, process all matching storms.

--sectored_read#

Call with –sectored_read to specify to sector the data to specified area_defs during reading (ie, do not read all data into memory in advance).

--resampled_read#

Call with –resampled_read to specify to resample the data to specified area_defs during reading (ie, do not read all data into memory in advance). This is required only for some geostationary readers

--self_register_dataset <self_register_dataset>#

Specify to register output data to the dataset specified by self_register_dataset option.

--self_register_source <self_register_source>#

Specify to register output data to the dataset specified by self_register_dataset / self_register_source options.

--reader_defined_area_def#

Call with –reader_defined_area_def to specify to use only area_definition defined within the reader. This option supercedes all other sector-specifying options.

-s <sector_list>, --sector_list <sector_list>#

A list of short sector plugin names found within YAML sectorfiles over which the data file should be processed.

--product_name <product_name>#

Name of product to produce.

--minimum_coverage <minimum_coverage>#

Minimum percent coverage required to produce product. Defaults to 10.

--product_options <product_options>#

Specify product specific options (these must be parsed within the individual product scripts)

--product_spec_override <product_spec_override>#

Specify product spec fields to override the default specifications. Should be formatted as a json dictionary string

--output_file_list_fname <output_file_list_fname>#

Specify full path to a single file to store the complete list of output files produced during the current run

--compare_path <compare_path>#

Specify full path to single directory (with <product> and <output> wildcards) to be used for comparisons for ALL current outputs.

--compare_paths_override <compare_paths_override>#

NOT YET IMPLEMENTED Specify dictionary of full paths to directories (with <product> and <output> wildcards) containing output products to compare with current outputs. This should be formatted as a json dictionary string, with YAML output config output_types as keys, and full directory comparison output path as values. Special key “all” will pertain to all output types.

--filename_formatter <filename_formatter>#

Specify filename format module_name that should be used for this file, where each filename_module_name is ‘myfilemodule’ where: from geoips*.filenames.myfilemodule import myfilemodule would be the appropriate import statement

--filename_formatter_kwargs <filename_formatter_kwargs>#

Specify filename format kwargs that should be used for this filename_formatter. Should be formatted as a json dictionary string

--metadata_filename_formatter <metadata_filename_formatter>#

Specify filename format module_name that should be used for metadata output, where filename_module_name is ‘myfilemodule’ where: geoips.filename_formatters.myfilemodule would be the appropriate entry point

--metadata_filename_formatter_kwargs <metadata_filename_formatter_kwargs>#

Specify filename format kwargs that should be used for this metadata_filename_formatter. Should be formatted as a json dictionary string

--output_formatter <output_formatter>#

Specify output format module_name that should be used for this file, each output_formatter is ‘output_formatters.imagery_annotated’ where from geoips*.output_formatters.imagery_annotated import imagery_annotated would be the appropriate import statement

--output_formatter_kwargs <output_formatter_kwargs>#

Specify output format kwargs that should be used for this output_formatter. should be formatted as a json dictionary string, ie: ‘{“title_formatter”: “tc_copyright”, “title_copyright”: “NRL”}’

--metadata_output_formatter <metadata_output_formatter>#

Specify output format module_name that should be used for metadata output, each output_formatter is ‘myoutputmodule’ where from geoips.output_formatters.myoutputmodule.myoutputmodule would be the appropriate entry point

--metadata_output_formatter_kwargs <metadata_output_formatter_kwargs>#

Specify output format kwargs that should be used for this metadata. Should be formatted as a json dictionary string.

--output_config <output_config>#

Specify YAML config file holding output modile names and their respective filename modules

--no_presectoring#

If true, do not pre-sector data prior to running the algorithm. This is less efficient, but allows the original dataset to be passed to the algorithm in full.

--output_checker_kwargs <output_checker_kwargs>#

Output Checker Keyword Arguments. - These keyword arguments get passed through directly to the outputs_match method on the output_checker plugin. - This should be formatted as a json dictionary string, with the first level being the plugin name that the keyword arguments apply to, and the second level being a dictionary of keyword argument name/value pairs. - Ie, for the “threshold” keyword argument in the “image” output_checker plugin, you would pass: –output_checker_kwargs ‘{“image”: {“threshold”: “0.05”}}’

--reader_name <reader_name>#

If –reader_name is passed, the specific reader will be located in geoips*.readers.myreader_name.myreader_name, The reader_name string should be the reader module name (no .py)

--reader_kwargs <reader_kwargs>#

Specify reader kwargs that should be used for this reader. Should be formatted as a json dictionary string

--bg_product_name <bg_product_name>#

Product to use for background imagery

--bg_reader_name <bg_reader_name>#

If –bg_reader_name is passed, the specific reader will be located in geoips*.readers.myreader_name.myreader_name, The bg_reader_name string should be the reader module name (no .py)

--bg_fnames <bg_fnames>#

Specify filenames to use for background imagery. If –bg_reader_name included, use specific reader for reading background datafiles.

--gridline_annotator <gridline_annotator>#

If –gridline_annotator is passed, the specific gridline params will be located in geoips*.image_utils.plotting_params.gridlines.gridline_annotator, The gridline_annotator string should be the base gridline name (no .yaml)

--feature_annotator <feature_annotator>#

If –feature_annotator is passed, the specific feature annotations will be located in geoips*.plugins.yaml.feature_annotators.<feature_annotator>, The feature_annotator string should be the base feature annotator name (no .yaml)

--model_reader_name <model_reader_name>#

If –model_reader_name is passed, the specific reader will be located in geoips*.readers.my_reader_name.my_reader_name, The model_reader_name string should be the reader module name (no .py)

--model_fnames <model_fnames>#

Specify filenames to use for NWP model data. If –model_reader_name included, use specific reader for reading model datafiles.

--buoy_reader_name <buoy_reader_name>#

If –buoy_reader_name is passed, the specific reader will be located in geoips*.readers.my_reader_name.my_reader_name, The buoyreadername string should be the reader module name (no .py)

--buoy_fnames <buoy_fnames>#

Specify filenames to use for buoy data. If –buoy_reader_name included, use specific reader for reading buoy datafiles.

--aerosol_reader_name <aerosol_reader_name>#

If –model_reader_name is passed, the specific reader will be located in geoips*.readers.my_reader_name.my_reader_name, The model_reader_name string should be the reader module name (no .py)

--aerosol_fnames <aerosol_fnames>#

If –aerosol_reader_name included, use specific reader for reading aerosol model datafiles.

--fuse_files <fuse_files>#

Provide additional files required for fusion product. Files passed under this flag MUST be from the same source. fuse_files may be passed multiple times. Reader name for these files is specified with the fuse_reader flag.

--fuse_reader <fuse_reader>#

Provide the reader name for files passed under the fuse_files flag. Only provide one reader to this flag. If multiple fuse_files flags are passed, the same number of fuse_readers must be passed in the same order.

--fuse_reader_kwargs <fuse_reader_kwargs>#

Provide the reader kwargs for files passed under the fuse_files flag. Should be formatted as a json dictionary string. Only provide one json dict str to this flag. If multiple fuse_files flags are passed, the same number of fuse_reader_kwargs must be passed in the same order.

--fuse_product <fuse_product>#

Provide the product name for files passed under the fuse_files flag. Only provide one product to this flag. If multiple fuse_files flags are passed, the same number of fuse_products must be passed in the same order.

--fuse_resampled_read <fuse_resampled_read>#

Identify whether the reader specified for –fuse_files / –fuse_reader perform a resampled_read. If not specified, a resampled read will NOT be performed. If multiple fuse_files flags are passed, either the same number of fuse_resampled_read flags must be passed in the same order, or no fuse_resampled_read flags can be passed.

--fuse_sectored_read <fuse_sectored_read>#

Identify whether the reader specified for –fuse_files/–fuse_reader perform a sectored_read. If not specified, a sectored_read will NOT be performed. If multiple fuse_files flags are passed, either the same number of fuse_sectored_read flags must be passed in the same order, or no fuse_sectored_read flags can be passed.

--fuse_self_register_dataset <fuse_self_register_dataset>#

Identify the DATASET of the data to which the associated fuse_files should be registerd. If not specified, data will not be registered to a dataset, but the requested area_def. If multiple fuse_files flags are passed, either the same number of fuse_self_register_dataset flags must be passed in the same order, or no fuse_self_register_dataset flags can be passed.

--fuse_self_register_source <fuse_self_register_source>#

Identify the SOURCE of the data to which the associated fuse_files should be registerd If not specified, data will not be registered to a dataset, but the requested. area_def. If multiple fuse_files flags are passed, either the same number of fuse_self_register_source flags must be passed in the same order, or no fuse_self_register_source flags can be passed.

--fuse_self_register_platform <fuse_self_register_platform>#

Identify the SOURCE of the data to which the associated fuse_files should be registerd. If not specified, data will not be registered to a dataset, but the requested area_def. If multiple fuse_files flags are passed, either the same number of fuse_self_register_source flags must be passed in the same order, or no fuse_self_register_source flags can be passed.

--product_db#

Use product database to store product paths created by the procflow

--product_db_writer <product_db_writer>#

If –product_db_writer is passed, the specific product database writer will be located in geoips*.plugins.modules.postgres_database. mywriter_name.mywriter_name, The writer_name string should be the reader module name (no .py)

--product_db_writer_kwargs <product_db_writer_kwargs>#

Provide the product db writer kwargs for the plugin passed under the product_db_writer flag. Should be formatted as a json dictionary string. Only provide one json dict str to this flag.

--product_db_writer_override <product_db_writer_override>#

Specify product database writer that should be used for each available sector should be formatted as a json dictionary string.

--composite_output_kwargs_override <composite_output_kwargs_override>#

Specify product composite kwargs that should be used for each available sector output. Should be formatted as a json dictionary string.

To use, type geoips run <procflow_name> **<procflow_arguments>. data_fusion#

Run the data fusion process workflow. This process workflow is built on top of the native ‘single_source’ procflow with extra arguments. For more information of the arguments available, either run ‘geoips run data_fusion -h’, or view the arguments set up in data_fusion.commandline.args:add_args

usage: To use, type `geoips run data_fusion **<data_fusion_args>`.
-h, --help#

show this help message and exit

To use, type geoips run <procflow_name> **<procflow_arguments>. single_source#

Run the native geoips single source process workflow. For more information of the arguments available, either run ‘geoips run single_source -h’, or view the arguments set up in geoips.commandline.args:add_args

usage: To use, type `geoips run single_source **<single_source_args>`.
filenames#

Fully qualified paths to data files to be processed.

-h, --help#

show this help message and exit

-o <outdir>, --outdir <outdir>#

Path to write output files. Defaults to GEOIPS_OUTDIRS.

-l {INTERACTIVE,INFO,DEBUG,WARNING,ERROR,CRITICAL}, --logging_level {INTERACTIVE,INFO,DEBUG,WARNING,ERROR,CRITICAL}#

Specify logging config level for GeoIPS commands.

--rebuild_registries {True,False}#

Whether or not you want to rebuild plugin registries if you encounter a failure when retrieving a plugin.

--sector_adjuster <sector_adjuster>#

Specify sector adjuster to be used within processing, located in: <package>.plugins.modules.sector_adjusters. <myadjuster>.<myadjuster>

--sector_adjuster_kwargs <sector_adjuster_kwargs>#

Specify sector_adjuster kwargs that should be used for this sector_adjuster. Should be formatted as a json dictionary string

--window_start_time <window_start_time>#

If specified, only include data between window_start_time and window_end_time. Must be specified with window_end_time. This option will override any default time ranges determined based on potential dynamic sector times. Defaults to None (include all data).

--window_end_time <window_end_time>#

If specified, only include data between window_start_time and window_end_time. Must be specified with window_start_time. This option will override any default time ranges determined based on potential dynamic sector times. Defaults to None (include all data).

--tc_spec_template <tc_spec_template>#

YAML plugin for creating appropriate TC sector using shape/resolution from current storm location.

--trackfiles <trackfiles>#

Specify TC trackfiles to include in processing If –trackfile_sector_list is included, limit to the storms in list If –trackfile_sector_list is not included, process all storms

--trackfile_parser <trackfile_parser>#

Specify TC trackfile parser to use with trackfiles, located in: geoips*.plugins.modules.sector_metadata_generators . myparsername.myparsername, The trackfile_parser string should be the parser module name (no .py)

--trackfile_sector_list <trackfile_sector_list>#

A list of sector names found specified trackfiles to include in processing. Of format: tc2020io01amphan

--tcdb_sector_list <tcdb_sector_list>#

A list of sector names found in tc database to include in processing. Of format: tc2020io01amphan

--tcdb#

Call with –tcdb to include the matching TC database sectors within processing If –tcdb_sector_list is also included, limit the storms to those in list If –tcdb_sector_list is not included, process all matching storms.

--sectored_read#

Call with –sectored_read to specify to sector the data to specified area_defs during reading (ie, do not read all data into memory in advance).

--resampled_read#

Call with –resampled_read to specify to resample the data to specified area_defs during reading (ie, do not read all data into memory in advance). This is required only for some geostationary readers

--self_register_dataset <self_register_dataset>#

Specify to register output data to the dataset specified by self_register_dataset option.

--self_register_source <self_register_source>#

Specify to register output data to the dataset specified by self_register_dataset / self_register_source options.

--reader_defined_area_def#

Call with –reader_defined_area_def to specify to use only area_definition defined within the reader. This option supercedes all other sector-specifying options.

-s <sector_list>, --sector_list <sector_list>#

A list of short sector plugin names found within YAML sectorfiles over which the data file should be processed.

--product_name <product_name>#

Name of product to produce.

--minimum_coverage <minimum_coverage>#

Minimum percent coverage required to produce product. Defaults to 10.

--product_options <product_options>#

Specify product specific options (these must be parsed within the individual product scripts)

--product_spec_override <product_spec_override>#

Specify product spec fields to override the default specifications. Should be formatted as a json dictionary string

--output_file_list_fname <output_file_list_fname>#

Specify full path to a single file to store the complete list of output files produced during the current run

--compare_path <compare_path>#

Specify full path to single directory (with <product> and <output> wildcards) to be used for comparisons for ALL current outputs.

--compare_paths_override <compare_paths_override>#

NOT YET IMPLEMENTED Specify dictionary of full paths to directories (with <product> and <output> wildcards) containing output products to compare with current outputs. This should be formatted as a json dictionary string, with YAML output config output_types as keys, and full directory comparison output path as values. Special key “all” will pertain to all output types.

--filename_formatter <filename_formatter>#

Specify filename format module_name that should be used for this file, where each filename_module_name is ‘myfilemodule’ where: from geoips*.filenames.myfilemodule import myfilemodule would be the appropriate import statement

--filename_formatter_kwargs <filename_formatter_kwargs>#

Specify filename format kwargs that should be used for this filename_formatter. Should be formatted as a json dictionary string

--metadata_filename_formatter <metadata_filename_formatter>#

Specify filename format module_name that should be used for metadata output, where filename_module_name is ‘myfilemodule’ where: geoips.filename_formatters.myfilemodule would be the appropriate entry point

--metadata_filename_formatter_kwargs <metadata_filename_formatter_kwargs>#

Specify filename format kwargs that should be used for this metadata_filename_formatter. Should be formatted as a json dictionary string

--output_formatter <output_formatter>#

Specify output format module_name that should be used for this file, each output_formatter is ‘output_formatters.imagery_annotated’ where from geoips*.output_formatters.imagery_annotated import imagery_annotated would be the appropriate import statement

--output_formatter_kwargs <output_formatter_kwargs>#

Specify output format kwargs that should be used for this output_formatter. should be formatted as a json dictionary string, ie: ‘{“title_formatter”: “tc_copyright”, “title_copyright”: “NRL”}’

--metadata_output_formatter <metadata_output_formatter>#

Specify output format module_name that should be used for metadata output, each output_formatter is ‘myoutputmodule’ where from geoips.output_formatters.myoutputmodule.myoutputmodule would be the appropriate entry point

--metadata_output_formatter_kwargs <metadata_output_formatter_kwargs>#

Specify output format kwargs that should be used for this metadata. Should be formatted as a json dictionary string.

--output_config <output_config>#

Specify YAML config file holding output modile names and their respective filename modules

--no_presectoring#

If true, do not pre-sector data prior to running the algorithm. This is less efficient, but allows the original dataset to be passed to the algorithm in full.

--output_checker_kwargs <output_checker_kwargs>#

Output Checker Keyword Arguments. - These keyword arguments get passed through directly to the outputs_match method on the output_checker plugin. - This should be formatted as a json dictionary string, with the first level being the plugin name that the keyword arguments apply to, and the second level being a dictionary of keyword argument name/value pairs. - Ie, for the “threshold” keyword argument in the “image” output_checker plugin, you would pass: –output_checker_kwargs ‘{“image”: {“threshold”: “0.05”}}’

--reader_name <reader_name>#

If –reader_name is passed, the specific reader will be located in geoips*.readers.myreader_name.myreader_name, The reader_name string should be the reader module name (no .py)

--reader_kwargs <reader_kwargs>#

Specify reader kwargs that should be used for this reader. Should be formatted as a json dictionary string

--bg_product_name <bg_product_name>#

Product to use for background imagery

--bg_reader_name <bg_reader_name>#

If –bg_reader_name is passed, the specific reader will be located in geoips*.readers.myreader_name.myreader_name, The bg_reader_name string should be the reader module name (no .py)

--bg_fnames <bg_fnames>#

Specify filenames to use for background imagery. If –bg_reader_name included, use specific reader for reading background datafiles.

--gridline_annotator <gridline_annotator>#

If –gridline_annotator is passed, the specific gridline params will be located in geoips*.image_utils.plotting_params.gridlines.gridline_annotator, The gridline_annotator string should be the base gridline name (no .yaml)

--feature_annotator <feature_annotator>#

If –feature_annotator is passed, the specific feature annotations will be located in geoips*.plugins.yaml.feature_annotators.<feature_annotator>, The feature_annotator string should be the base feature annotator name (no .yaml)

--model_reader_name <model_reader_name>#

If –model_reader_name is passed, the specific reader will be located in geoips*.readers.my_reader_name.my_reader_name, The model_reader_name string should be the reader module name (no .py)

--model_fnames <model_fnames>#

Specify filenames to use for NWP model data. If –model_reader_name included, use specific reader for reading model datafiles.

--buoy_reader_name <buoy_reader_name>#

If –buoy_reader_name is passed, the specific reader will be located in geoips*.readers.my_reader_name.my_reader_name, The buoyreadername string should be the reader module name (no .py)

--buoy_fnames <buoy_fnames>#

Specify filenames to use for buoy data. If –buoy_reader_name included, use specific reader for reading buoy datafiles.

--aerosol_reader_name <aerosol_reader_name>#

If –model_reader_name is passed, the specific reader will be located in geoips*.readers.my_reader_name.my_reader_name, The model_reader_name string should be the reader module name (no .py)

--aerosol_fnames <aerosol_fnames>#

If –aerosol_reader_name included, use specific reader for reading aerosol model datafiles.

--fuse_files <fuse_files>#

Provide additional files required for fusion product. Files passed under this flag MUST be from the same source. fuse_files may be passed multiple times. Reader name for these files is specified with the fuse_reader flag.

--fuse_reader <fuse_reader>#

Provide the reader name for files passed under the fuse_files flag. Only provide one reader to this flag. If multiple fuse_files flags are passed, the same number of fuse_readers must be passed in the same order.

--fuse_reader_kwargs <fuse_reader_kwargs>#

Provide the reader kwargs for files passed under the fuse_files flag. Should be formatted as a json dictionary string. Only provide one json dict str to this flag. If multiple fuse_files flags are passed, the same number of fuse_reader_kwargs must be passed in the same order.

--fuse_product <fuse_product>#

Provide the product name for files passed under the fuse_files flag. Only provide one product to this flag. If multiple fuse_files flags are passed, the same number of fuse_products must be passed in the same order.

--fuse_resampled_read <fuse_resampled_read>#

Identify whether the reader specified for –fuse_files / –fuse_reader perform a resampled_read. If not specified, a resampled read will NOT be performed. If multiple fuse_files flags are passed, either the same number of fuse_resampled_read flags must be passed in the same order, or no fuse_resampled_read flags can be passed.

--fuse_sectored_read <fuse_sectored_read>#

Identify whether the reader specified for –fuse_files/–fuse_reader perform a sectored_read. If not specified, a sectored_read will NOT be performed. If multiple fuse_files flags are passed, either the same number of fuse_sectored_read flags must be passed in the same order, or no fuse_sectored_read flags can be passed.

--fuse_self_register_dataset <fuse_self_register_dataset>#

Identify the DATASET of the data to which the associated fuse_files should be registerd. If not specified, data will not be registered to a dataset, but the requested area_def. If multiple fuse_files flags are passed, either the same number of fuse_self_register_dataset flags must be passed in the same order, or no fuse_self_register_dataset flags can be passed.

--fuse_self_register_source <fuse_self_register_source>#

Identify the SOURCE of the data to which the associated fuse_files should be registerd If not specified, data will not be registered to a dataset, but the requested. area_def. If multiple fuse_files flags are passed, either the same number of fuse_self_register_source flags must be passed in the same order, or no fuse_self_register_source flags can be passed.

--fuse_self_register_platform <fuse_self_register_platform>#

Identify the SOURCE of the data to which the associated fuse_files should be registerd. If not specified, data will not be registered to a dataset, but the requested area_def. If multiple fuse_files flags are passed, either the same number of fuse_self_register_source flags must be passed in the same order, or no fuse_self_register_source flags can be passed.

--product_db#

Use product database to store product paths created by the procflow

--product_db_writer <product_db_writer>#

If –product_db_writer is passed, the specific product database writer will be located in geoips*.plugins.modules.postgres_database. mywriter_name.mywriter_name, The writer_name string should be the reader module name (no .py)

--product_db_writer_kwargs <product_db_writer_kwargs>#

Provide the product db writer kwargs for the plugin passed under the product_db_writer flag. Should be formatted as a json dictionary string. Only provide one json dict str to this flag.

--product_db_writer_override <product_db_writer_override>#

Specify product database writer that should be used for each available sector should be formatted as a json dictionary string.

--composite_output_kwargs_override <composite_output_kwargs_override>#

Specify product composite kwargs that should be used for each available sector output. Should be formatted as a json dictionary string.

geoips test#

Run tests implemented in GeoIPS or a separate GeoIPS Package. This could be running a set of linters on a specific package, running a certain integration or normal test script, or running unit tests. Current options are [“linting”, “script”, “unit-test”].

usage: To use, type `geoips test <cmd> <sub-cmd>`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

To use, type geoips test <cmd> <sub-cmd>. linting#

Run all GeoIPS linters on a specific GeoIPS Package. This will test whether or not the code you wrote adheres to the specified coding conventions set up by GeoIPS. Defaults to the ‘geoips’ package.

usage: To use, type `geoips test linting -p <package_name>`.
-h, --help#

show this help message and exit

--package_name {geoips}, -p {geoips}#

GeoIPS Package that we want to run linting tests on.

To use, type geoips test <cmd> <sub-cmd>. script#

Runs a specific test script (integration-based or normal), found within a certain GeoIPS package. If this is specified as an integration test, this will only work using the ‘geoips’ package. Use ‘–integration’ to specify that the script is integration-based. Defaults to the ‘geoips’ package.

usage: To use, type `geoips test script -p <package_name> <--integration> <script_name>`.
script_name#

GeoIPS Script to be tested

-h, --help#

show this help message and exit

--package_name {geoips}, -p {geoips}#

GeoIPS Package containing the script to be tested

--integration#

Whether or not the script is an integration test.

To use, type geoips test <cmd> <sub-cmd>. sector#

Create a specific sector image from the provided sector plugin name. This is an easy way to test whether or not the sector plugin you’ve created matches the region of the globe you want to study at the correct resolution. Provided this sector plugin has been added to the plugin registry, this command will work.

usage: To use, type `geoips test sector <sector_name> --outdir <output_directory_path>`.
sector_name#

Name of the sector plugin to create an image from.

-h, --help#

show this help message and exit

--outdir <outdir>, -o <outdir>#

The output directory to create your sector image in.

geoips tree#

Print a tree of all of the available GeoIPS CLI commands. This will display every command in a top-down tree which gives a visual structure of how the CLI can be ran. <–max-depth> must be greater than or equal to 0, where depth denotes the level of the command you’d like to display. Ie. <0> geoips <1> list <2> scripts.

usage: To use, type `geoips tree <--max-depth> <int> <--color> <--short-name>`.
-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

--max-depth <max_depth>#

The depth of the command tree to print out.Where depth denotes the level of the command you’d like to display. I.e. <0> geoips <1> list <2> scripts

--color#

Whether or not we want to print the tree in a colored fashion.

--short-name#

Whether or not we want to print the tree as short names or full names. Full names are ‘geoips -> geoips config -> geoips config install’. Short names are ‘geoips -> config -> install’.

geoips validate#

Validate a GeoIPS Plugin found at <file_path>. While this is done under the hood via GeoIPS, this is an easy way to test whether or not the plugin you are developing is valid. If the <file_path> you’re trying to validate is a multi-document YAML file, you’ll also need to provide the name of the plugin within that file for this command to work.

usage: To use, type `geoips validate <file_path> OPT_ARG <plugin_name>`.
file_path#

File path which represents a GeoIPS Plugin that we want to validate.

plugin_name#

The name of the plugin in the file if applicable. Only useful if your file is a multi-document yaml file.

-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

geoips validate#

Validate a GeoIPS Plugin found at <file_path>. While this is done under the hood via GeoIPS, this is an easy way to test whether or not the plugin you are developing is valid. If the <file_path> you’re trying to validate is a multi-document YAML file, you’ll also need to provide the name of the plugin within that file for this command to work.

usage: To use, type `geoips validate <file_path> OPT_ARG <plugin_name>`.
file_path#

File path which represents a GeoIPS Plugin that we want to validate.

plugin_name#

The name of the plugin in the file if applicable. Only useful if your file is a multi-document yaml file.

-h, --help#

show this help message and exit

-log {debug,info,warning,interactive,error,critical}, --log-level {debug,info,warning,interactive,error,critical}#

Log level to output when using the CLI.

Information Retrieval#

The GeoIPS CLI Implements two top-level commands which retrieve information about GeoIPS artifacts based on the sub-commands provided. These two top-level commands are describe (desc) and list (ls). Each command shown below can be ran with a -h flag to provide help instructions for the command you are running.

Describe Command#

geoips describe

describe is a GeoIPS CLI command which retrieves information specific to a single GeoIPS artifact. The purpose of any describe command is to lay out the selected GeoIPS artifact in a verbose manner. While the outputted information may differ by each describe command, the ultimate purpose of each command is to provide both users and developers detailed information about each artifact. This will help implementing their own artifacts, and also clarify what each artifact does / needs to integrate correctly within the GeoIPS environment. It currently implements 4 sub-commands, which we’ll describe below.

geoips describe interface

describe <interface_name> is a describe sub-command which retrieves information specific to a GeoIPS interface. Information included when calling this command is:

  • Absolute Path

  • Docstring

  • Interface

  • Interface Type

  • Supported Families

For an example of how to run this command, see below. Notice the use of aliases in case you want to use these commands in shorthand style. If you want more information about what GeoIPS Interfaces are available, run the command geoips list interfaces.

geoips describe alg
geoips describe algs
geoips describe algorithm
geoips describe algorithms
geoips describe <interface_name>

geoips describe family

describe <interface_name> family <family_name> (or fam) is a describe sub-command which retrieves information specific to an interface’s family. Information included when calling this command is:

  • Docstring

  • Family Name

  • Family Path

  • Interface Name

  • Interface Type

  • Required Args / Schema

For an example of how to run this command, see below. Notice the use of aliases in case you want to use these commands in shorthand style. If you want more information about what families belong to a certain interface, run the command geoips list interfaces, which will include a column representing the supported families of each interface. You can also run geoips list interfaces --columns interface supported_families for a concise depiction of what families belong to each interface.

geoips describe alg fam single_channel
geoips describe algs fam single_channel
geoips describe algorithm family single_channel
geoips describe algorithms family single_channel
geoips describe prod-def fam interpolator_algorithm_colormapper
geoips describe prod-defs fam interpolator_algorithm_colormapper
geoips describe product_default family interpolator_algorithm_colormapper
geoips describe product_defaults family interpolator_algorithm_colormapper
geoips describe <interface_name> family <family_name>

geoips describe package

describe package <package_name> (or describe pkg <package_name>) is a describe sub-command which retrieves information specific to a GeoIPS Package. Information included when calling this command is:

  • Docstring

  • GeoIPS Package

  • Package Path

  • Source Code

  • Version Number

For an example of how to run this command, see below. Notice the use of aliases in case you want to use these commands in shorthand style. If you want more information about what GeoIPS Packages are available, run the command geoips list packages.

geoips describe pkg geoips
geoips describe package geoips
geoips describe package <package_name>

geoips describe plugin

describe <interface_name> <plugin_name> is a describe sub-command which retrieves information specific to a GeoIPS Plugin. Information included when calling this command is:

  • Docstring

  • Family

  • Interface

  • GeoIPS Package

  • Plugin Type

  • Product Defaults (if applicable)

  • Relative Path

  • Signature (if applicable)

  • Source Names (if applicable)

For an example of how to run this command, see below. Notice the use of aliases in case you want to use these commands in shorthand style. If you want more information about what plugins are available, run the command geoips list plugins. Note, if you are trying to describe a product, the plugin name is a combination of it’s source name and product name. I.e. for the product Infrared coming from source abi, the command call would look like geoips describe product abi.Infrared.

geoips describe alg single_channel
geoips describe algs single_channel
geoips describe algorithm single_channel
geoips describe algorithms single_channel
geoips describe <interface_name> <plugin_name>

List Command#

geoips list

list is a GeoIPS CLI command which retrieves a general set of information specific to a GeoIPS artifact type. While the outputted information may differ by each list command, the ultimate purpose of each command is to provide both users and developers a listing of what artifacts exist, where they can be found, and a general description of what the artifact does. This will help users and developers gain a sense of what’s, available, where it can be found, and what has been implemented across the GeoIPS environment. It currently implements 7 sub-commands, which we’ll describe below. For any list command, there are three shared arguments: --long/-l, --columns/-c, and --package_name/-p. You can apply any of these optional arguments to any geoips list command to specialize the output of the list command. All list commands default to a --long listing. If you only wanted specific columns to be outputted for a geoips list packages command, you could run it like this.

geoips ls pkgs --columns package docstring version
geoips list pkgs --columns package docstring version
geoips list packages --columns package docstring version

The command above would list all GeoIPS Plugin Packages with information including their package name, docstring, and current version number. For a listing of what columns you can filter by, run geoips list <cmd_name> --columns help.

geoips list interface

list <interface_name> is a list sub-command which retrieves a listing of implemented

plugins of a certain interface. This can also be applied to a certain GeoIPS package. Information included when calling this command is:

  • GeoIPS Package

  • Interface Name

  • Interface Type

  • Family

  • Plugin Name

  • Source Names (if applicable)

  • Relative Path

For an example of how to run this command, see below, one of which applies this command to a specific package. Notice the use of aliases in case you want to use these commands in shorthand style. To see which packages are available, run geoips list packages.

geoips ls alg
geoips ls algs
geoips list algorithm
geoips list algorithms
geoips list <interface_name> -p <package_name>

geoips list interfaces

list interfaces is a list sub-command which retrieves a listing of GeoIPS interfaces. This command has two modes; implemented and general. Implemented mode searches for plugins of each interface which have been created throughout GeoIPS packages, or a certain package. General mode retrieves a listing of native GeoIPS Interfaces, which users can then create their own plugins using those interfaces. General Mode cannot be package specific. Information included when calling this command in implemented mode is:

  • GeoIPS Package

  • Interface Type

  • Interface Name

Information included when calling this command in general mode is:

  • GeoIPS Package

  • Interface Type

  • Interface Name

  • Supported Families

  • Docstring

  • Absolute Path

For an example of how to run both modes of this command, see below.

Implemented Mode Options

geoips list interfaces -i
geoips list interfaces -i -p <package_name>
geoips list interfaces -p <package_name>

General Mode

geoips list interfaces

geoips list packages

list packages (or list pkgs) is a list sub-command which retrieves a listing of GeoIPS Packages, alongside the information shown below.

  • GeoIPS Package

  • Docstring

  • Package Path

  • Version Number

For an example of how to run this command, see below. Notice the use of aliases in case you want to use these commands in shorthand style.

geoips ls pkgs
geoips list packages

geoips list plugins

list plugins (or list plgs) is a list sub-command which retrieves a listing of plugins found within all, or a certain GeoIPS package. Information included when calling this command is:

  • GeoIPS Package

  • Interface Name

  • Interface Type

  • Family

  • Plugin Name

  • Source Names

  • Relative Path

For an example of how to run this command, see below. Notice the use of aliases in case you want to use these commands in shorthand style. One of the commands below lists plugins from a certain GeoIPS package.

geoips ls plgs
geoips list plgs
geoips ls plugins
geoips list plugins -p <package_name>

geoips list scripts

list scripts is a list sub-command which retrieves a listing of test scripts from all, or a certain GeoIPS Package. For this command to find your test script, you must place the script under <package_name>/tests/scripts/. These test scripts can then be ran using geoips run <package_name> <script_name>. This command can only be ran if the specified plugin package(s) are installed in editable mode. Information included when calling this command is:

  • GeoIPS Package

  • Filename

For an example of how to run this command, see below. Notice the use of aliases in case you want to use these commands in shorthand style. One of the commands below lists test scripts from a certain GeoIPS package.

geoips ls scripts
geoips list scripts
geoips list scripts -p <package_name>

geoips list source-names

list source-names is a list sub-command which retrieves a listing of source_names from all, or a certain GeoIPS Package. For this command to find a listing of source_names, you must add a module-level source_names attribute to your reader plugin. Every core GeoIPS reader plugin has this attribute set. We recommend following the same method of implementation as core GeoIPS readers, as reader plugins without this attribute will be deprecated when GeoIPS v2.0.0 is released. Information included when calling this command is:

  • Source Name

  • Reader Names

For an example of how to run this command, see below. Notice the use of aliases in case you want to use these commands in shorthand style. One of the commands below lists source_names from a certain GeoIPS package.

geoips ls source-names
geoips ls src-names
geoips list source-names
geoips list source-names -p <package_name>

geoips list test-datasets

list test-datasets is a list sub-command which retrieves a listing of test datasets used for testing GeoIPS processing workflows. Currently, we rely on the test-datasets shown below to properly test GeoIPS.

List of test-datasets needed for testing GeoIPS:

  • test_data_amsr2

  • test_data_clavrx

  • test_data_fusion

  • test_data_gpm

  • test_data_noaa_aws

  • test_data_sar

  • test_data_scat

  • test_data_smap

  • test_data_viirs

Information included when calling this command is:

  • Data Host

  • Dataset Name

For an example of how to run this command, see below. Notice the use of aliases in case you want to use these commands in shorthand style.

geoips ls test-datasets
geoips list test-datasets

geoips list unit-tests

list unit-tests is a list sub-command which retrieves a listing of unit tests from all, or a certain GeoIPS Package. For this command to find your unit tets, you must place the unit tests under <package_name>/tests/unit_tests/. These test scripts can then be ran using pytest -v /path/to/<package_name/tests/unit_tests/<unit_test_dir>. This command can only be ran if the specified plugin package(s) are installed in editable mode. Information included when calling this command is:

  • GeoIPS Package

  • Unit Test Directory

  • Unit Test Name

For an example of how to run this command, see below. Notice the use of aliases in case you want to use these commands in shorthand style. One of the commands below lists unit tests from a certain GeoIPS package.

geoips ls unit-tests
geoips list unit-tests -p <package_name>

Performing Processes#

The other use case of the GeoIPS CLI is for performing GeoIPS processes. We currently implement 4 commands which perform some sort of process. This includes plugin validation, executing test scripts, installing test datasets used by GeoIPS, and running a processing workflow as run_procflow previously did. The latter is the most significant change as we’ve rerouted all run_procflow & data_fusion_procflow commands to be sent through the GeoIPS CLI. While the GeoIPS CLI does not actually change the implementation of how procflows were ran, this makes all procflow calls be easily integrated as a CLI process.

Shown below are 4 types of GeoIPS Commands which will invoke processes related to the command provided.

Config Command#

geoips config

Currently, GeoIPS relies on test datasets to perform testing on the processing workflows which we’ve created. These test datasets are installed via a bash script before any testing can be done. To make this process easier and more configurable, we’ve implemented a geoips config (or geoips cfg) command, which encapsulates configuration settings that we can implement via the CLI.

We currently only implement the geoips config install <test_dataset_name> command for installing test datasets, though we’ll support other config commands as we continue to develop the GeoIPS CLI.

geoips config install

config install installs test datasets hosted on CIRA’s NextCloud instance for testing implemented processing workflows. For a listing of test datasets available for installation, run this command geoips list test-datasets.

To install a specific test dataset, run the command below.

geoips cfg install test_data_clavrx
geoips config install test_data_clavrx
geoips config install <test_dataset_name>

Run Command#

geoips run

geoips run single source

geoips run config_based

geoips run data fusion

Currently, GeoIPS creates all outputs defined by products via a processing workflow (procflow). These processing workflows are written as a bash script, which tells GeoIPS what plugins will be used and how they will be processed. While this works for the time being, we are largely refactoring the way in which outputs will be produced by using an order-based procflow. We eventually want to specify the order in which a procflow executes using a steps attribute in your product / product_defaults.

run does exactly what run_procflow and data_fusion_procflow currently do. To preserve test scripts that were written prior to this PR, we’ve implemented a legacy run format which will process your test scripts the exact same manner in which run_procflow or data_fusion_procflow did in the past. While these commands won’t point to the same entrypoint as they did before, they make use of the GeoIPS CLI to call geoips run which will execute the same functionality as it did before.

run follows the procflow defined by a bash script and produces the same output of such bash script if it were ran ./<script_name>. While you technically can execute a run command directly in the commandline, we heavily suggest creating a bash script for testing and reusability’s sake. We’ve overwritten all geoips and data_fusion test scripts to make use of the new CLI procflow functionality. Shown below, are the differences between executing a legacy procflow and the new CLI-based procflows. While both work and execute the same process, we recommend transitioning your scripts to the CLI-based method as we may remove support for legacy formats in the future.

Legacy Procflow (abi.static.Infrared.imagery_annotated.sh)

run_procflow $GEOIPS_TESTDATA_DIR/test_data_noaa_aws/data/goes16/20200918/1950/* \
    --procflow single_source \
    --reader_name abi_netcdf \
    --product_name Infrared \
    --compare_path "$GEOIPS_PACKAGES_DIR/geoips/tests/outputs/abi.static.<product>.imagery_annotated" \
    --output_formatter imagery_annotated \
    --filename_formatter geoips_fname \
    --resampled_read \
    --logging_level info \
    --sector_list goes_east
retval=$?

exit $retval

New CLI-based Procflow (abi.static.Infrared.imagery_annotated.sh)

geoips run single_source $GEOIPS_TESTDATA_DIR/test_data_noaa_aws/data/goes16/20200918/1950/* \
    --reader_name abi_netcdf \
    --product_name Infrared \
    --compare_path "$GEOIPS_PACKAGES_DIR/geoips/tests/outputs/abi.static.<product>.imagery_annotated" \
    --output_formatter imagery_annotated \
    --filename_formatter geoips_fname \
    --resampled_read \
    --logging_level info \
    --sector_list goes_east
retval=$?

exit $retval

As you can see, the only difference between the two formats is the first line and the --procflow line. With the new CLI-based format, all you need to do is replace run_procflow / data_fusion_procflow with geoips run <procflow_name> and remove the --procflow line. That’s it!

To execute the run command, just run a bash script via ./path/to/script.sh.

Test Command#

geoips test

GeoIPS, and other GeoIPS packages currently implement tests to ensure that they integrate together correctly, and that they each operate correctly at an atomic level. While more tests are needed to ensure that every piece of GeoIPS is working fine, we are able to get a general sense as to whether or not things are working or are broken, and where / why that is happening.

These tests are a very useful feature, however are not that easy to run in the current status of our codebase. To alleviate that issue, we’ve created a geoips test command which can execute linting, and output / integration test scripts. Together, these testing protocols ensure that our environment is working as expected.

Shown below, we’ll demonstrate how to test each of these protocols so that the user can easily ensure that what they’re developing is working as expected. We recommend trying to develop in a test-driven-development (TDD) manner, so that you can check that your code is working as you develop it on the fly.

geoips test linting

linting runs the main three linters that are supported by the main GeoIPS package. Those three linters are bandit, black, and flake8. We may support more linters in the future, but as this documentation was written, those are the three in which we currently support.

To test that your code adheres to GeoIPS Linting protocols, run the command below.

geoips test linting (defaults to 'geoips' package)
geoips test linting -p <package_name>

geoips test sector

sector produces a .png image based on the provided sector plugin name. This sector must be an entry within any Plugin Package’s registered_plugins.(yaml/json) file. Once, you’ve created a new sector plugin, make sure to run create_plugin_registries to get this sector added to your registry. Once added, you can run this command to produce an image of your sector to easily test whether or not it captures the region you expected and if the resolution of that sector is correct.

To produce a sector image is quite simple. All you have to do is:

  • geoips test sector <sector_name>

An additional output directory can be specified if you want the sector image to be saved in a different location.

  • geoips test sector <sector_name> --outdir <output_directory_path>

For example, if you were to run geoips test sector canada, the following image would be created at $GEOIPS_OUTDIRS/canada.png.

../../../_images/canada.png

geoips test script

script executes an output-based test script which will return a numerical value based on the output of the test. A 0 is a success, and any other number will denote what failed and why that occurred. The script command can also execute integration tests (which are only supported in the ‘geoips’ package). These sorts of tests ensure that all new functionality of the main GeoIPS code integrate correctly and accurately.

To run a test (bash) script, or run your integration tests, you must first place your integration / normal test scripts in the following file locations.

  • Output Test scripts: <package_name>/tests/scripts/<script_name>

  • Integration Tests: <package_name>/tests/integration_tests/<script_name>

Once you’ve created your script in the appropriate location, follow the command below.

geoips test script <script_name> (defaults to 'geoips' package)
geoips test script -p <package_name> <script_name>
geoips test script --integration <script_name> (no '-p' as this is only supported for 'geoips' package)

Tree Command#

geoips tree

The GeoIPS CLI provides a variety of commands which aren’t necessarily easily exposed via geoips -h. To improve this issue, we’ve added a geoips tree command which exposes all GeoIPS CLI commands in a tree-like fashion. This way, we can expose all commands that are available via the GeoIPS CLI, and expose the depth in which these commands exist.

By displaying the commands in a depthwise structure, users can understand what commands are available and how they are called.

If you just call geoips tree, you’ll get the full command tree in a non-colored, verbose output.

The output of running geoips tree is shown below.

geoips tree

geoips
    geoips config
        geoips config install
    geoips describe
        geoips describe algorithms
        geoips describe colormappers
        geoips describe coverage-checkers
        geoips describe feature-annotators
        geoips describe filename-formatters
        geoips describe gridline-annotators
        geoips describe interpolators
        geoips describe output-checkers
        geoips describe output-formatters
        geoips describe procflows
        geoips describe product-defaults
        geoips describe products
        geoips describe readers
        geoips describe sector-adjusters
        geoips describe sector-metadata-generators
        geoips describe sector-spec-generators
        geoips describe sectors
        geoips describe title-formatters
        geoips describe package
    geoips list
        geoips list algorithms
        geoips list colormappers
        geoips list coverage-checkers
        geoips list feature-annotators
        geoips list filename-formatters
        geoips list gridline-annotators
        geoips list interpolators
        geoips list output-checkers
        geoips list output-formatters
        geoips list procflows
        geoips list product-defaults
        geoips list products
        geoips list readers
        geoips list sector-adjusters
        geoips list sector-metadata-generators
        geoips list sector-spec-generators
        geoips list sectors
        geoips list title-formatters
        geoips list interfaces
        geoips list packages
        geoips list plugins
        geoips list scripts
        geoips list test-datasets
        geoips list unit-tests
    geoips run
        geoips run single_source
        geoips run data_fusion
        geoips run config_based
    geoips test
        geoips test linting
        geoips test script
        geoips test sector
    geoips tree
    geoips validate

geoips tree additionaly provides optional arguments to filter the output of this command. Shown below are these optional arguments and descriptions of what each argument does.

  • --color

    • The output of geoips tree might be a little hard to interpret. If you want the output of geoips tree to be highlighted by depth, make sure to use the --color flag. (Defaults to False)

  • --max-depth

    • How many levels of the tree we’d like to expose. Defaults to two levels, which is shown above.

  • --short-name

    • The output of geoips tree provides the full command string at each level. If you just want the literal command name and every level, make sure to provide this flag. (Defaults to False)

Validate Command#

geoips validate

GeoIPS runs off of plugins. While you can search the documentation and/or schemas defined for these plugins, this is not an easy way of telling whether or not the plugin you’ve created adheres to the GeoIPS protocols defined for each plugin. Every GeoIPS interface implements validation functionality for ensuring that the plugins that inherit from such interface work correctly. We make use of this validation functionality from the command line, so users can easily check whether or not the plugin they’ve created is valid.

validate (or val) follows the interface defined validation-protocol for a certain plugin. To get a listing of plugins available for validation, run the command geoips list plugins -p <package_name>, where -p is an optional flag representing the package we want to list plugins from.

To validate a plugin we will need the full path to the plugin you want validated. See an example of this shown below. Notice the use of aliases in case you want to use these commands in shorthand style.

geoips val /full/path/to/geoips/geoips/plugins/yaml/products/abi.yaml
geoips validate /full/path/to/geoips/geoips/plugins/yaml/products/abi.yaml
geoips validate /full/path/to/<pkg_name>/<pkg_name>/plugins/<plugin_type>/<interface>/plugin.<ext>