summaryrefslogtreecommitdiff
path: root/docs/source/ref/api.rst
blob: 06c9c9e7fe88c1e06de13eaab4c25a6cdb32dc5d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
===
API
===

.. automodule:: bvggrabber.api


General Functions
=================

   .. autofunction:: compute_remaining


Base and Main Classes
=====================

   .. autoclass:: Departure
      :members: __init__, remaining, __eq__, __lt__, __str__

   .. autoclass:: QueryApi
      :members: call

   .. autoclass:: Response
      :members: merge, to_json, departures, error, json, state


Concrete Implementations
========================

   .. toctree::
      api.actual
      api.scheduled
      :maxdepth: 1