README.md

Tides

This module acts as a wrapper around the Tidal Data providers such as Admiralty (UK Tide provider).

Usage

Using tides is pretty straightforward. You will need to have your TideProvider's (currently on only Admiralty is implemented) access token set as an environment variable named TIDE_KEY.

tides = Tides('admiralty')
tides.provider.get_tides(station="Leith")

The TideProvdier interface defines the following methods:

def get_all_stations():

def get_station_by_id():

def get_station_by_name():

def get_tides():

def next_tide():

def time_to_next_tide():

Install

$pip install tides

Contributing

See the Contributing Guide