• Overview
• Features
• Web GUI Interface
• Cloud hostings
• Usage
• Dependencies
• Project documents
• REST API
• References
• Contribute
• Creators
• License
• More...

Облачное веб-приложение, предназначенное для просмотра актуального расписания занятий студентов ДонНТУ.

• Приложение использует соверменный HTML5 шаблон для веб-интерфейса.
• Приложение предоставляет простой REST API. Пример приложения для Android, использующее данное API.

Данное приложение развернуто на хостингах:

• Heroku - Cloud Application Platform as a service (PaaS).
• Mongo Lab - Fully managed MongoDB-as-a-Service.

1. Установите интерпретатор Python 2.7 и все зависимости данного проекта. (Если у вас все установлено перейдите к пункту 2)

2. Скачайте данный репозиторий на свой локальный компьютер (выполните в терминале git clone https://github.com/pi12/timetable.git)

3. Перейдите в корневой каталог (выполните в терминале cd timetable)

4. Установите переменные окружения выполнив данные команды в терминале (для Windows):

   set SERVER_NAME=localhost:5000
   set MONGODB_DB=<YOU NAME DATABASE>
   set MONGODB_USERNAME=<YOU USERNAME>
   set MONGODB_PASSWORD=<YOU PASSWORD>
   set MONGODB_HOST=<YOU HOST>
   set MONGODB_PORT=<YOU PORT>
   

5. Запустите приложение, выполнив команду в терминале python run.py

6. Откройте браузер и перейдите по адресу http://localhost:5000

• Flask==0.10.1
• flask-mongoengine==0.7.1
• gunicorn==19.3.0
• Jinja2==2.8
• mongoengine==0.10.0
• and other (see requirements.txt)

• Документация SRS

Схема URI запроса: http://donuniv.herokuapp.com/api/<METHOD_NAME>?<PARAMETERS>&v=0.1, v - обозначает версию API, которая используется.

* - не реализованные параметры (в get-методах временно не реализована фильтрация)

Значения необязательных параметров по умолчанию:

• offset = 0 (если отрицательное, то ошибки не будет, будет 0)
• count = 10 (минимальное 0, максимальное 50)
• order = "random" (допустимые "random", "name")
• week = -1 (допустимые -1, 0, 1, 2) верхняя / нижняя / обе недели
• weekday = -1 (допустимые -1, 1, 2, 3, 4, 5, 6, 7 ; 0 работает, но это ошибка, или нет 😄 ) день недели (пн, вт ...)
• item_number = -1 номер пары

-1 в парметрах week, weekday, number можно не указывать он означает, что возвращать нужно всё

Общий пример json-ответа:

{
    "response": {
    ...
    },
    "status": 0,
    "message": "OK"
}

1. Клиент посылает HTTP GET запрос, например http://donuniv.herokuapp.com/api/group.getLessons?group_abbr=pi12a&v=0.1. (Чтобы узнать group_abbr необходимо выполнить перед этим запрос на groups.get)
2. Сервер возвращает ответ json-формата:

{
    "response": {
        "abbr": "pi12a", 
        "title": "ПИ-12а", 
        "lessons": [
            {
                "title": "Программирование", 
                "room": "4.1", 
                "lecturer": "Иванов Иван Иванович", 
                "item_number": 2, 
                "weekday_number": 1, 
                "weekday": "Monday", 
                "week_number": 2, 
                "week": "Both", 
                "description": "", 
                "subgroup": [
                    255
                ]
            }, 
            {
                "title": "Основы алгоритмов", 
                "room": "8.705", 
                "lecturer": "Петров Иван Иванович", 
                "item_number": 3, 
                "weekday_number": 1, 
                "weekday": "Monday", 
                "week_number": 2, 
                "week": "Both", 
                "description": "", 
                "subgroup": [
                    255
                ]
            }
        ]
    }, 
    "status": 0, 
    "message": "OK"
}

• Что такое облачные технологии?
• Анатомия облачной инфраструктуры хранения данных
• Что такое REST?
• Архитектура REST
• Знакомьтесь, архитектура REST
• Основные ссылки по Python и Flask можно найти здесь

• Напишите замечание по данному проекту - https://github.com/pi12/timetable/issues/new
• Отправьте pull request - https://github.com/pi12/timetable/pulls

• Artem Yegorov - Main developer.
• Gleb Kalinichenko - Android developer.
• Sergey Medgaus - Mentor and Database developer.
• Igor Nikolaev - Mentor and Database developer.

Copyright 2015 by SE-12a DonNTU.

Licensed under the Creative Commons — Attribution-NonCommercial 3.0 (CC BY-NC 3.0)

Вопросы и предложения вы можете задать по данному email-адресу: yegorov0725@yandex.ru