https://github.com/chriseborowski/quality-air

An interactive AQI (Air Quality Index) checker in Python. What's the air quality in your city today?
https://github.com/chriseborowski/quality-air

air-quality air-quality-api air-quality-index aqi aqi-monitor python python3 weather weather-api

Last synced: 28 days ago
JSON representation

An interactive AQI (Air Quality Index) checker in Python. What's the air quality in your city today?

• Host: GitHub
• URL: https://github.com/chriseborowski/quality-air
• Owner: chriseborowski
• License: mit
• Created: 2023-06-09T21:40:38.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-23T20:49:37.000Z (over 1 year ago)
• Last Synced: 2024-01-30T14:18:06.058Z (11 months ago)
• Topics: air-quality, air-quality-api, air-quality-index, aqi, aqi-monitor, python, python3, weather, weather-api
• Language: Python
• Homepage: https://github.com/chriseborowski/quality-air
• Size: 38.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: license.txt

Awesome Lists containing this project

README

        
# Quality Air

[View demo](https://replit.com/@chriseborowski/Quality-Air) • [Report bug](https://github.com/chriseborowski/quality-air/issues) • [Request feature](https://github.com/chriseborowski/quality-air/issues) • [DM author](https://twitter.com/chriseborowski)

![Live demo](https://github.com/chriseborowski/quality-air/blob/main/live-demo.png)

## About

An interactive AQI (Air Quality Index) checker in Python. What's the air quality in your city today?

For a live demo of the project on Replit, click [here](https://replit.com/@chriseborowski/Quality-Air).

For a video clip demonstrating the game, click [here](https://twitter.com/chriseborowski/status/1666513865570394131).

## Getting started

1. Clone the repository to your machine

`git clone https://github.com/chriseborowski/quality-air`

2. Sign up for a free Air Quality Open Data Platform API token [here](https://aqicn.org/data-platform/token/)

3. Paste your API token inside the source code in line 29

`api_key = "YOUR-KEY-VALUE-HERE"`

4. Run the code in your preferred code editor (e.g., VSCode) or Terminal/Bash window (sample code below)

`python3 quality_air.py`

5. Enter the desired city or location to display the air quality index (AQI) and supplemental information

## Roadmap

Steps completed

* Initial version released 

* Live demo on Replit created 

* README.md description created

Steps to be completed

* Add color text support

## License

Distributed under the MIT License. See `license.txt` for more information.

## Contact

Chris Borowski

Follow me **@chriseborowski** on [GitHub](https://github.com/chriseborowski) • [Twitter](https://twitter.com/chriseborowski) • [T2](https://t2.social/chriseborowski) • [LinkedIn](https://www.linkedin.com/in/chriseborowski) • [Linktree](https://linktr.ee/chriseborowski) (all links)

Project repository link: [Quality Air](https://github.com/chriseborowski/quality-air)