Metadata-Version: 2.1
Name: journeyplanner
Version: 1.0.1
Summary: Journey Planner API client library
Home-page: https://github.com/bytesandbrains/journeyplanner-python
Author: Bytes & Brains
Author-email: developers@bytesandbrains.com
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/markdown

# Journeyplanner

A client for accessing the Journey Planner (Rejseplanen) API.

## Installation
The journeyplanner library can be installed using pip:

    $ pip install journeyplanner

### Examples
```
client = JourneyPlanner()
dt = datetime(2019, 1, 8, 12, 0, 0)
origin = Endpoint(latitude=55.68325233, longitude=12.57150292, name="noerreport")
destination = Endpoint(latitude=55.67271128, longitude=12.56635308, name="hovedbanen")
trip = client.trip(origin, destination, date=dt.date(), time=dt.time())
print(list(trip))
```

### Authentication
```
client = JourneyPlanner()
client.authenticate('USERNAME', 'PASSWORD')
```

## API reference

### Trip objects
Trip instances have the following attributes:

#### `Trip.legs`
  List of leg instances

### Leg objects
Leg instances have the following attributes:

* `Leg.name`
* `Leg.type`
* `Leg.origin`
* `Leg.destination`
* `Leg.notes`


