README.md

CC Backend Library

This library contains several classes and data models that are useful when writing services that interact with other services in Conflict Cartographer. In particular, the modules api_client and schema respectively provide classes for retrieving and modelling data from APIs.

Data retrieval

Data retrieval is offered via the cc_backend_lib.dal.Dal class. This class is instantiated by passing several API clients:

from cc_backend_lib.clients import predictions_client, scheduler_client, users_client, countries_client
from cc_backend_lib import dal

cc_dal = dal.Dal(
      predictions = predictions_client.PredictionsClient(...),
      scheduler = scheduler_client.SchedulerClient(...),
      users = users_client.UsersClient(...),
      countries = countries_client.CountriesClient(...),
   )

The class has several methods that offer access to data and summaries. See help(Dal). The .participation_summary method caches results for past (shift < 0) time-periods for efficiency.

Caching

A powerful caching decorator is provided that lets you decorate both sync and async functions for caching. For using different kinds of backends or for other kinds of customization (LRU, etc.), the caching decorator lets you pass a custom cache class. There are some provided cache classes, including one that uses Redis:

from cc_backend_lib.cache import redis_cache, cache

@cache.cache(redis_cache.RedisBackend, host = "...", expiry_time = 100)
def my_slow_function(a,b,c):
   ...

# First time slow
a = my_slow_function(1,2,3)

# Second time fast
b = my_slow_function(1,2,3)

assert a == b