fuelprices/README.md

63 lines
2.3 KiB
Markdown
Raw Normal View History

2019-06-06 12:18:48 +02:00
# fuelprices
2019-07-24 09:43:59 +02:00
## Summary
2019-07-24 00:34:41 +02:00
weather is a small program that fetch weather informations, and store them to influxdb
2019-06-06 12:18:48 +02:00
## Usage
2019-07-24 09:43:59 +02:00
fuelprices is a small tool designed to fetch fuel prices from France open data and send them to influxdb
2019-07-24 09:46:37 +02:00
## Howto
### Build
2019-06-06 12:18:48 +02:00
2019-06-06 12:22:20 +02:00
```shell
2019-09-16 18:36:27 +02:00
go build -mod=vendor
2019-06-06 12:22:20 +02:00
```
2019-06-06 12:18:48 +02:00
2019-07-24 09:48:34 +02:00
### Sample config in fuelprices.ini
2019-06-06 12:18:48 +02:00
2019-06-06 12:22:20 +02:00
```ini
2019-06-06 12:18:48 +02:00
[fuelprices]
# Remote URLs, filenames, xpath base for values
remote_url=https://donnees.roulez-eco.fr/opendata/instantane
remote_filename=PrixCarburants_instantane.xml
xpath_base=.//pdv[@id='%s']/prix[@nom='%s']
# Comma separated values for pos and types
pos=50000007
types=Gazole,SP95,SP98
2019-07-20 14:49:22 +02:00
[influxdb]
2019-09-08 12:35:55 +02:00
# InfluxDB settings
url=http://influxdb:8086/
2019-07-24 00:34:41 +02:00
username=influxdb
2019-07-20 14:49:22 +02:00
password=password
2019-07-24 00:34:41 +02:00
database=database
2019-06-06 12:18:48 +02:00
```
2019-07-24 09:48:34 +02:00
### Run
```shell
./fuelprices -configfile fuelprices.ini
```
2019-12-30 23:47:57 +01:00
### Todo
- Add tests
2019-06-06 12:18:48 +02:00
## License
2019-06-06 12:20:09 +02:00
```text
2019-12-30 23:47:57 +01:00
Copyright (c) 2019 PaulBSD
2019-06-06 12:18:48 +02:00
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
2019-12-30 23:47:57 +01:00
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the fuelprices project.
2019-06-06 12:18:48 +02:00
```