.. vbbpy documentation master file, created by
   sphinx-quickstart on Sat May 14 00:43:32 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

==================================
Welcome to vbbpy's documentation!
==================================

vbbpy is a python wrapper for the vbb REST API written by derHuerst_.

.. _derHuerst: https://github.com/derhuerst/vbb-rest

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   reference
   quickstart/quickstart


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

.. code-block:: bash

   git clone https://github.com/Colum31/vbb-pythonWrapper.git
   cd vbb-pythonWrapper
   pip install .


Features
========

vbbpy is able to:

- find routes between stations and addresses
- get next departures for a station
- get further information about stations and lines

Usage
=====

The examples folder contains some scripts that show the capabilities and usage of the library.


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`