.. 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`