Skip to content

Version 2025.2.0 [RELEASE CANDIDATE 1]

Pre-release
Pre-release

Choose a tag to compare

View all tags
@anonymous44401 anonymous44401 released this 28 Jan 10:26
v2025.2.0-rc.1
0d2ee6b
This commit was signed with the committer’s verified signature.
anonymous44401 Cameron
SSH Key Fingerprint: EoO5M9fGMXvstlTTP71ERIIOKuunYQ6rAnR69Y0jZZI
Verified
Learn about vigilant mode.

Release Notes

Version 2025.2.0 [Release Candidate 1] (Launched on 28/01/2025 for all modes).

This release introduced a new get_station method which returns a combined departure + arrival board.

Check out the source code for this release.

Code Changes:

Warning

This release features a breaking change. See the Refactoring section in the release notes.

  • New features

    • Added an API connection tester.
      • Checks your username and password before you send API requests.
    • Implemented get_station for all modes.
      • This provides you with a combined departure and arrival board.
    • New error format.

  • Code Enhancements

    • A full, ordered station board can now be returned.
      • Added merge_sort for get_station.
    • Added new simple + advanced classes for get_service.
    • Implementation of get_station for advanced, simple & complex modes.

  • Error Handling

    • All errors now provide status codes.
    • Errors are now more specific to the actual error.
      • Example error: 400: Complexity not recognised. Select a valid type.
    • Errors can be found in the errors page.

  • Performance Improvements

    • Code removals.
      • Redundant code has been removed.
    • Enhanced efficiency across multiple areas.
      • Added new classes for data handling.
      • Removed some unneeded loops.

  • Refactoring

    • Added new comments.
    • Moved empty objects to a details.py file.
    • Some classes have been renamed.
      • Some attributes inside classes have been renamed.
        • Breaking Change: all_calling_points is now just calling points.
    • Some files have been renamed.
    • Some functions have been renamed.
    • Some older comments have been updated.
    • Some variables have been renamed.
    • Updated in-code documentation.

Wiki Changes:

  • Added a footer to the wiki.
  • Added an errors page to the wiki.
  • Added extra details to methods in various files.
  • Added more data extraction documentation.
  • Added new code examples.
  • All pages have received minor and major changes.
    • Updated
  • Corrected various spelling and grammar mistakes.
  • Updated terminology to reflect the new update.
  • Updated old code examples.

Other Changes:

  • Added new example code for simple and complex modes.
    • You can find these here
  • Release notes now have a new format.
    • You can see it here.
  • Updated the README file.
    • Corrected spelling.
    • Updated code examples.
  • Updated the supported versions in the security policy.
    • V1.x.xbx has been removed from the supported list.
    • V2025.x.xbx has been added to the supported list.

Bugs

Fixes:

  • Fixed a bug causing imports to fail.
  • Fixed a bug causing no data to be returned when providing only a time and TIPLOC in get_station, get_arrivals and get_departures.
  • Fixed a bug causing times in get_station to order incorrectly.
    • 00:xx times will always show at the top of the board regardless.
  • Fixed a bug causing times to validate incorrectly.
  • Fixed some code formatting bugs.

Awaiting Allocation:

What's Changed

Full Changelog: v2025.1.0...v2025.2.0

Contributors

anonymous44401
Assets 2
Loading