https://github.com/tchx84/linka

An open source service to record air quality data from community sensors
https://github.com/tchx84/linka

Last synced: 3 months ago
JSON representation

An open source service to record air quality data from community sensors

• Host: GitHub
• URL: https://github.com/tchx84/linka
• Owner: tchx84
• License: agpl-3.0
• Created: 2020-10-10T17:43:54.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-16T09:17:43.000Z (6 months ago)
• Last Synced: 2024-07-16T11:44:59.156Z (6 months ago)
• Language: Python
• Homepage:
• Size: 116 KB
• Stars: 21
• Watchers: 9
• Forks: 11
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: COPYING
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# LINKA ![CI](https://github.com/tchx84/linka/workflows/CI/badge.svg)

LINKA is an open source service to record air quality data from community sensors.

## Install

```

$ sudo dnf install python3-virtualenv python-devel libpq-devel

$ virtualenv env

$ source ./env/bin/activate

$ pip install -r requirements.txt

```

**NOTE:** Python 3.12 is not yet supported.

## Setup

```

$ export LINKA_MASTER_KEY="YOUR_MADE_UP_AND_SECURE_API_KEY"

$ export DATABASE_URL=postgresql://USER:PASSWORD@localhost:5432/linka

$ alembic upgrade head

```

## Run

```

$ source ./env/bin/activate

$ gunicorn --bind 0.0.0.0:5000 --graceful-timeout 300 --timeout 300 --worker-class=uvicorn.workers.UvicornWorker --worker-connections=10 --workers=3 wsgi-service:app

```

## Docs

Run the service and check http://localhost:5000/docs

Use the same `LINKA_MASTER_KEY` value for `X-API-Key` value of Authorize section 

You can also check if everything is working fine with curl

```

curl --request GET \

  --url http://localhost:5000/api/v1/providers \

  --header 'X-API-Key: YOUR_MADE_UP_AND_SECURE_API_KEY'

```

At first should return a http status 200 with an empty array `[]`

# Disclaimer

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU Affero General Public License](COPYING) for more details.