GeoWatch Util / API

The source code for geowatchutil is broken out into runtime, factory, and class functions.

See below for a quick explanation.

Runtime

Most public API functions are contained in geowatchutil.runtime. Runtime functions wrap broker, consumer, producer, and store functions with exception handling and multiple tries.

In most use cases, you should use geowatchutil.runtime rather than factory functions and certainly more than directly initializing a class.

Note

Unless for custom subclasses, you can describe your information flow as dicts, so that you only ever need to call geowatchutil.runtime.provision_brokers().

Functions

The 4 main runtime functions are:

1. geowatchutil.runtime.provision_brokers()
2. geowatchutil.runtime.provision_consumer()
3. geowatchutil.runtime.provision_producer()
4. geowatchutil.runtime.provision_store()

Factory

Factory functions provide a single entry point for creating a broker, consumer, and producer, store, and codec, respectively.

Functions

The 5 main factory functions are:

1. geowatchutil.broker.factory.build_broker()
2. geowatchutil.consumer.factory.build_consumer()
3. geowatchutil.producer.factory.build_producer()
4. geowatchutil.store.factory.build_store()
5. geowatchutil.codec.factory.build_codec()

Modules

View all modules @ code.

Note

See GeoWatch in action on the examples page.