cityiq.cli package

Submodules

cityiq.cli.config module

cityiq.cli.config.main(args)

Main entry point allowing external calls

Parameters

args ([str]) – command line parameter list

cityiq.cli.config.make_parser()

Create or print the cityiq module configuration.

You can create a new configuration file with the -w option or print the configuration with -p

cityiq.cli.config.run()

Entry point for console_scripts

cityiq.cli.events module

The ciq_events program is used to scrape and process events.

class cityiq.cli.events.ProgressBar(*args, **kwargs)

Bases: progress.bar.ShadyBar

property downloaded

property extant

update_task(task)

cityiq.cli.events.main(args)

cityiq.cli.events.make_parser()

Download events and load them into the cache.

The ciq_events program will request events from a CityIQ system, one day at a tim, and cache the results. It will request the events from assets, based on which assets have eventTypes with the requested events.

Because the program will request events for all of the assets that report an event type and makes one request per day, it can generate very large numbers of requests and take many hours to run. For instance this request:

ciq_events -s 2020-01-01 -e 2020-06-01-01 PKIN PKOUT

generates about 800,000 requests and will take a day to run.

The cityiq module will not cache event requests for the current day or any day in the future.

cityiq.cli.events.run()

Entry point for console_scripts

cityiq.cli.events.setup_logging(loglevel)

Setup basic logging

Parameters

loglevel (int) – minimum loglevel for emitting messages

cityiq.cli.nodes module

cityiq.cli.nodes.main(args)

Main entry point allowing external calls

Parameters

args ([str]) – command line parameter list

cityiq.cli.nodes.make_parser()

Get assets and locations for a CityIQ system

cityiq.cli.nodes.run()

Entry point for console_scripts

cityiq.cli.nodes.setup_logging(loglevel)

Setup basic logging

Parameters

loglevel (int) – minimum loglevel for emitting messages

cityiq.cli.util module

cityiq.cli.util.group_to_events(group)

cityiq.cli.util.group_to_locations(c, group)

Module contents