cfdp-py 0.1.0__tar.gz

cfdp-py-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+Change Log
+=======
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+# [unreleased]
+
+# [v0.1.0]
+
+Initial release of the `cfdp-py` library which was split off the
+[tmtccmd library](https://github.com/robamu-org/tmtccmd).

cfdp-py-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cfdp-py-0.1.0/MANIFEST.in

@@ -0,0 +1,12 @@
+include LICENSE
+include NOTICE
+include CHANGELOG.md
+
+graft docs
+prune docs/_build
+
+graft tests
+
+include requirements.txt
+
+recursive-exclude * *.pyc *.pyo

cfdp-py-0.1.0/NOTICE

@@ -0,0 +1,3 @@
+cfdpy - A library for high level CCSDS File Delivery Protocol (CFDP) components.
+
+This software contains code developed at the University of Stuttgart's Institute of Space Systems.

cfdp-py-0.1.0/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.1
+Name: cfdp-py
+Version: 0.1.0
+Summary: Library for high level CCSDS File Delivery Protocol (CFDP) components
+Author-email: Robin Mueller <robin.mueller.m@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/us-irs/cfdp-py
+Keywords: ccsds,space,communication,packet,file-transfer
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Communications
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: spacepackets~=0.23.0
+Requires-Dist: crcmod~=1.7
+Requires-Dist: deprecation~=2.1
+Provides-Extra: test
+Requires-Dist: pyfakefs~=4.5; extra == "test"
+
+[![ci](https://github.com/us-irs/cfdp-py/actions/workflows/ci.yml/badge.svg)](https://github.com/us-irs/cfdp-py/actions/workflows/ci.yml)
+[![Documentation Status](https://readthedocs.org/projects/cfdp-py/badge/?version=latest)](https://cfdp-py.readthedocs.io/en/latest/?badge=latest)
+[![codecov](https://codecov.io/gh/us-irs/cfdp-py/graph/badge.svg?token=FBL1NR54BI)](https://codecov.io/gh/us-irs/cfdp-py)
+[![PyPI version](https://badge.fury.io/py/cfdppy.svg)](https://badge.fury.io/py/cfdppy)
+
+cfdp-py - High level Python library for CFDP components
+======================
+
+The `cfdp-py` library offers some high-level CCSDS File Delivery Protocol (CFDP) components to
+perform file transfers according to the [CCSDS Blue Book 727.0-B-5](https://public.ccsds.org/Pubs/727x0b5.pdf).
+The underlying base packet library used to generate the packets to be sent is the
+[spacepackets](https://github.com/us-irs/spacepackets-py) library.
+
+# Install
+
+You can install this package from PyPI
+
+Linux:
+
+```sh
+python3 -m pip install cfdppy 
+```
+
+Windows:
+
+```sh
+py -m pip install cfdppy 
+```
+
+# Examples
+
+You can find all examples [inside the documentation](https://cfdp-py.readthedocs.io/en/latest/examples.html) and the `examples` directory of this repository.
+
+# Tests
+
+If you want to run the tests, it is recommended to install `pytest` and `coverage` (optional)
+first. You also have to install the package with the optional `test` feature:
+
+```sh
+pip install coverage pytest
+pip install cfdppy[test]
+```
+
+Running tests regularly:
+
+```sh
+pytest .
+```
+
+Running tests with coverage:
+
+```sh
+coverage run -m pytest
+```
+
+# Documentation
+
+The documentation is built with Sphinx
+
+Install the required dependencies first:
+
+```sh
+pip install -r docs/requirements.txt
+```
+
+Then the documentation can be built with
+
+```sh
+cd docs
+make html
+```
+
+You can run the doctests with
+
+```sh
+make doctest
+```

cfdp-py-0.1.0/README.md

@@ -0,0 +1,77 @@
+[![ci](https://github.com/us-irs/cfdp-py/actions/workflows/ci.yml/badge.svg)](https://github.com/us-irs/cfdp-py/actions/workflows/ci.yml)
+[![Documentation Status](https://readthedocs.org/projects/cfdp-py/badge/?version=latest)](https://cfdp-py.readthedocs.io/en/latest/?badge=latest)
+[![codecov](https://codecov.io/gh/us-irs/cfdp-py/graph/badge.svg?token=FBL1NR54BI)](https://codecov.io/gh/us-irs/cfdp-py)
+[![PyPI version](https://badge.fury.io/py/cfdppy.svg)](https://badge.fury.io/py/cfdppy)
+
+cfdp-py - High level Python library for CFDP components
+======================
+
+The `cfdp-py` library offers some high-level CCSDS File Delivery Protocol (CFDP) components to
+perform file transfers according to the [CCSDS Blue Book 727.0-B-5](https://public.ccsds.org/Pubs/727x0b5.pdf).
+The underlying base packet library used to generate the packets to be sent is the
+[spacepackets](https://github.com/us-irs/spacepackets-py) library.
+
+# Install
+
+You can install this package from PyPI
+
+Linux:
+
+```sh
+python3 -m pip install cfdppy 
+```
+
+Windows:
+
+```sh
+py -m pip install cfdppy 
+```
+
+# Examples
+
+You can find all examples [inside the documentation](https://cfdp-py.readthedocs.io/en/latest/examples.html) and the `examples` directory of this repository.
+
+# Tests
+
+If you want to run the tests, it is recommended to install `pytest` and `coverage` (optional)
+first. You also have to install the package with the optional `test` feature:
+
+```sh
+pip install coverage pytest
+pip install cfdppy[test]
+```
+
+Running tests regularly:
+
+```sh
+pytest .
+```
+
+Running tests with coverage:
+
+```sh
+coverage run -m pytest
+```
+
+# Documentation
+
+The documentation is built with Sphinx
+
+Install the required dependencies first:
+
+```sh
+pip install -r docs/requirements.txt
+```
+
+Then the documentation can be built with
+
+```sh
+cd docs
+make html
+```
+
+You can run the doctests with
+
+```sh
+make doctest
+```

cfdp-py-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

cfdp-py-0.1.0/docs/api/cfdp.handler.rst

@@ -0,0 +1,34 @@
+CFDP Handler Package
+=============================
+
+Package Contents
+-----------------
+
+.. automodule:: cfdppy.handler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Source Handler Module
+-------------------------------------
+
+.. automodule:: cfdppy.handler.source
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Destination Handler Module
+-------------------------------------
+
+.. automodule:: cfdppy.handler.dest
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Defintions Module
+-------------------------------------
+
+.. automodule:: cfdppy.handler.defs
+   :members:
+   :undoc-members:
+   :show-inheritance:

cfdp-py-0.1.0/docs/api/cfdp.rst

@@ -0,0 +1,59 @@
+CFDP Package
+=============
+
+Module contents
+---------------
+
+.. automodule:: cfdppy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Filestore Module
+-------------------------------
+
+.. automodule:: cfdppy.filestore
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Management Information Base (MIB) Module
+-------------------------------------------
+
+.. automodule:: cfdppy.mib
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Request Module
+-------------------------------
+
+.. automodule:: cfdppy.request
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+User Module
+-------------------------------
+
+.. automodule:: cfdppy.user
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Exceptions Module
+-------------------------------------------
+
+.. automodule:: cfdppy.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Definitions Module
+--------------------------
+
+.. automodule:: cfdppy.defs
+   :members:
+   :undoc-members:
+   :show-inheritance:

cfdp-py-0.1.0/docs/api.rst

@@ -0,0 +1,10 @@
+====
+API
+====
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Contents:
+
+  api/cfdp
+  api/cfdp.handler

cfdp-py-0.1.0/docs/conf.py

@@ -0,0 +1,77 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+from importlib.metadata import version
+
+project = "cfdp-py"
+copyright = "2024, Robin Mueller"
+author = "Robin Mueller"
+
+# The full version, including alpha/beta/rc tags
+release = version = version("cfdp-py")
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.doctest",
+    "sphinx_rtd_theme",
+]
+
+# Disable the doctests of the full package because those would require the explicit specification
+# of imports. The doctests inside the source code are covered by pytest, using the --doctest-modules
+# configuration option.
+doctest_test_doctest_blocks = ""
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# Mapping for external packages
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "crcmod": ("https://crcmod.sourceforge.net/", None),
+}
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]

cfdp-py-0.1.0/docs/examples.rst

@@ -0,0 +1,18 @@
+=====================
+Example applications
+=====================
+
+You can find an example application inside the
+`example directory <https://github.com/robamu-org/tmtccmd/tree/main/examples/cfdp-simple>`_
+which shows an end-to-end file transfer on a host computer. This should give you a general idea of
+how the source and destination handler work in practice.
+
+There is also a
+`test application <https://github.com/robamu-org/tmtccmd/tree/main/examples/cfdp-libre-cube-crosstest>`_
+which cross-tests the `tmtccmd` CFDP implementation with the
+`Libre Cube CFDP <https://gitlab.com/librecube/lib/python-cfdp>`_ implementation.
+
+Finally, you can see a more complex example also featuring more features of the CFDP state machines
+`here <https://github.com/robamu-org/tmtccmd/tree/main/examples/cfdp-cli-udp>`_. This example
+uses UDP servers for communication and explicitely separates the local and remote entity
+application.

cfdp-py-0.1.0/docs/index.rst

@@ -0,0 +1,33 @@
+.. cfdpy documentation master file, created by
+   sphinx-quickstart on Tue Jan 23 21:37:44 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. _cfdp:
+
+==============================================================
+cfdp-py - A library for the CCSDS File Delivery Protocol (CFDP)
+==============================================================
+
+The ``cfdp-py`` library offers some high-level CCSDS File Delivery Protocol (CFDP) components to
+perform file transfers according to the `CCSDS Blue Book 727.0-B-5`_. The underlying base packet
+library used to generate the packets to be sent is the `spacepackets`_ library.
+
+.. _`CCSDS Blue Book 727.0-B-5`: https://public.ccsds.org/Pubs/727x0b5.pdf
+.. _`spacepackets`: https://github.com/us-irs/spacepackets-py
+
+.. toctree::
+  :maxdepth: 2
+  :caption: Contents:
+
+  introduction
+  examples
+  api
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`