Skip to content

A REST-like read-only API for ÚTVS ČVUT implemented in eve

License

Notifications You must be signed in to change notification settings

hroncok/utvsapi-eve

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 

Repository files navigation

utvsapi-eve

A REST-like read-only API for ÚTVS ČVUT implemented in eve.

To use this, create file named mysql.cnf with your MySQL credentials, see an example here:

[client]
host = localhost
user = username
database = dbname
password = insecurepassword

This has been developed and run on Python 3 only, legacy Python might not work.

Install eve, eve-sqlalchemy and mysqlclient (you'll need mysql devel package for that). You might do it with virtualenv:

pyvenv venv
. venv/bin/activate
pip install eve eve-sqlalchemy mysqlclient

Optionally, for HTML documentation you also need eve-docs, unfortunately a forked version, not the one from PyPI.

pip install https://github.com/hermannsblum/eve-docs/archive/extended_documentation.zip

Start the service in debug mode:

PYTHONPATH=. python3 utvsapi/main.py

Or run with gunicorn:

pip install gunicorn
PYTHONPATH=. gunicorn utvsapi.main:app

License

This software is licensed under the terms of the MIT license, see LICENSE for full text and copyright information.

About

A REST-like read-only API for ÚTVS ČVUT implemented in eve

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages