Skip to content

kalisio/k-openradiation

Repository files navigation

k-openradiation

Latest Release CI Quality Gate Status Maintainability Issues License: MIT

A Krawler based service to download data from the OpenRadiation project.

Description

The k-openradiation job allow to scrape measurements from the OpenRadiation API. The downloaded data are stored within a MongoDB database and more precisely in a collection named openradiation.

All records are stored in GeoJson format.

The job is executed according a specific cron expression. By default, every hours.

Configuration

Variable Description
KEY The key to use the API. As mentioned here, you should ask this access code to the OpenRadiation team.
DB_URL The mongoDB database URL. The default value is mongodb://127.0.0.1:27017/openradiation
COLLECTION The mongoDB database collection. The default value is openradiation
DATE_OF_CREATION Force the date of measurements to be retrieved. Undefined by default so that the current date will be used.
TTL The measurements data time to live. It must be expressed in seconds and the default value is 604 800 (7 days)
DEBUG Enables debug output. Set it to krawler* to enable full output. By default it is undefined.

Deployment

We personally use Kargo to deploy the service.

Contributing

Please refer to contribution section for more details.

License

Licensed under the MIT license.

Copyright (c) 2017-20xx Kalisio

Kalisio

About

A Krawler based service to download data from the OpenRadiation project.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors