Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
fabaff committed Aug 23, 2017
1 parent dc206ac commit 09c3dd0
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
python-opendata-transport
=========================

Python API for interacting with `transport.opendata.ch <http://transport.opendata.ch/>`_.

Installation
------------
The module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.

.. code:: bash
$ pip3 install python_opendata_transport
## Usage

.. code:: bash
>>> from opendata_transport import OpendataTransport
>>> data = OpendataTransport('Bern', 'Biel')
>>> data.get_data()
>>> print(data.connections)
Development
-----------
For development is recommanded to use a ``venv``.

.. code:: bash
$ python3.6 -m venv
$ source bin/activate
$ python3 setup.py develop
License
-------
``python-opendata-transport`` is licensed under MIT, for more details check LICENSE.

0 comments on commit 09c3dd0

Please sign in to comment.