pyerail 0.2.1

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description: |block| PyeRail : eRail python wrapper
=============================================

.. |block| image:: http://api.erail.in/images/eRail196x196.png
:width: 20px
:height: 20px

**What is it?**
****************

PyeRail is a Python wrapper for the eRail web API.

It allows quick and easy comsumption of eRail API from your Python applicatuon.

PyeRail reqires Python 3.


**Install**
***********

You can install pyerail using:

.. code ::

$ pip3 install pyerail

Build from source

.. code ::

$ git clone https://github.com/aksbuzz/PyeRail.git

$ cd PyeRail

$ make


**Usage**
*********

*API Key*
^^^^^^^^^
For access to the eRail API you would need a API Key.

You can get the API Key from here http://api.erail.in/

*Using the module*
^^^^^^^^^^^^^^^^^^

Creating an instance object of class

.. code :: python

>>> from pyerail import Erail
>>> eRail = Erail(api_key)

Getting details of given PNR number

.. code :: python

>>> eRail.pnr(your_pnr_number)


In any case the object returns

"status" and "result"


**Examples**
************

You can find example usage in the examples folder.

**Contribution**
****************

Contributions are welcome!.

**Documentation**
*****************

Documentation at http://api.erail.in/

**Todo**
********

- Add Python 2 support
- Add detailed documentation
Platform: UNKNOWN