Skip to content

dp3.bin.shcmd.entities

Entity catalog commands for the shell-oriented DP3 CLI.

handle_entities 

handle_entities(client, _args) -> int

Return the full entity-type map exposed by the API.

Source code in dp3/bin/shcmd/entities.py 
7
8
9
def handle_entities(client, _args) -> int:
    """Return the full entity-type map exposed by the API."""
    return print_response_json(client.request("GET", "/entities"))

register_parser 

register_parser(commands) -> None

Register entity catalog commands on the root parser.

Source code in dp3/bin/shcmd/entities.py 
12
13
14
15
16
17
18
19
20
21
22
23
def register_parser(commands) -> None:
    """Register entity catalog commands on the root parser."""
    entities_parser = commands.add_parser(
        "entities",
        help="Return the full entity-type map exposed by the API.",
        description=(
            "Return the full entity-type map exposed by the API. To print only entity "
            "type names, use 'dp3 sh entities | jq keys' or '<APPNAME>sh entities | jq "
            "keys'."
        ),
    )
    entities_parser.set_defaults(handler=handle_entities)