Skip to content

CHANGELOG.md

Latest commit

 

History

History
262 lines (207 loc) · 12.2 KB

CHANGELOG.md

File metadata and controls

262 lines (207 loc) · 12.2 KB

BAS Air Unit Network Dataset - Change log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

[0.5.1] - 2024-12-11

Changed

  • using '-' rather than 'None' in PDF report where values are null #227

[0.5.0] - 2024-11-27

Added

  • Waypoint fuel attribute #221
  • Waypoint elevation (ft) attribute #222
  • Waypoint category attribute #225
  • Waypoints PDF export #22

Changed

  • Dependencies updated #220
  • Documentation structure updated to latest conventions #220
  • CI/CD config updated to latest conventions inc. automated releases #220
  • Test network updated to include new waypoint properties #222

Removed

  • unnecessary docblock elements (opportunistic, not yet complete) #224

[0.4.0] - 2023-12-03 [BREAKING!]

Removed [BREAKING!]

Changed [BREAKING!]

  • NetworkManager class replaced with Network and MainAirUnitNetwork classes #46

Changed

  • Updating documentation to reflect current status of project #201
  • Updating Python dependencies #210

[0.3.0] - 2023-11-27 [BREAKING!]

Removed [BREAKING!]

  • 3D geometry support, waypoint geometries may no longer specify elevation values #150
  • Support for comments in route waypoints #141
  • Support for installing/running on Windows #198
  • GPX waypoint descriptions now only contain the waypoint name, rather than additional properties (such as comment) #126

Added

  • Flake8 code linting #83
  • Bandit static security analysis #85
  • Safety vulnerability scanning #84
  • Black code formatting #81
  • Basic Continuous Integration #82
  • Improved Continuous Integration, verifying test network can be minimally processed #168
  • Versioning to the test network #173
  • Script to recreate test network as GeoJSON for testing in QGIS #174
  • Continuous Deployment #167
  • GitLab release issue template #124
  • Co-located example in test network #178

Fixed

  • File encoding for CSV files when opened with Microsoft Excel #185
  • Addressing security vulnerabilities #195
  • Correcting double longitude value in convert to DDM function #196
  • Various bugs and improvements to FPL exporter #197
  • Using correct terminology for waypoint identifiers #177
  • Improve waypoint comment parsing #132

Changed

  • Upgrading Python dependencies #140
  • Downgrading required Python version to 3.8, for compatibility with the Operations Data Store project #138
  • Incorporating the test network into this project #172
  • Waypoints will be sorted by their sequence when added to a route #164
  • Refactoring classes into more manageable modules #202 #206
  • Aligning development environment stack with Ops Data Store #200
  • Upgrading to Python 3.9.x #202
  • Including FPL XSD schema refactored to be included as static file #203
  • Updating naming format for CSV outputs to include coordinate format consistently #180
  • Renaming FPLRouteWaypoint.waypoint_identifier to FPLRouteWaypoint.waypoint_reference to better reflect its purpose #158

Removed

  • Installation bundle concept #199

[0.2.2] - 2022-10-21

Added

  • Note that on Windows the working directory must be on the same drive as the Python interpreter #128

Fixed

  • Creating datasets in a path with missing parent directories #128
  • Files encoded as UTF-8 with BOM, which could not be parsed correctly as input files #130

[0.2.1] - 2022-09-29

Added

  • Fix for missing Microsoft Visual C++ redistributable #122

Fixed

  • Typo in LibXML2 installation instructions #121

[0.2.0] - 2022-09-28 [BREAKING!]

Changed [BREAKING!]

  • designator field in waypoints changed to identifier #114
  • Splitting comment field into name and comment fields (as part of overall GPX cmt field) #99
  • description field maximum length limited to maximum FPL comment length #105
  • FPL comment length limited to 17 characters #104

Added

  • Option to create CSV outputs with DD and/or DDM lat lon fields #94
  • Missing documentation for setting CLI parameters using environment variables #65
  • Background section in README #109

Fixed

  • Corrected to use spaces rather than underscores in FPL route names #95
  • Command example parameters used the wrong values #97
  • Output format table incorrectly stated CSV files produced a network output #96
  • Incorrect installation instructions for setting the user vs. system PATH environment variable #91

Changed

  • Sorting waypoints alphabetically - does not apply to route waypoints #100
  • Omitting some generated outputs to suit Air Unit requirements #101
  • Adjusting method parameters to be more descriptive/intuitive #51

[0.1.0] - 2022-07-14

Added

  • Core Waypoint, WaypointCollection, Route, RouteCollection, RouteWaypoint classes, and initial NetworkManager class #5
  • CSV export #7
  • GPX export #2
  • FPL export #4
  • Degrees decimal minutes (DDM) coordinate formatting for CSV export #36
  • GeoPackage persistence layer #9
  • Basic CLI #41
  • GPX import from Garmin BaseCamp #47
  • Information/data model documentation #10
  • Project documentation #35
  • Installation bundle for required software #52
  • Test network data #6
  • QGIS visualisation for test network #27
  • GitHub repository mirroring #88
  • PyPi publishing (manually) #79

Fixed

  • Waypoints table being duplicated in FPL export #38
  • Description/comment property not included in CSV export #40
  • Waypoints in network GPX file ony including waypoints used in routes #53
  • CSV newline line separator incorrect on Windows #63
  • Incorrect file names used in output directory #66