TrackDiagrams¶
- class pyrcs.line_data.TrackDiagrams(data_dir=None, update=False, verbose=True)[source]¶
A class for collecting data of British railway track diagrams.
- Parameters:
data_dir (str | None) – The name of the directory for storing the data; defaults to
None
.update (bool) – Whether to check for updates to the data catalogue; defaults to
False
.verbose (bool | int) – Whether to print relevant information to the console; defaults to
True
.
- Variables:
catalogue (dict) – The catalogue of the data.
last_updated_date (str) – The date when the data was last updated.
data_dir (str) – The path to the directory containing the data.
current_data_dir (str) – The path to the current data directory.
Examples:
>>> from pyrcs.line_data import TrackDiagrams # from pyrcs import TrackDiagrams >>> td = TrackDiagrams() >>> td.NAME 'Railway track diagrams' >>> td.URL 'http://www.railwaycodes.org.uk/line/diagrams0.shtm'
Attributes
The key for accessing the data.
The key used to reference the last updated date in the data.
The name of the data.
The URL of the main web page for the data.
Methods
collect_catalogue
([confirmation_required, ...])Collects the catalogue of sample railway track diagrams from the source web page.
fetch_catalogue
([update, dump_dir, verbose])Fetches the catalogue of railway track diagrams.