https://github.com/mavroprovato/fuelpricesgr

Database of fuel prices in Greece
https://github.com/mavroprovato/fuelpricesgr

fastapi javascript npm poetry python sqlalchemy sqlite webpack

Last synced: 2 months ago
JSON representation

Database of fuel prices in Greece

• Host: GitHub
• URL: https://github.com/mavroprovato/fuelpricesgr
• Owner: mavroprovato
• License: mit
• Created: 2022-07-29T22:06:42.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-03T19:45:43.000Z (3 months ago)
• Last Synced: 2024-10-13T00:59:03.748Z (3 months ago)
• Topics: fastapi, javascript, npm, poetry, python, sqlalchemy, sqlite, webpack
• Language: Python
• Homepage:
• Size: 1.01 MB
• Stars: 14
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fuel Prices

The purpose of this project is to create a database of fuel prices in Greece. Daily and weekly data about fuel prices

are regularly uploaded at the [Παρατηρητήριο Τιμών Υγρών Καυσίμων](http://www.fuelprices.gr) website by the Greek

Government, but the data are published as PDF files. In order to process the data more easily, this project fetches

those PDF files, extracts the data from them, inserts them in a database, and exposes them in an API.

Data are available since:

* 2012-04-27 for weekly country data

* 2012-05-04 for weekly prefecture data

* 2017-08-28 for daily country data

* 2017-03-14 for daily prefecture data

## Running the API

The backend API is a [Python](https://www.python.org) based project, built with [FastAPI](https://fastapi.tiangolo.com),

that uses [Poetry](https://python-poetry.org) for dependency management. In order to install the dependencies, you need

to run:

```

poetry install

```

The data are stored in an [SQLite](https://www.sqlite.org) database. In order to fetch the data you need to run:

```

python -m fuelpricesgr.commands.import

```

This command accepts various parameters to limit the data to be fetched. You can see them by running

```

python -m fuelpricesgr.commands.import --help

```

Now you can launch the API by running the command:

```

uvicorn fuelpricesgr.main:app

```

The API is now available at http://localhost:8000. The documentation for the API is available at

http://localhost:8000/docs.

## Running with docker

In order to build the Docker image run

```

docker build -t mavroprovato/fuelpricesgr .

```

In order to run the docker image run

```

docker run -p 8000:8000 mavroprovato/fuelpricesgr

```

## Development

In order to run the application tests, run

```

pytest

```

In order to get the test coverage report, run

```

coverage run -m pytest .

```

This will generate an HTML coverage report in `htmlcov/index.html`

In order to get a pylint report, run

```

pylint fuelpricesgr

```