Skip to content

advanced-computing/fred_angel_project

Repository files navigation

Welcome to Fred and Angel API README

Welcome to the first API made by Fred and Angel!

What it is about this API?

This API provides a user-friendly display of the total population for the years 2010, 2015, and 2022, at its first stage, to download this data. The data is categorized by country, region, and year, making it easier for various users—including civil society, academia, and public policy professionals—to analyze the information.

Given that the database is somewhat large, we appreciate your patience when eventually loading and visualizing tables, charts, and especially maps, and also when downloading JSON or CSV files.

Overview

This API provides access to data stored in a CSV file hosted on GitHub. Users can retrieve, filter, and paginate records in JSON or CSV format.

Installation

To run this API locally, follow these steps:

  1. Clone the repository
    git clone https://github.com/advanced-computing/fred_angel_project.git
    cd fred_angel_project
  2. Create a virtual environment (optional but recommended)
    python -m venv venv
    source venv/bin/activate
  3. Install dependencies
    pip install -r requirements.txt
  4. Run the Flask app
    python main.py

Additional Documentation

For more detailed instructions on searching and retrieving specific data, please refer to the documentation file at the following link:
Documentation.md

Suggestions

For any suggestions or inquiries, please feel free to contact us at the following email addresses: [email protected] or [email protected]

About

Lab 04 made by Fred and Angel

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published