spac-kit 0.1.0.dev0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,194 @@
1
+ Apache License
2
+ ==============
3
+
4
+ _Version 2.0, January 2004_
5
+ _&lt;<http://www.apache.org/licenses/>&gt;_
6
+
7
+ ### Terms and Conditions for use, reproduction, and distribution
8
+
9
+ #### 1. Definitions
10
+
11
+ “License” shall mean the terms and conditions for use, reproduction, and
12
+ distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ “Licensor” shall mean the copyright owner or entity authorized by the copyright
15
+ owner that is granting the License.
16
+
17
+ “Legal Entity” shall mean the union of the acting entity and all other entities
18
+ that control, are controlled by, or are under common control with that entity.
19
+ For the purposes of this definition, “control” means **(i)** the power, direct or
20
+ indirect, to cause the direction or management of such entity, whether by
21
+ contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or **(iii)** beneficial ownership of such entity.
23
+
24
+ “You” (or “Your”) shall mean an individual or Legal Entity exercising
25
+ permissions granted by this License.
26
+
27
+ “Source” form shall mean the preferred form for making modifications, including
28
+ but not limited to software source code, documentation source, and configuration
29
+ files.
30
+
31
+ “Object” form shall mean any form resulting from mechanical transformation or
32
+ translation of a Source form, including but not limited to compiled object code,
33
+ generated documentation, and conversions to other media types.
34
+
35
+ “Work” shall mean the work of authorship, whether in Source or Object form, made
36
+ available under the License, as indicated by a copyright notice that is included
37
+ in or attached to the work (an example is provided in the Appendix below).
38
+
39
+ “Derivative Works” shall mean any work, whether in Source or Object form, that
40
+ is based on (or derived from) the Work and for which the editorial revisions,
41
+ annotations, elaborations, or other modifications represent, as a whole, an
42
+ original work of authorship. For the purposes of this License, Derivative Works
43
+ shall not include works that remain separable from, or merely link (or bind by
44
+ name) to the interfaces of, the Work and Derivative Works thereof.
45
+
46
+ “Contribution” shall mean any work of authorship, including the original version
47
+ of the Work and any modifications or additions to that Work or Derivative Works
48
+ thereof, that is intentionally submitted to Licensor for inclusion in the Work
49
+ by the copyright owner or by an individual or Legal Entity authorized to submit
50
+ on behalf of the copyright owner. For the purposes of this definition,
51
+ “submitted” means any form of electronic, verbal, or written communication sent
52
+ to the Licensor or its representatives, including but not limited to
53
+ communication on electronic mailing lists, source code control systems, and
54
+ issue tracking systems that are managed by, or on behalf of, the Licensor for
55
+ the purpose of discussing and improving the Work, but excluding communication
56
+ that is conspicuously marked or otherwise designated in writing by the copyright
57
+ owner as “Not a Contribution.”
58
+
59
+ “Contributor” shall mean Licensor and any individual or Legal Entity on behalf
60
+ of whom a Contribution has been received by Licensor and subsequently
61
+ incorporated within the Work.
62
+
63
+ #### 2. Grant of Copyright License
64
+
65
+ Subject to the terms and conditions of this License, each Contributor hereby
66
+ grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
67
+ irrevocable copyright license to reproduce, prepare Derivative Works of,
68
+ publicly display, publicly perform, sublicense, and distribute the Work and such
69
+ Derivative Works in Source or Object form.
70
+
71
+ #### 3. Grant of Patent License
72
+
73
+ Subject to the terms and conditions of this License, each Contributor hereby
74
+ grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
75
+ irrevocable (except as stated in this section) patent license to make, have
76
+ made, use, offer to sell, sell, import, and otherwise transfer the Work, where
77
+ such license applies only to those patent claims licensable by such Contributor
78
+ that are necessarily infringed by their Contribution(s) alone or by combination
79
+ of their Contribution(s) with the Work to which such Contribution(s) was
80
+ submitted. If You institute patent litigation against any entity (including a
81
+ cross-claim or counterclaim in a lawsuit) alleging that the Work or a
82
+ Contribution incorporated within the Work constitutes direct or contributory
83
+ patent infringement, then any patent licenses granted to You under this License
84
+ for that Work shall terminate as of the date such litigation is filed.
85
+
86
+ #### 4. Redistribution
87
+
88
+ You may reproduce and distribute copies of the Work or Derivative Works thereof
89
+ in any medium, with or without modifications, and in Source or Object form,
90
+ provided that You meet the following conditions:
91
+
92
+ * **(a)** You must give any other recipients of the Work or Derivative Works a copy of
93
+ this License; and
94
+ * **(b)** You must cause any modified files to carry prominent notices stating that You
95
+ changed the files; and
96
+ * **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
97
+ all copyright, patent, trademark, and attribution notices from the Source form
98
+ of the Work, excluding those notices that do not pertain to any part of the
99
+ Derivative Works; and
100
+ * **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
101
+ Derivative Works that You distribute must include a readable copy of the
102
+ attribution notices contained within such NOTICE file, excluding those notices
103
+ that do not pertain to any part of the Derivative Works, in at least one of the
104
+ following places: within a NOTICE text file distributed as part of the
105
+ Derivative Works; within the Source form or documentation, if provided along
106
+ with the Derivative Works; or, within a display generated by the Derivative
107
+ Works, if and wherever such third-party notices normally appear. The contents of
108
+ the NOTICE file are for informational purposes only and do not modify the
109
+ License. You may add Your own attribution notices within Derivative Works that
110
+ You distribute, alongside or as an addendum to the NOTICE text from the Work,
111
+ provided that such additional attribution notices cannot be construed as
112
+ modifying the License.
113
+
114
+ You may add Your own copyright statement to Your modifications and may provide
115
+ additional or different license terms and conditions for use, reproduction, or
116
+ distribution of Your modifications, or for any such Derivative Works as a whole,
117
+ provided Your use, reproduction, and distribution of the Work otherwise complies
118
+ with the conditions stated in this License.
119
+
120
+ #### 5. Submission of Contributions
121
+
122
+ Unless You explicitly state otherwise, any Contribution intentionally submitted
123
+ for inclusion in the Work by You to the Licensor shall be under the terms and
124
+ conditions of this License, without any additional terms or conditions.
125
+ Notwithstanding the above, nothing herein shall supersede or modify the terms of
126
+ any separate license agreement you may have executed with Licensor regarding
127
+ such Contributions.
128
+
129
+ #### 6. Trademarks
130
+
131
+ This License does not grant permission to use the trade names, trademarks,
132
+ service marks, or product names of the Licensor, except as required for
133
+ reasonable and customary use in describing the origin of the Work and
134
+ reproducing the content of the NOTICE file.
135
+
136
+ #### 7. Disclaimer of Warranty
137
+
138
+ Unless required by applicable law or agreed to in writing, Licensor provides the
139
+ Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
140
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
141
+ including, without limitation, any warranties or conditions of TITLE,
142
+ NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
143
+ solely responsible for determining the appropriateness of using or
144
+ redistributing the Work and assume any risks associated with Your exercise of
145
+ permissions under this License.
146
+
147
+ #### 8. Limitation of Liability
148
+
149
+ In no event and under no legal theory, whether in tort (including negligence),
150
+ contract, or otherwise, unless required by applicable law (such as deliberate
151
+ and grossly negligent acts) or agreed to in writing, shall any Contributor be
152
+ liable to You for damages, including any direct, indirect, special, incidental,
153
+ or consequential damages of any character arising as a result of this License or
154
+ out of the use or inability to use the Work (including but not limited to
155
+ damages for loss of goodwill, work stoppage, computer failure or malfunction, or
156
+ any and all other commercial damages or losses), even if such Contributor has
157
+ been advised of the possibility of such damages.
158
+
159
+ #### 9. Accepting Warranty or Additional Liability
160
+
161
+ While redistributing the Work or Derivative Works thereof, You may choose to
162
+ offer, and charge a fee for, acceptance of support, warranty, indemnity, or
163
+ other liability obligations and/or rights consistent with this License. However,
164
+ in accepting such obligations, You may act only on Your own behalf and on Your
165
+ sole responsibility, not on behalf of any other Contributor, and only if You
166
+ agree to indemnify, defend, and hold each Contributor harmless for any liability
167
+ incurred by, or claims asserted against, such Contributor by reason of your
168
+ accepting any such warranty or additional liability.
169
+
170
+ _END OF TERMS AND CONDITIONS_
171
+
172
+ ### APPENDIX: How to apply the Apache License to your work
173
+
174
+ To apply the Apache License to your work, attach the following boilerplate
175
+ notice, with the fields enclosed by brackets `[]` replaced with your own
176
+ identifying information. (Don't include the brackets!) The text should be
177
+ enclosed in the appropriate comment syntax for the file format. We also
178
+ recommend that a file or class name and description of purpose be included on
179
+ the same “printed page” as the copyright notice for easier identification within
180
+ third-party archives.
181
+
182
+ Copyright [yyyy] [name of copyright owner]
183
+
184
+ Licensed under the Apache License, Version 2.0 (the "License");
185
+ you may not use this file except in compliance with the License.
186
+ You may obtain a copy of the License at
187
+
188
+ http://www.apache.org/licenses/LICENSE-2.0
189
+
190
+ Unless required by applicable law or agreed to in writing, software
191
+ distributed under the License is distributed on an "AS IS" BASIS,
192
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
193
+ See the License for the specific language governing permissions and
194
+ limitations under the License.
@@ -0,0 +1,334 @@
1
+ Metadata-Version: 2.4
2
+ Name: spac_kit
3
+ Version: 0.1.0.dev0
4
+ Summary: Collection of Python tools for working with CCSDS Space Packets
5
+ Home-page: https://github.com/CCSDSPy/SPaC-Kit
6
+ Author: NASA/Caltech/JPL
7
+ License: Apache License
8
+ ==============
9
+
10
+ _Version 2.0, January 2004_
11
+ _&lt;<http://www.apache.org/licenses/>&gt;_
12
+
13
+ ### Terms and Conditions for use, reproduction, and distribution
14
+
15
+ #### 1. Definitions
16
+
17
+ “License” shall mean the terms and conditions for use, reproduction, and
18
+ distribution as defined by Sections 1 through 9 of this document.
19
+
20
+ “Licensor” shall mean the copyright owner or entity authorized by the copyright
21
+ owner that is granting the License.
22
+
23
+ “Legal Entity” shall mean the union of the acting entity and all other entities
24
+ that control, are controlled by, or are under common control with that entity.
25
+ For the purposes of this definition, “control” means **(i)** the power, direct or
26
+ indirect, to cause the direction or management of such entity, whether by
27
+ contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
28
+ outstanding shares, or **(iii)** beneficial ownership of such entity.
29
+
30
+ “You” (or “Your”) shall mean an individual or Legal Entity exercising
31
+ permissions granted by this License.
32
+
33
+ “Source” form shall mean the preferred form for making modifications, including
34
+ but not limited to software source code, documentation source, and configuration
35
+ files.
36
+
37
+ “Object” form shall mean any form resulting from mechanical transformation or
38
+ translation of a Source form, including but not limited to compiled object code,
39
+ generated documentation, and conversions to other media types.
40
+
41
+ “Work” shall mean the work of authorship, whether in Source or Object form, made
42
+ available under the License, as indicated by a copyright notice that is included
43
+ in or attached to the work (an example is provided in the Appendix below).
44
+
45
+ “Derivative Works” shall mean any work, whether in Source or Object form, that
46
+ is based on (or derived from) the Work and for which the editorial revisions,
47
+ annotations, elaborations, or other modifications represent, as a whole, an
48
+ original work of authorship. For the purposes of this License, Derivative Works
49
+ shall not include works that remain separable from, or merely link (or bind by
50
+ name) to the interfaces of, the Work and Derivative Works thereof.
51
+
52
+ “Contribution” shall mean any work of authorship, including the original version
53
+ of the Work and any modifications or additions to that Work or Derivative Works
54
+ thereof, that is intentionally submitted to Licensor for inclusion in the Work
55
+ by the copyright owner or by an individual or Legal Entity authorized to submit
56
+ on behalf of the copyright owner. For the purposes of this definition,
57
+ “submitted” means any form of electronic, verbal, or written communication sent
58
+ to the Licensor or its representatives, including but not limited to
59
+ communication on electronic mailing lists, source code control systems, and
60
+ issue tracking systems that are managed by, or on behalf of, the Licensor for
61
+ the purpose of discussing and improving the Work, but excluding communication
62
+ that is conspicuously marked or otherwise designated in writing by the copyright
63
+ owner as “Not a Contribution.”
64
+
65
+ “Contributor” shall mean Licensor and any individual or Legal Entity on behalf
66
+ of whom a Contribution has been received by Licensor and subsequently
67
+ incorporated within the Work.
68
+
69
+ #### 2. Grant of Copyright License
70
+
71
+ Subject to the terms and conditions of this License, each Contributor hereby
72
+ grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
73
+ irrevocable copyright license to reproduce, prepare Derivative Works of,
74
+ publicly display, publicly perform, sublicense, and distribute the Work and such
75
+ Derivative Works in Source or Object form.
76
+
77
+ #### 3. Grant of Patent License
78
+
79
+ Subject to the terms and conditions of this License, each Contributor hereby
80
+ grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
81
+ irrevocable (except as stated in this section) patent license to make, have
82
+ made, use, offer to sell, sell, import, and otherwise transfer the Work, where
83
+ such license applies only to those patent claims licensable by such Contributor
84
+ that are necessarily infringed by their Contribution(s) alone or by combination
85
+ of their Contribution(s) with the Work to which such Contribution(s) was
86
+ submitted. If You institute patent litigation against any entity (including a
87
+ cross-claim or counterclaim in a lawsuit) alleging that the Work or a
88
+ Contribution incorporated within the Work constitutes direct or contributory
89
+ patent infringement, then any patent licenses granted to You under this License
90
+ for that Work shall terminate as of the date such litigation is filed.
91
+
92
+ #### 4. Redistribution
93
+
94
+ You may reproduce and distribute copies of the Work or Derivative Works thereof
95
+ in any medium, with or without modifications, and in Source or Object form,
96
+ provided that You meet the following conditions:
97
+
98
+ * **(a)** You must give any other recipients of the Work or Derivative Works a copy of
99
+ this License; and
100
+ * **(b)** You must cause any modified files to carry prominent notices stating that You
101
+ changed the files; and
102
+ * **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
103
+ all copyright, patent, trademark, and attribution notices from the Source form
104
+ of the Work, excluding those notices that do not pertain to any part of the
105
+ Derivative Works; and
106
+ * **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
107
+ Derivative Works that You distribute must include a readable copy of the
108
+ attribution notices contained within such NOTICE file, excluding those notices
109
+ that do not pertain to any part of the Derivative Works, in at least one of the
110
+ following places: within a NOTICE text file distributed as part of the
111
+ Derivative Works; within the Source form or documentation, if provided along
112
+ with the Derivative Works; or, within a display generated by the Derivative
113
+ Works, if and wherever such third-party notices normally appear. The contents of
114
+ the NOTICE file are for informational purposes only and do not modify the
115
+ License. You may add Your own attribution notices within Derivative Works that
116
+ You distribute, alongside or as an addendum to the NOTICE text from the Work,
117
+ provided that such additional attribution notices cannot be construed as
118
+ modifying the License.
119
+
120
+ You may add Your own copyright statement to Your modifications and may provide
121
+ additional or different license terms and conditions for use, reproduction, or
122
+ distribution of Your modifications, or for any such Derivative Works as a whole,
123
+ provided Your use, reproduction, and distribution of the Work otherwise complies
124
+ with the conditions stated in this License.
125
+
126
+ #### 5. Submission of Contributions
127
+
128
+ Unless You explicitly state otherwise, any Contribution intentionally submitted
129
+ for inclusion in the Work by You to the Licensor shall be under the terms and
130
+ conditions of this License, without any additional terms or conditions.
131
+ Notwithstanding the above, nothing herein shall supersede or modify the terms of
132
+ any separate license agreement you may have executed with Licensor regarding
133
+ such Contributions.
134
+
135
+ #### 6. Trademarks
136
+
137
+ This License does not grant permission to use the trade names, trademarks,
138
+ service marks, or product names of the Licensor, except as required for
139
+ reasonable and customary use in describing the origin of the Work and
140
+ reproducing the content of the NOTICE file.
141
+
142
+ #### 7. Disclaimer of Warranty
143
+
144
+ Unless required by applicable law or agreed to in writing, Licensor provides the
145
+ Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
147
+ including, without limitation, any warranties or conditions of TITLE,
148
+ NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
149
+ solely responsible for determining the appropriateness of using or
150
+ redistributing the Work and assume any risks associated with Your exercise of
151
+ permissions under this License.
152
+
153
+ #### 8. Limitation of Liability
154
+
155
+ In no event and under no legal theory, whether in tort (including negligence),
156
+ contract, or otherwise, unless required by applicable law (such as deliberate
157
+ and grossly negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special, incidental,
159
+ or consequential damages of any character arising as a result of this License or
160
+ out of the use or inability to use the Work (including but not limited to
161
+ damages for loss of goodwill, work stoppage, computer failure or malfunction, or
162
+ any and all other commercial damages or losses), even if such Contributor has
163
+ been advised of the possibility of such damages.
164
+
165
+ #### 9. Accepting Warranty or Additional Liability
166
+
167
+ While redistributing the Work or Derivative Works thereof, You may choose to
168
+ offer, and charge a fee for, acceptance of support, warranty, indemnity, or
169
+ other liability obligations and/or rights consistent with this License. However,
170
+ in accepting such obligations, You may act only on Your own behalf and on Your
171
+ sole responsibility, not on behalf of any other Contributor, and only if You
172
+ agree to indemnify, defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason of your
174
+ accepting any such warranty or additional liability.
175
+
176
+ _END OF TERMS AND CONDITIONS_
177
+
178
+ ### APPENDIX: How to apply the Apache License to your work
179
+
180
+ To apply the Apache License to your work, attach the following boilerplate
181
+ notice, with the fields enclosed by brackets `[]` replaced with your own
182
+ identifying information. (Don't include the brackets!) The text should be
183
+ enclosed in the appropriate comment syntax for the file format. We also
184
+ recommend that a file or class name and description of purpose be included on
185
+ the same “printed page” as the copyright notice for easier identification within
186
+ third-party archives.
187
+
188
+ Copyright [yyyy] [name of copyright owner]
189
+
190
+ Licensed under the Apache License, Version 2.0 (the "License");
191
+ you may not use this file except in compliance with the License.
192
+ You may obtain a copy of the License at
193
+
194
+ http://www.apache.org/licenses/LICENSE-2.0
195
+
196
+ Unless required by applicable law or agreed to in writing, software
197
+ distributed under the License is distributed on an "AS IS" BASIS,
198
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
199
+ See the License for the specific language governing permissions and
200
+ limitations under the License.
201
+
202
+ Project-URL: Homepage, https://github.com/CCSDSPy/SPaC-Kit
203
+ Keywords: CCSDS,Space Packets,Downlink,Parser,Documentation
204
+ Classifier: Development Status :: 4 - Beta
205
+ Classifier: Environment :: Console
206
+ Classifier: Intended Audience :: Science/Research
207
+ Classifier: License :: OSI Approved :: Apache Software License
208
+ Classifier: Natural Language :: English
209
+ Classifier: Operating System :: OS Independent
210
+ Classifier: Programming Language :: Python :: 3 :: Only
211
+ Classifier: Topic :: Scientific/Engineering
212
+ Requires-Python: <3.10,>=3.9
213
+ Description-Content-Type: text/markdown
214
+ License-File: LICENSE.md
215
+ Requires-Dist: ccsdspy~=1.3.0
216
+ Requires-Dist: crccheck~=1.3.0
217
+ Dynamic: license-file
218
+
219
+ [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
220
+
221
+ # SPaC-Kit
222
+
223
+ ## ✨ Introduction
224
+
225
+ **SpaC-Kit** is a collection of Python tools for working with **CCSDS Space Packet**. It can generically:
226
+
227
+ - Parse data files into **Pandas DataFrames** or **Excel spreadsheets**
228
+ - **(Scheduled Feb 2026)** – Generate documentation in multiple formats (**HTML**, **Markdown**, **reStructuredText**, **PDF**)
229
+ - **(Scheduled Apr 2026)** – Generate simulated packets
230
+
231
+ SpaC-Kit supports mission- or instrument-specific CCSDS packet structures via plugin packages built on the [**CCSDSPy** library](https://docs.ccsdspy.org/).
232
+
233
+ ### 🔌 Available Plugins
234
+
235
+ - [Europa Clipper CCSDS packet definitions](https://github.com/joshgarde/europa-cliper-ccsds-plugin)
236
+ - Want to define your own CCSDS packets? [Open a ticket](https://github.com/CCSDSPy/SPaC-Kit/issues) to start the discussion.
237
+
238
+ ## Users
239
+
240
+ ### Requirement
241
+
242
+ Tested with `python 3.9`.
243
+
244
+ Optionnally, but recommended, create a virtual environment:
245
+
246
+ python3 -m venv my_virtual_env
247
+ sournce my_virtual_env/bin/activate
248
+
249
+
250
+ ### Install
251
+
252
+ Install you plugin library first, for example Europa-Clipper CCSDS packets definitions:
253
+
254
+ git clone https://github.com/joshgarde/europa-cliper-ccsds-plugin.git
255
+ cd europa-cliper-ccsds-plugin
256
+ pip install .
257
+
258
+ Install the SPaC-Kit package:
259
+
260
+ pip install spac_kit
261
+
262
+ ### Use
263
+
264
+ parse-downlink --file {your ccsds file}
265
+
266
+ See more options with:
267
+
268
+ parse-downlink --help
269
+
270
+
271
+ ## Developers
272
+
273
+ ### Requirements
274
+
275
+ #### Python 3.9
276
+
277
+ #### Create a virtual environment
278
+
279
+ For example in command line:
280
+
281
+ python3 -m venv venv
282
+ source venv/bin/activate
283
+
284
+ #### Install CCSDSPy
285
+
286
+ To install the latest version of CCSDSPy:
287
+
288
+ pip install git+https://github.com/CCSDSPy/ccsdspy.git
289
+
290
+
291
+ #### Deploy the project, for developers
292
+
293
+ Clone the repository
294
+
295
+ Install the package
296
+
297
+ pip install -e '.[dev]'
298
+ pre-commit install && pre-commit install -t pre-push
299
+
300
+ Run an example:
301
+
302
+ python src/spa_kit/parse/downlink_to_excel.py
303
+
304
+ or
305
+
306
+ spac-parse --help
307
+
308
+ or
309
+
310
+ spac-parse --file ./data/ecm_mag_testcase6_cmds_split_out.log --bdsem --header
311
+
312
+
313
+ #### Build and publish the package
314
+
315
+ Update the version number in file `setup.cfg`
316
+
317
+ Create a tag in the repository
318
+
319
+ Build the project:
320
+
321
+ python3 -m pip install --upgrade build
322
+ rm -rf dist/
323
+ python3 -m build
324
+
325
+
326
+ Publish the project:
327
+
328
+ twine upload dist/*
329
+
330
+
331
+
332
+ ## Acknowledgment
333
+
334
+ This package heavily relies on `ccsdspy` library (see https://github.com/CCSDSPy/ccsdspy).
@@ -0,0 +1,116 @@
1
+ [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
2
+
3
+ # SPaC-Kit
4
+
5
+ ## ✨ Introduction
6
+
7
+ **SpaC-Kit** is a collection of Python tools for working with **CCSDS Space Packet**. It can generically:
8
+
9
+ - Parse data files into **Pandas DataFrames** or **Excel spreadsheets**
10
+ - **(Scheduled Feb 2026)** – Generate documentation in multiple formats (**HTML**, **Markdown**, **reStructuredText**, **PDF**)
11
+ - **(Scheduled Apr 2026)** – Generate simulated packets
12
+
13
+ SpaC-Kit supports mission- or instrument-specific CCSDS packet structures via plugin packages built on the [**CCSDSPy** library](https://docs.ccsdspy.org/).
14
+
15
+ ### 🔌 Available Plugins
16
+
17
+ - [Europa Clipper CCSDS packet definitions](https://github.com/joshgarde/europa-cliper-ccsds-plugin)
18
+ - Want to define your own CCSDS packets? [Open a ticket](https://github.com/CCSDSPy/SPaC-Kit/issues) to start the discussion.
19
+
20
+ ## Users
21
+
22
+ ### Requirement
23
+
24
+ Tested with `python 3.9`.
25
+
26
+ Optionnally, but recommended, create a virtual environment:
27
+
28
+ python3 -m venv my_virtual_env
29
+ sournce my_virtual_env/bin/activate
30
+
31
+
32
+ ### Install
33
+
34
+ Install you plugin library first, for example Europa-Clipper CCSDS packets definitions:
35
+
36
+ git clone https://github.com/joshgarde/europa-cliper-ccsds-plugin.git
37
+ cd europa-cliper-ccsds-plugin
38
+ pip install .
39
+
40
+ Install the SPaC-Kit package:
41
+
42
+ pip install spac_kit
43
+
44
+ ### Use
45
+
46
+ parse-downlink --file {your ccsds file}
47
+
48
+ See more options with:
49
+
50
+ parse-downlink --help
51
+
52
+
53
+ ## Developers
54
+
55
+ ### Requirements
56
+
57
+ #### Python 3.9
58
+
59
+ #### Create a virtual environment
60
+
61
+ For example in command line:
62
+
63
+ python3 -m venv venv
64
+ source venv/bin/activate
65
+
66
+ #### Install CCSDSPy
67
+
68
+ To install the latest version of CCSDSPy:
69
+
70
+ pip install git+https://github.com/CCSDSPy/ccsdspy.git
71
+
72
+
73
+ #### Deploy the project, for developers
74
+
75
+ Clone the repository
76
+
77
+ Install the package
78
+
79
+ pip install -e '.[dev]'
80
+ pre-commit install && pre-commit install -t pre-push
81
+
82
+ Run an example:
83
+
84
+ python src/spa_kit/parse/downlink_to_excel.py
85
+
86
+ or
87
+
88
+ spac-parse --help
89
+
90
+ or
91
+
92
+ spac-parse --file ./data/ecm_mag_testcase6_cmds_split_out.log --bdsem --header
93
+
94
+
95
+ #### Build and publish the package
96
+
97
+ Update the version number in file `setup.cfg`
98
+
99
+ Create a tag in the repository
100
+
101
+ Build the project:
102
+
103
+ python3 -m pip install --upgrade build
104
+ rm -rf dist/
105
+ python3 -m build
106
+
107
+
108
+ Publish the project:
109
+
110
+ twine upload dist/*
111
+
112
+
113
+
114
+ ## Acknowledgment
115
+
116
+ This package heavily relies on `ccsdspy` library (see https://github.com/CCSDSPy/ccsdspy).
@@ -0,0 +1,36 @@
1
+ [build-system]
2
+ requires = [
3
+ "setuptools>=42",
4
+ "wheel"
5
+ ]
6
+ build-backend = "setuptools.build_meta"
7
+
8
+ [project]
9
+ name = "spac_kit"
10
+ version = "0.1.0.dev0"
11
+ description = "Collection of Python tools for working with CCSDS Space Packets"
12
+ authors = [
13
+ { name = "NASA/Caltech/JPL" }
14
+ ]
15
+ license = { file = "LICENSE.md" }
16
+ readme = "README.md"
17
+ requires-python = ">=3.9,<3.10"
18
+ keywords = ["CCSDS", "Space Packets", "Downlink", "Parser", "Documentation"]
19
+ classifiers = [
20
+ "Development Status :: 4 - Beta",
21
+ "Environment :: Console",
22
+ "Intended Audience :: Science/Research",
23
+ "License :: OSI Approved :: Apache Software License",
24
+ "Natural Language :: English",
25
+ "Operating System :: OS Independent",
26
+ "Programming Language :: Python :: 3 :: Only",
27
+ "Topic :: Scientific/Engineering"
28
+ ]
29
+ dependencies = [
30
+ "ccsdspy~=1.3.0",
31
+ "crccheck~=1.3.0"
32
+ ]
33
+
34
+ [project.urls]
35
+ Homepage = "https://github.com/CCSDSPy/SPaC-Kit"
36
+