Skip to content

tchx84/linka

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
app
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

LINKA CI

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

Install

$ sudo dnf install python3-virtualenv python-devel
$ virtualenv env
$ source ./env/bin/activate
$ pip install -r requirements.txt

Setup

$ export LINKA_MASTER_KEY="YOUR_MADE_UP_AND_SECURE_API_KEY"
$ export DATABASE_URL=sqlite:///./default.db
$ 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 for more details.

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published