fuelpricesgr

KO | EN

gitlite — search

#php #c-plus-plus #javascript #python #ruby #c-sharp #r #html #machine-learning #statistics #jquery #hacktoberfest

★ 23 Open GitHub ↗

Database of fuel prices in Greece

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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 [uv](https://docs.astral.sh/uv/) for dependency management. In order to install uv, you need to run:

```shell
curl -LsSf https://astral.sh/uv/install.sh | sh
```

If you don't have the required Python version install, you need to run

```shell
uv python install `cat .python-version`
```

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

```
uv run python -m fuelpricesgr.commands.import
```

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

```
uv run python -m fuelpricesgr.commands.import --help
```

Now you can launch the API by running the command:

```
uv run uvicorn fuelpricesgr.main:app
```

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

## Running the administration interface

An administration interface is provided for the application data, but only if SQLAlchemy is used to manage the
application data. Before using it, an administrator user must be created. You can create it by running the following
command:

```
uv run python -m fuelpricesgr.commands.createuser --admin <user_email>
```

The command will ask you for a password for the user. After successful creation, you can log in to the administration
interface at http://localhost:8000/admin and manage the data.

## 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

```
uv run pytest
```

In order to get the test coverage report, run

```
uv run coverage run -m pytest .
```

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

In order to get a pylint report, run

```
uv run pylint fuelpricesgr
```

fuelpricesgr

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README