https://github.com/pawlovskiii/big-mac-index
This project is about extracting data from The Economist - Big Mac Index within URL API, uploading it to the AWS S3, implementing email notification that data is in S3, and data visualization within PowerBI.
https://github.com/pawlovskiii/big-mac-index
boto3 configparser json modules nasdaq nasdaq-python-api pandas python requests type-hints
Last synced: 26 days ago
JSON representation
This project is about extracting data from The Economist - Big Mac Index within URL API, uploading it to the AWS S3, implementing email notification that data is in S3, and data visualization within PowerBI.
- Host: GitHub
- URL: https://github.com/pawlovskiii/big-mac-index
- Owner: pawlovskiii
- Created: 2022-06-12T22:51:24.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-27T21:17:17.000Z (over 3 years ago)
- Last Synced: 2025-01-10T09:24:07.435Z (over 1 year ago)
- Topics: boto3, configparser, json, modules, nasdaq, nasdaq-python-api, pandas, python, requests, type-hints
- Language: Python
- Homepage:
- Size: 295 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The Big Mac Index
## Table of contents
- [General info](#general-info)
- [Setup](#setup)
- [Installing dependencies](#installing-dependencies)
- [Run the project](#run-the-project)
## General info
Brief project information:
- Extracted country codes from the metadata CSV file to nextly use them in requests to API to obtain data from [The Economist - Big Mac Index](https://data.nasdaq.com/data/ECONOMIST-the-economist-big-mac-index/usage/quickstart/api)
- Saved data locally to make data visualization within PowerBI with the top 5 countries with the highest Big Mac index in July
2021
- Uploaded the data to AWS S3 within the boto3 client. Implemented email notification that data is in S3
- The whole application is divided into separate modules to group related code to make it easier to understand and use. Everything
executes in the main.py file which imports functionality from the scripts from the src folder
## Setup
These are the crucial steps to configuring and running the project.
### Installing dependencies
```bash
# To create a folder for downloaded CSV files from API
$ mkdir bigmac_index
# To download all the necessarily Python packages needed for the project
$ pip install -r requirements.txt
```
### Run the project
```python
python .\main.py
```