Skip to main content

An open-source tool for collecting railway codes used in different UK rail industry systems.

Project description

Python version Documentation status License Codacy grade (Code quality) Zenodo - DOI

PyRCS is an open-source Python package for collecting and handling various codes (used in different UK rail industry systems), which are made available from the Railway Codes website. This tool is intended for those people, such as researchers and practitioners, that currently either use that website or work with the UK’s railway codes and who are interested in using the Python programming language to facilitate access to, and manipulation of, data relating to railway codes.

The installation of PyRCS includes a set of pre-packed data. When users request data of a category that is specified on the Railway Codes website, the pre-packed data of the category is loaded by default. Beyond that, it also offers capabilities to directly access the most up-to-date data on the data source website, and update the relevant pre-packed data as well.

Documentation

The PyRCS documentation (including detailed examples and a quick-start tutorial) is hosted on ReadTheDocs: [PDF] [HTML].

Installation

To install the latest release of pyrcs from PyPI via pip:

pip install --upgrade pyrcs

Note: For more information, please also refer to Installation.

License

PyRCS is licensed under GNU General Public License v3 or later (GPLv3+).

Cite as

Fu, Q. (2020). PyRCS: an open-source tool for collecting railway codes used in different UK rail industry systems. Zenodo. doi:10.5281/zenodo.4026744

@software{qian_fu_pyrcs_4026744,
  author       = {Qian Fu},
  title        = {{PyRCS: an open-source tool for collecting railway
                   codes used in different UK rail industry systems}},
  year         = 2020,
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.4026744},
  url          = {https://doi.org/10.5281/zenodo.4026744}
}

Note: Please also refer to the export options from Zenodo to reference the specific version as appropriate when using PyRCS.

Acknowledgement

PyRCS uses data available from the Railway Codes website. The time and effort that the website’s editor and all contributors put in making the site and data available are fully credited.

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

pyrcs-0.3.1.tar.gz (1.3 MB view hashes)

Uploaded source

Built Distribution

pyrcs-0.3.1-py3-none-any.whl (1.4 MB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page