metrovlc 0.6.2
Command line utility for MetroValencia

METROVLC
========

|pypi-version| |License|

Utilidad en línea de comandos para
`MetroValencia <http://www.metrovalencia.es/page.php?idioma=_es>`__,
también funciona como módulo.

Descripción
-----------

Recupera alguna de las funcionalidades de la web de MetroValencia.

Requerimientos
--------------

-  Python3

Instalación
-----------

.. code:: shell

   pip install metrovlc

Ayuda
-----

Uso
~~~

::

   # metrovlc --help
   usage: metrovlc [-h] [-b BONO] [-f FECHA] [-d ORIGEN DESTINO] [-l] [-j]
                   [-ps ORIGEN DESTINO HORA S|L] [-v]

   optional arguments:
     -h, --help            show this help message and exit
     -b BONO, --bono BONO  Número de bonometro (10 o 12 dígitos)
     -f FECHA, --fecha FECHA
                           Fecha para el horario (Formato dd/mm/yyyy)
     -d ORIGEN DESTINO, --horario ORIGEN DESTINO
                           Horarios para ORIGEN -> DESTINO
     -l, --estaciones      Lista todas las estaciones
     -j, --json            Muestra los resultados en formato JSON
     -ps ORIGEN DESTINO HORA S|L, --plan ORIGEN DESTINO HORA S|L
                           Plan para ORIGEN DESTINO HORA S|L
     -v, --version         show program's version number and exit

Ejemplos
~~~~~~~~

.. code:: shell

   # Mirar saldo de tu tarjeta TuiN
   $ metrovlc -b 4065483771
   Bono: 4065483771, Título: TuiN, saldo: 5,67 Euros

   # Mirar saldo de tu tarjeta TuiN, en JSON
   $ metrovlc -b 4065483771 -j
   {"cardNumber": "3697122989", "cardZones": "TuiN", "cardCurrency": "Euros", "cardBalance": 3.64}

   # Horarios de Llíria a Campanar para hoy
   $ metrovlc --horarios lliria campanar

   Estación de Origen: Llíria
   Estación de Destino: Campanar
   Franja horaria: de 00:00 a 23:59
   Día: 16/03/2017
   Duración aproximada del trayecto: 48 minutos aprox.
   Para efectuar este trayecto es necesario un billete de las zonas: ABC
   De Llíria a Campanar, Trenes con destino: València Sud, Torrent Avinguda, Hora de salida

   02 | 02:38 | ----- | ----- | ----- | ----- | ----- | ----- | ----- |
   06 | 06:09 | 06:37 | 06:52 | ----- | ----- | ----- | ----- | ----- |
   07 | 07:07 | 07:22 | 07:37 | 07:52 | ----- | ----- | ----- | ----- |
   08 | 08:07 | 08:22 | 08:39 | ----- | ----- | ----- | ----- | ----- |
   09 | 09:09 | 09:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   10 | 10:09 | 10:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   11 | 11:09 | 11:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   12 | 12:09 | 12:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   13 | 13:09 | 13:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   14 | 14:09 | 14:37 | 14:52 | ----- | ----- | ----- | ----- | ----- |
   15 | 15:07 | 15:22 | 15:39 | ----- | ----- | ----- | ----- | ----- |
   16 | 16:09 | 16:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   17 | 17:09 | 17:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   18 | 18:09 | 18:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   19 | 19:09 | 19:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   20 | 20:09 | 20:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   21 | 21:09 | 21:39 | ----- | ----- | ----- | ----- | ----- | ----- |
   22 | 22:09 | 22:41 | ----- | ----- | ----- | ----- | ----- | ----- |
   23 | 23:14 | ----- | ----- | ----- | ----- | ----- | ----- | ----- |

   # Horarios de Llíria a Campanar para un día futuro
   $ metrovlc -d lliria campanar -f "23/02/2081"
   ...

   # Podemos usar nombre aproximados para las estaciones (hasta cierto punto)
   #   - liria: se reconocerá como "Llíria"
   #   - ribarrroja de turia: se reconocerá como "Riba-roja de Túria"
   $ metrovlc -d "liria" "ribarroja de turia"
   ...

   # Si quiero llegar a Rosas a las 14:30 a que hora debo salir en Xàtiva
   $ metrovlc.exe -p xativa rosas 14:30 L
   Viaje de Xàtiva a Rosas, para el día 28/12/2018: Salida a las 14:10, llegada a las 14:28

   # Si lo que quería era salir a las 14:30...
   $ metrovlc.exe -p xativa rosas 14:30 S
   Viaje de Xàtiva a Rosas, para el día 28/12/2018: Salida a las 14:30, llegada a las 14:48

Como módulo
-----------

Es posible cargar el módulo ``metrovlc`` y utilizar su funcionalidad.

Ejemplo
-------

.. code:: python

   import metrovlc
   # Recupera el saldo a partir de tu número de tarjeta
   metrovlc.card(4065483771)
   > {'cardNumber': 4065483771, 'cardZones': 'TuiN', 'cardCurrency': 'Euros', 'cardBalance': 3.64}

Donde tenemos los siguientes métodos:

-  ``metrovlc.plan(origen, destino, fecha=None, hora='00:00', tipohora='S')``
-  ``routes(origen, destino, fecha=None, hini='00:00', hfin='23:59')``
-  ``metrovlc.stations()``
-  ``metrovlc.card_balance(bono)``

Todos ellos devuelven un diccionario.

Licencia
--------

MIT

.. |pypi-version| image:: https://img.shields.io/pypi/v/metrovlc.svg?style=flat-square
   :target: https://pypi.python.org/pypi?:action=display&name=metrovlc
.. |License| image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
   :target: LICENSE