https://github.com/openaq/openaq-snapshot
https://github.com/openaq/openaq-snapshot
air-quality
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/openaq/openaq-snapshot
- Owner: openaq
- Created: 2020-08-18T11:55:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T11:40:37.000Z (over 2 years ago)
- Last Synced: 2025-01-11T22:45:53.654Z (4 months ago)
- Topics: air-quality
- Language: HTML
- Homepage: https://air-quality-snapshot.herokuapp.com/
- Size: 1.04 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openaq-snapshot
## Running Locally
Make sure you have Python 3.7 [installed locally](http://install.python-guide.org). To push to Heroku, you'll need to install the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli).
```sh
$ git clone https://github.com/openaq/openaq-snapshot.git
$ cd openaq-snapshot
$ pipenv install
$ pipenv shell
$ flask run
```
Your app should now be running on [localhost:5000](http://localhost:5000/).
You can also install the dependencies without `pipenv`:
```
$ python3 -m venv env
$ source ./env/bin/activate
$ pip install -r requirements.txt
```
**After you update the Pipfile and Pipfile.lock files, update the `requirements.txt` with:**
```
$ pip freeze > requirements.txt
```
`requirements.txt` is used for deploying to AWS Elastic Beanstalk.
## Testing
Make sure you have `pytest` installed.
```
$ pytest tests.py
```
## Deploying to AWS Elastic Beanstalk
**Prerequisites: Python 3.7.9, pip, and awsebcli**
You also need your AWS credentials ready in your `~/.aws/credentials` file.
### Initialize new EB app
When starting a new deployment, run:
```
eb init
```
The command will start an interactive session where you:
- Enter the app name
- Choose Python version to use
- Choose AWS region
### Create new environment for deployment
This will create a new environment, and deploy the app there.
```
eb create env-name
```
### Open deployment
Once deployed, open the app in a browser window:
```
eb open
```
### Set environment variables
You can set configuration values such as `MAPBOX_ACCESS_TOKEN` using:
```
eb setenv KEY=value KEY2=value2
```
### Monitoring deployment
Here are some helpful commands to monitor your deployment:
```sh
# show health status of envs
eb health
# show logs
eb logs
# print environment variables
eb printenv
# shows environment status and info
eb status
```
## Deploying to Heroku
```sh
$ heroku create
$ git push heroku master
$ heroku open
```
or
[](https://heroku.com/deploy)
## Documentation
For more information about using Python on Heroku, see these Dev Center articles:
- [Python on Heroku](https://devcenter.heroku.com/categories/python)