PyRCS
An open-source tool for collecting railway codes used in different UK rail industry systems.
PyRCS is an open-source Python package that simplifies the collection and management of railway codes used across different systems in the UK rail industry. It provides a practical toolkit for researchers, practitioners and frequent users of the Railway Codes website who work extensively with railway codes in the UK. By leveraging Python's capabilities, PyRCS enables efficient access, retrieval and manipulation of railway code data, enhancing productivity and effectiveness in working with these codes.
During installation, PyRCS includes a set of pre-packaged data. When users request data from a specific category on the Railway Codes website, PyRCS loads the corresponding pre-packaged data for that category by default. Additionally, it provides functionality for direct access to the latest data from the source website, ensuring users stay up to date. Users can also update the pre-packaged data as needed, keeping their resources synchronised with the latest developments.
With PyRCS, users can leverage Python's power to streamline workflows and enhance productivity when working with railway codes in the UK rail industry.
Installation
PyRCS can be installed using uv (recommended) or pip.
Using uv (Recommended)
To add PyRCS to an existing project:
uv add pyrcs
If you are working in an activated virtual environment:
uv pip install --upgrade pyrcs
Using pip
If you prefer standard Python packaging tools, ensure your virtual environment_ is activated:
pip install --upgrade pyrcs
For detailed options, development setup and Windows troubleshooting (e.g. installing C-extension wheels), see the full Installation Guide.
Quick start
For a concise guide on how to use PyRCS, check out the Quick Start tutorial, which includes illustrative examples for three frequently-used code categories in the UK railway system:
- Location identifiers (CRS, NLC, TIPLOC and STANOX codes)
- Engineer’s Line References (ELRs) and their associated mileage files
- Railway station data (mileages, operators and grid coordinates)
Documentation
The complete PyRCS Documentation is available in HTML and PDF formats.
It is hosted on Read the Docs, and the HTML version is also accessible via GitHub Pages. The documentation includes detailed examples, tutorials and comprehensive references to help users get the most out of PyRCS.
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{Fu_PyRCS_2020,
author = {Fu, Qian},
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},
license = {MIT},
url = {https://github.com/mikeqfu/pyrcs}
}
For specific version references, please refer to Zenodo.
License
PyRCS is licensed under the MIT License.
Please note that this project was initially licensed under the GPLv3+ up to version 0.3.7. Starting with version 1.0.0, it has been re-licensed under the MIT License.
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.
1 maintainer
Release files for pyrcs 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyrcs-1.2.0.tar.gz | 1.9 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyrcs-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.0 MB
Release files / pyrcs-1.2.0.tar.gz
| Download URL | pyrcs-1.2.0.tar.gz |
|---|---|
| Size | 1.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cb1daf7c5f16f2b3a5c4ea7658277e14f339d753b68402c3d948763ec9005a59
|
|
BLAKE2b-256 checksum How to use checksums |
760b3ca230fed98ae32a20715ce4d231bfd7aac082a3d5dbb9c3f756a544b07a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / pyrcs-1.2.0-py3-none-any.whl
| Download URL | pyrcs-1.2.0-py3-none-any.whl |
|---|---|
| Size | 2.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
664ba0fb140676878b35202d4509e5c6d2132e26010d83ae682ad293b19f9368
|
|
BLAKE2b-256 checksum How to use checksums |
9d526e403e6123639e813c9c6e18e7584fc1b1d1618748ee4f8531f163e956ad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
