[go: up one dir, main page]

File: README.md

package info (click to toggle)
aqipy 0.4.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 88 kB
  • sloc: python: 110; makefile: 6; sh: 2
file content (29 lines) | stat: -rw-r--r-- 741 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# AQIPY  

A simple tool to get Air Quality Indices from around the world.

## Installation    
1. Get an API token [here](https://aqicn.org/data-platform/token/#/).    
1. Create an environment variable with your token:    
`export AQIPY_TOKEN='<your_new_token>'`    

### From source
1. Clone this repository.
1. From your new directory:    
`pip3 install -e .`

### From PyPI
`pip install aqipy`

## Usage
To get the AQI for your current location (IP based):    
`aqipy`

To get the AQI for a specific location (latitude longitude):    
`aqipy geo [--latlon / -l <lat lon>]`   

### Example
`$ aqipy geo --latlon 53.8 -7.4`

## Attribution     
This tool uses APIs provided by the [World Air Quality Index Project](http://waqi.info/).