Description
===========

This is a simple cli utility to view Unify's extranet timetables
(because the extranet is... well, CLI is good).

Warning
=======

The usage bellow is intended as an aim for the interface, all functions may
not be fully implemented yet.

Usage
=====

Usage: timetable [-h] [-j] [-c] [-m] [-s] [-u url] [-f FILE] [PERIOD]

Arguments:
    PERIOD     Prints timetable for a given period
               Default is to print all available informations
               See the examples below for more precisions

Options:
    -h, --help          Print this help and exit
    -j, --json          Print data in the JSON format
    -c, --compact       Use a compact output format
    -m, --manual        Do not use automatic login
    -s, --save          Save password to keyring.
                        Needs to be combined with --manual
    -u, --url URL       Url of Unify's extranet
                        Default is in '~/.extranet'
    -f, --file FILE     Use FILE to find credential
                        Default is in '~/.extranet'

Examples:
    timetable  0        : print the current course
    timetable  n        : print n next courses
    timetable  today    : print today's courses
    timetable  tomorrow : print tomorrow's courses
    timetable  first    : print tomorrow's first course
    timetable  next     : print the next course
    timetable  previous : print the previous course
    timetable  current  : print the current course
    timetable  dd/mm    : print the courses of given date

Dependencies
============

* This is not installed with this program *

Python3
requests:   https://pypi.python.org/pypi/requests
keyring:    https://pypi.python.org/pypi/keyring
extranet:   https://pypi.python.org/pypi/extranet

* This libraries are already distributed within this repository *

docopt:                 https://github.com/docopt/docopt


Installation
============

Just symlink timetable.py to somewhere in your PATH.

You will have to use `timetable.py -m -s' if you want your password
to be saved and then used automatically.

TODO
====

[ ] Add color

License
=======

GNU Lesser GPL version 3, see the LGPLv3 file

Also, pay attention to the dependancies licenses if you want to use them

Contact
=======

Main developper: Cédric Picard
Email:           cedric.picard@efrei.net
Twitter:         @Cym13
GPG:             383A 76B9 D68D 2BD6 9D2B  4716 E3B9 F4FE 5CED 42CB