⚠️ This project is being replaced by ecoindex_python_fullstack and will be archived soon. Please refer to the new project for any contribution or issue. ⚠️

This tool provides an easy way to analyze websites with Ecoindex on a remote server. You have the ability to:

• Make a page analysis
• Define screen resolution
• Save results to a DB
• Retrieve results
• Limit the number of request per day for a given host

This API is built on top of ecoindex-scraper with FastAPI and Celery

The API specification can be found in the documentation. You can also access it with Redoc.

• Docker
• Docker-compose v2

With this docker setup you get 6 services running that are enough to make it all work:

• db: A MySQL instance
• api: The API instance running FastAPI application
• worker: The celery task worker that runs ecoindex analysis
• redis (optional): The redis instance that is used by the Celery worker
• flower (optional): The Celery monitoring interface
• db-backup (optional): A useful utility that can handle automaticaly database backup

cp docker-compose.yml.dist docker-compose.yml && \
docker  compose up -d --build

Then you can go to:

• http://localhost:8001/docs to access to the swagger of the API
• http://localhost:5555 to access the flower interface (Celery task queue UI)

To upgrade your server version, you have to:

1. Checkout the source version you want to deploy
2. Re-build the server
3. Re-start the server

git pull && \
docker compose up -d --build

We use Alembic to handle database migrations. Migrations are automaticaly played at instance startup

Here are the environment variables you can configure:

You can use docker-compose.override.yml to override the default configuration of the docker-compose.yml file. For example, you can use it to mount your local code in the container and run the server in debug mode.

cp docker-compose.override.yml.dist docker-compose.override.yml

Then you can run the server:

docker-compose up -d --build

We use Pytest to run unit tests for this project. The test suite are in the tests folder. Just execute :

poetry run pytest --cov-report term-missing:skip-covered --cov=. --cov-config=.coveragerc tests

This runs pytest and also generate a coverage report (terminal and html)

The LCA values used by ecoindex_api to evaluate environmental impacts are not under free license - ©Frédéric Bordage Please also refer to the mentions provided in the code files for specifics on the IP regime.