f22j / amadeus-flight-price-analysis-django

Returns if the cheapest available flight is a good deal

Flight Search and AI APIs showcase

What is this?

This prototype retrieves flight offers using the Flight Offers Search API for a given itinerary. Then it displays if the cheapest available flight is a good deal based on the Flight Price Analysis API. We finally predict if the trip is for business or leisure using the Trip Purpose Prediction API.

You can also directly view the demo of the prototype and refer to the blog article as well.

How to run the project via Docker (recommended)

Build the image from the Dockerfile. The following command will

make

The container receives your API key/secret from the environment variables. Before running the container, make sure your have your credentials correctly set:

export AMADEUS_CLIENT_ID=YOUR_API_KEY
export AMADEUS_CLIENT_SECRET=YOUR_API_SECRET
export DEBUG_VALUE="True"

Finally, start the container from the image:

make run

At this point you can open a browser and go to https://0.0.0.0:8000.

Note that it is also possible to run in detached mode so your terminal is still usable:

make start

Stop the container with:

make stop

How to run the project locally

Clone the repository.

git clone https://github.com/amadeus4dev/amadeus-flight-price-analysis-django.git
cd flight-price-analysis

Next create a virtual environment and install the dependencies.

virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

For authentication add your API key/secret to your environmental variables.

export AMADEUS_CLIENT_ID=YOUR_API_KEY
export AMADEUS_CLIENT_SECRET=YOUR_API_SECRET

You can easily switch between test and production environments by setting:

export AMADEUS_HOSTNAME="test" # an empty value will also set the environment to test

or

export AMADEUS_HOSTNAME="production"

Each environment has different API keys. Do not forget to update them!

Finally, run the Django server.

python pricing/manage.py runserver

Finally, open a browser and go to http://127.0.0.1:8000/

License

This library is released under the MIT License.

Help

You can find us on StackOverflow or join our developer community on Discord.