Skip to main content

A simple python wrapper around National Rail Enquires LDBS SOAP Webservice

Project description

https://circleci.com/gh/robert-b-clarke/nre-darwin-py.svg?style=svg Downloads

Introduction

nre-darwin-py provides an abstraction layer for accessing the National Rail Enquiries Darwin service via their legacy LDB SOAP web service. This service provides live departure board information for all United Kingdom train stations.

IMPORTANT Please note that the SOAP web service which this library uses has now been superceded by a more useable REST JSON API, thereby eliminating many of the reasons for using this library. If you are starting a new departure boards project in Python it is recommended that you use the new API directly.

Getting started

You will need to register for Darwin access, you can do this via National Rail Enquiries developer site.

Then install nre-darwin-py:

pip install nre-darwin-py

Basic usage

Initiate a session:

>>> from nredarwin.webservice import DarwinLdbSession
>>> darwin_sesh = DarwinLdbSession(wsdl="https://lite.realtime.nationalrail.co.uk/OpenLDBWS/wsdl.aspx?ver=2010-11-01", api_key="YOUR_KEY")

Retrieve the departure board for Manchester Piccadilly station:

>>> board = darwin_sesh.get_station_board('MAN')
>>> board.location_name
'Manchester Piccadilly'
>> board.train_services[0].destination_text
'Rose Hill Marple'

Retrieve more detailed information regarding a particular service:

>>> service_id = board.train_services[0].service_id
>>> service = darwin_sesh.get_service_details(service_id)
>>> [cp.location_name for cp in service.subsequent_calling_points]
[Gorton, Fairfield, Guide Bridge, Hyde Central, Woodley, Romiley, Rose Hill Marple]

Command Line Usage

A simple command line tool is provided as a reference implementation:

pip install nre-darwin-py
national-rail --help
To use you will need to export your Darwin API KEY as an environment variable::

export DARWIN_WEBSERVICE_API_KEY=YOURKEY

To view a departure board invoke the script with a single argument, the CRS code of the station:

national-rail MSN

This will render the departure board in a tabular format, for example:

Platform  Destination            Scheduled    Due
----------  ---------------------  -----------  -------
         2  Manchester Piccadilly  13:05        On time
         1  Huddersfield           13:30        On time
         2  Manchester Piccadilly  14:05        On time
         1  Huddersfield           14:30        On time

Command line help is available to list all available options:

national-rail --help

Practicalities

  • The environment variables DARWIN_WEBSERVICE_WSDL and DARWIN_WEBSERVICE_API_KEY can be used to set the WSDL url and api key, so you don’t have to specify them when initiating a DarwinLdbSession.

  • The WSDL url for the LDB Webservice may change from time to time, and has in the past. Your application should take this into account.

  • Any call to get_station_board or get_service_details will result in a query to the LDB Webservice, and therefore an HTTP request to an external service. Your application will need to handle caching and failure modes itself.

  • There is an overhead involved when creating a DarwinLdbSession, as the WSDL must be retrieved and parsed.

Contributions

Pull requests and issue reports are welcome. A requirements file is provided to help you set up code checking and formatting tools.

To set this up run:

pip install -r devenv-requirements.txt
pre-commit install

This will enable a pre-commit hook to run linting checks with flake8 and format any changed files with black

The test suite can be run via setup.py:

python3 setup.py test

Credits

Additional contributions by George Goldberg. Advice on SUDS proxy issues from Pete Barking.

TODO

  • Make departure and arrival times available as timezone-aware datetime objects

  • More detailed exception handling

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nre_darwin_py-0.4.1.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

nre_darwin_py-0.4.1-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file nre_darwin_py-0.4.1.tar.gz.

File metadata

  • Download URL: nre_darwin_py-0.4.1.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.12

File hashes

Hashes for nre_darwin_py-0.4.1.tar.gz
Algorithm Hash digest
SHA256 ab9b845ba4145ed69f3450a6a38866ad53b1018b9df9dcf793368a5de4d230f5
MD5 8a915fec7f607483b92b80ed89b9a6d8
BLAKE2b-256 dac27ac767078072cb030d7f27f161aa2ba6a04cb58e63ca1584e99a8f39b069

See more details on using hashes here.

File details

Details for the file nre_darwin_py-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for nre_darwin_py-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b3ef9cd367c9a46add6cdc88e6544bbf31b3b32b9a653dd355742a2562ba53ba
MD5 7a8dda871f043899f221a9cf841b463b
BLAKE2b-256 b3e22299310aac6c75276a809c5115baab2758331e71e3ea7300519e15cc5a33

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page