https://github.com/hroncok/utvsapi-eve

A REST-like read-only API for ÚTVS ČVUT implemented in eve
https://github.com/hroncok/utvsapi-eve

Last synced: 17 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/hroncok/utvsapi-eve
• Owner: hroncok
• License: mit
• Created: 2016-04-26T21:09:19.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-05-05T15:04:04.000Z (over 8 years ago)
• Last Synced: 2024-12-13T20:49:49.848Z (23 days ago)
• Language: Python
• Homepage:
• Size: 35.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
utvsapi-eve

===========

A REST-like read-only API for [ÚTVS ČVUT](https://rozvoj.fit.cvut.cz/Main/rozvrhy-utvs-db)

implemented in [eve](http://python-eve.org/).

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.