Merge pull request #7 from us-irs/prepare_v0.1.1

v0.1.1

CHANGELOG.md

@@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # [unreleased]
 
+# [v0.1.1] 2024-04-23
+
+- Allow `spacepackets` range from v0.23 to < v0.25
+
 # [v0.1.0]
 
 Initial release of the `cfdp-py` library which was split off the

README.md

@@ -18,13 +18,13 @@ You can install this package from PyPI
 Linux:
 
 ```sh
-python3 -m pip install cfdppy 
+python3 -m pip install cfdp-py
 ```
 
 Windows:
 
 ```sh
-py -m pip install cfdppy 
+py -m pip install cfdp-py
 ```
 
 # Examples
@@ -38,7 +38,7 @@ first. You also have to install the package with the optional `test` feature:
 
 ```sh
 pip install coverage pytest
-pip install cfdppy[test]
+pip install cfdp-py[test]
 ```
 
 Running tests regularly:

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "cfdp-py"
 description = "Library for high level CCSDS File Delivery Protocol (CFDP) components"
 readme = "README.md"
-version = "0.1.0"
+version = "0.1.1"
 requires-python = ">=3.8"
 license = {text = "Apache-2.0"}
 authors = [
@@ -28,9 +28,9 @@ classifiers = [
   "Topic :: Scientific/Engineering"
 ]
 dependencies = [
-  "spacepackets~=0.23.0",
+  "spacepackets>=0.23.0, <0.25",
   "crcmod~=1.7",
-  "deprecation~=2.1"
+  "deprecation~=2.1",
 ]
 
 [project.optional-dependencies]
@@ -41,7 +41,7 @@ test = [
 [project.urls]
 "Homepage" = "https://github.com/us-irs/cfdp-py"
 
-[tool.ruff]
+[tool.ruff.lint]
 ignore = ["E501"]
-[tool.ruff.extend-per-file-ignores]
+[tool.ruff.lint.extend-per-file-ignores]
 "__init__.py" = ["F401"]

release-checklist.md

@@ -13,7 +13,7 @@ The steps shown here are for Ubuntu/MacOS.
    with date and new `unreleased`section.
 4. Run tests with `pytest .`
 5. Run auto-formatter with `black .`
-6. Run linter with `ruff .`
+6. Run linter with `ruff check .`
 7. Wait for CI/CD results. This also runs the tests on different operating systems
 
 # Release

tests/test_checksum.py

@@ -36,6 +36,8 @@ def setUp(self):
         self.file_path = Path(f"{gettempdir()}/crc_file")
         with open(self.file_path, "wb") as file:
             file.write(EXAMPLE_DATA_CFDP)
+        # Kind of re-writing the modular checksum impl here which we are trying to test, but the
+        # numbers/correctness were verified manually using calculators, so this is okay.
         segments_to_add = []
         for i in range(4):
             if (i + 1) * 4 > len(EXAMPLE_DATA_CFDP):
@@ -50,7 +52,6 @@ def setUp(self):
                 )
             )
         full_sum = sum(segments_to_add)
-        print(full_sum)
         full_sum %= 2**32
 
         self.expected_checksum_for_example = struct.pack("!I", full_sum)