From 552701b568750fd68298b66a1f813d18c43ac046 Mon Sep 17 00:00:00 2001 From: Gavin Medley Date: Thu, 3 Oct 2024 12:27:33 -0600 Subject: [PATCH] Update version metadata and changelog Remove transition from top of README.md Add Issue template and modify PR template to be less annoying. --- .github/issue_template.md | 7 +++++++ .github/pull_request_template.md | 5 ----- CITATION.cff | 2 +- README.md | 3 +-- docs/source/changelog.md | 18 +++++++++--------- pyproject.toml | 2 +- 6 files changed, 19 insertions(+), 18 deletions(-) create mode 100644 .github/issue_template.md diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 0000000..01f5fd0 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,7 @@ +# Context + +*Broader context of the issue or proposed change* + +# Implementation Plan + +*Suggestions for how to approach implementing the fix/change* \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e488e03..070fc06 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,8 +1,3 @@ -# Title of PR - -Brief description of changes. If you write good commit messages, put the concatenated list of messages here. - - ## Checklist - [ ] Changes are fully implemented without dangling issues or TODO items - [ ] Deprecated/superseded code is removed or marked with deprecation warning diff --git a/CITATION.cff b/CITATION.cff index 28a9293..95062e7 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,7 +1,7 @@ cff-version: 1.2.0 title: 'space_packet_parser' type: software -version: '5.0.0rc9' +version: '5.0.0' description: A CCSDS telemetry packet decoding library based on the XTCE packet format description standard. license: BSD-3-Clause abstract: The Space Packet Parser Python library is a generalized, configurable packet decoding library for CCSDS telemetry diff --git a/README.md b/README.md index 1bd7051..4dd8b8d 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ # Space Packet Parser ----------- [![Test Status](https://github.com/medley56/space_packet_parser/actions/workflows/pr_tests.yml/badge.svg)](https://github.com/medley56/space_packet_parser/actions/workflows/pr_tests.yml) [![Doc Status](https://readthedocs.org/projects/space-packet-parser/badge/?version=latest)](https://readthedocs.org/projects/space-packet-parser/) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7735001.svg)](https://doi.org/10.5281/zenodo.7735001) Documentation: [https://space-packet-parser.readthedocs.io/en/latest/](https://space-packet-parser.readthedocs.io/en/latest/) -Space Packet Parser is a package for decoding CCSDS telemetry packets according to an XTCE or CSV packet structure definition. +Space Packet Parser is a package for decoding CCSDS telemetry packets according to an XTCE packet structure definition. It is based on the UML model of the XTCE spec and aims to support all but the most esoteric elements of the XTCE telemetry packet specification. diff --git a/docs/source/changelog.md b/docs/source/changelog.md index 30fd512..1f63def 100644 --- a/docs/source/changelog.md +++ b/docs/source/changelog.md @@ -5,27 +5,27 @@ list and release milestones. ## Version Release Notes Release notes for the `space_packet_parser` library -### v5.0.0 (unreleased) -- BREAKING: Main API changed. No need to create separate definition and parser objects any more. Create only a +### v5.0.0 (released) +- *BREAKING*: Main API changed. No need to create separate definition and parser objects any more. Create only a definition from your XTCE document and instead of `my_parser.generator`, use `my_packet_definition.packet_generator`. -- BREAKING: Removed CSV-based packet definition support. We may indirectly support this in the future via +- *BREAKING*: Removed CSV-based packet definition support. We may indirectly support this in the future via a utility for converting CSV definitions to XTCE. -- BREAKING: Separated out logical pieces into separate modules rather than everything +- *BREAKING*: Separated out logical pieces into separate modules rather than everything living within the xtcedef module. This means user imports may be different now. -- BREAKING: Replace `bitstring` objects with native Python bytes objects +- *BREAKING*: Replace `bitstring` objects with native Python bytes objects - Remove dependency on the `bitstring` library - Much faster parsing speed - Users that are passing `bitstring.ConstBitStream` objects to `generator` will need to pass a binary filelike object instead -- BREAKING: The ``ParsedDataItem`` class has been removed and the derived values are being returned now. +- *BREAKING*: The ``ParsedDataItem`` class has been removed and the derived values are being returned now. The ``raw_value`` is stored as an attribute on the returned object. The other items can be accessed through the packet definition object ``my_packet_definition.named_parameters["my_item"].short_description`` -- BREAKING: The return type of BinaryDataEncoding is now the raw bytes. +- *BREAKING*: The return type of BinaryDataEncoding is now the raw bytes. To get the previous behavior you can convert the data to an integer and then format it as a binary string. ``f"{int.from_bytes(data, byteorder='big'):0{len(data)*8}b}"`` -- BREAKING: Removed `word_size` kwarg from packet generator method. +- *BREAKING*: Removed `word_size` kwarg from packet generator method. We expect all binary data to be integer number of bytes. -- BREAKING: Changed `packet_generator` kwarg `skip_header_bits` to `skip_header_bytes`. +- *BREAKING*: Changed `packet_generator` kwarg `skip_header_bits` to `skip_header_bytes`. - Fixed incorrect parsing of StringDataEncoding elements. Raw string values are now returned as byte buffers. Derived string values contain python string objects. - The ``CCSDSPacket`` class is now a dictionary subclass, enabling direct lookup of items from the Packet itself. diff --git a/pyproject.toml b/pyproject.toml index 144a13a..77bdc85 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "space_packet_parser" -version = "5.0.0rc9" +version = "5.0.0" description = "A CCSDS telemetry packet decoding library based on the XTCE packet format description standard." license = "BSD-3-Clause" readme = "README.md"