Skip to content

Commit 552701b

Browse files
committed
Update version metadata and changelog
Remove transition from top of README.md Add Issue template and modify PR template to be less annoying.
1 parent 0b1ea27 commit 552701b

6 files changed

Lines changed: 19 additions & 18 deletions

File tree

.github/issue_template.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Context
2+
3+
*Broader context of the issue or proposed change*
4+
5+
# Implementation Plan
6+
7+
*Suggestions for how to approach implementing the fix/change*

.github/pull_request_template.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
# Title of PR
2-
3-
Brief description of changes. If you write good commit messages, put the concatenated list of messages here.
4-
5-
61
## Checklist
72
- [ ] Changes are fully implemented without dangling issues or TODO items
83
- [ ] Deprecated/superseded code is removed or marked with deprecation warning

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
cff-version: 1.2.0
22
title: 'space_packet_parser'
33
type: software
4-
version: '5.0.0rc9'
4+
version: '5.0.0'
55
description: A CCSDS telemetry packet decoding library based on the XTCE packet format description standard.
66
license: BSD-3-Clause
77
abstract: The Space Packet Parser Python library is a generalized, configurable packet decoding library for CCSDS telemetry

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# Space Packet Parser
22

3-
----------
43
[![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)
54
[![Doc Status](https://readthedocs.org/projects/space-packet-parser/badge/?version=latest)](https://readthedocs.org/projects/space-packet-parser/)
65
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7735001.svg)](https://doi.org/10.5281/zenodo.7735001)
76

87
Documentation: [https://space-packet-parser.readthedocs.io/en/latest/](https://space-packet-parser.readthedocs.io/en/latest/)
98

10-
Space Packet Parser is a package for decoding CCSDS telemetry packets according to an XTCE or CSV packet structure definition.
9+
Space Packet Parser is a package for decoding CCSDS telemetry packets according to an XTCE packet structure definition.
1110
It is based on the UML model of the XTCE spec and aims to support all but the most esoteric elements of the
1211
XTCE telemetry packet specification.
1312

docs/source/changelog.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ list and release milestones.
55
## Version Release Notes
66
Release notes for the `space_packet_parser` library
77

8-
### v5.0.0 (unreleased)
9-
- BREAKING: Main API changed. No need to create separate definition and parser objects any more. Create only a
8+
### v5.0.0 (released)
9+
- *BREAKING*: Main API changed. No need to create separate definition and parser objects any more. Create only a
1010
definition from your XTCE document and instead of `my_parser.generator`, use `my_packet_definition.packet_generator`.
11-
- BREAKING: Removed CSV-based packet definition support. We may indirectly support this in the future via
11+
- *BREAKING*: Removed CSV-based packet definition support. We may indirectly support this in the future via
1212
a utility for converting CSV definitions to XTCE.
13-
- BREAKING: Separated out logical pieces into separate modules rather than everything
13+
- *BREAKING*: Separated out logical pieces into separate modules rather than everything
1414
living within the xtcedef module. This means user imports may be different now.
15-
- BREAKING: Replace `bitstring` objects with native Python bytes objects
15+
- *BREAKING*: Replace `bitstring` objects with native Python bytes objects
1616
- Remove dependency on the `bitstring` library
1717
- Much faster parsing speed
1818
- Users that are passing `bitstring.ConstBitStream` objects to `generator` will need to pass a
1919
binary filelike object instead
20-
- BREAKING: The ``ParsedDataItem`` class has been removed and the derived values are being returned now.
20+
- *BREAKING*: The ``ParsedDataItem`` class has been removed and the derived values are being returned now.
2121
The ``raw_value`` is stored as an attribute on the returned object. The other items can be accessed
2222
through the packet definition object ``my_packet_definition.named_parameters["my_item"].short_description``
23-
- BREAKING: The return type of BinaryDataEncoding is now the raw bytes.
23+
- *BREAKING*: The return type of BinaryDataEncoding is now the raw bytes.
2424
To get the previous behavior you can convert the data to an integer and then format it as a binary string.
2525
``f"{int.from_bytes(data, byteorder='big'):0{len(data)*8}b}"``
26-
- BREAKING: Removed `word_size` kwarg from packet generator method.
26+
- *BREAKING*: Removed `word_size` kwarg from packet generator method.
2727
We expect all binary data to be integer number of bytes.
28-
- BREAKING: Changed `packet_generator` kwarg `skip_header_bits` to `skip_header_bytes`.
28+
- *BREAKING*: Changed `packet_generator` kwarg `skip_header_bits` to `skip_header_bytes`.
2929
- Fixed incorrect parsing of StringDataEncoding elements. Raw string values are now returned as byte buffers.
3030
Derived string values contain python string objects.
3131
- The ``CCSDSPacket`` class is now a dictionary subclass, enabling direct lookup of items from the Packet itself.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "space_packet_parser"
3-
version = "5.0.0rc9"
3+
version = "5.0.0"
44
description = "A CCSDS telemetry packet decoding library based on the XTCE packet format description standard."
55
license = "BSD-3-Clause"
66
readme = "README.md"

0 commit comments

Comments
 (0)