Skip to content

Commit

Permalink
Update version metadata and changelog
Browse files Browse the repository at this point in the history
Remove transition from top of README.md
Add Issue template and modify PR template to be less annoying.
  • Loading branch information
medley56 committed Oct 3, 2024
1 parent 0b1ea27 commit 552701b
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 18 deletions.
7 changes: 7 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Context

*Broader context of the issue or proposed change*

# Implementation Plan

*Suggestions for how to approach implementing the fix/change*
5 changes: 0 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
18 changes: 9 additions & 9 deletions docs/source/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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"
Expand Down

0 comments on commit 552701b

Please sign in to comment.