Skip to main content

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

Project description

PyRCS

PyPI Release Version Python Version License ReadTheDocs Documentation GitHub Actions Workflow Status Codacy - Code Quality Codecov - Test Coverage DOI

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 synchronized 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

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

$ pip install --upgrade pyrcs

For more information, see the Installation.

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:

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.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pyrcs-1.0.1.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

pyrcs-1.0.1-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

Details for the file pyrcs-1.0.1.tar.gz.

File metadata

  • Download URL: pyrcs-1.0.1.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.11

File hashes

Hashes for pyrcs-1.0.1.tar.gz
Algorithm Hash digest
SHA256 07805a29db6dfc20d70e1476b242d0697005321b1a8c79d7605d4e901e5d168c
MD5 057ee74af1d3409596e94c614d08040f
BLAKE2b-256 59403ee63c30c978fe8d1f95341c9e7a33e876161104100d02f774e989c61a99

See more details on using hashes here.

File details

Details for the file pyrcs-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pyrcs-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.11

File hashes

Hashes for pyrcs-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a11966c0bb268f43b825c30d3b8399501742ef85bc78f05ec89882ba53e41d77
MD5 c860dee640fbcafb75de850822a88261
BLAKE2b-256 61a032f198552d036098d3d5c6803ba850aa165685433840e201f7fb6fa3f01b

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