Metadata-Version: 2.1
Name: oresat-olaf
Version: 1.0.0
Summary: Application framework for all OreSat Linux boards
Home-page: https://github.com/oresat/oresat-olaf
Author: PSAS
Author-email: oresat@pdx.edu
Maintainer: PSAS
Maintainer-email: oresat@pdx.edu
License: GPL-3.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE

OLAF (OreSat Linux App Framework)
=================================

.. image:: https://img.shields.io/github/license/oresat/oresat-olaf
   :target: https://github.com/oresat/oresat-olaf/blob/master/LICENSE
   :alt: License
.. image:: https://img.shields.io/github/issues/oresat/oresat-olaf
   :target: https://github.com/oresat/oresat-olaf/issues
   :alt: Issues
.. image:: https://readthedocs.org/projects/oresat-olaf/badge/?version=latest
   :target: https://oresat-olaf.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
.. image:: https://github.com/oresat/oresat-olaf/actions/workflows/tests.yaml/badge.svg
   :target: https://github.com/oresat/oresat-olaf/actions/workflows/tests.yaml
   :alt: Test Status

A pythonic CANopen application framework for all OreSat Linux boards. Built
ontop on `python-canopen`_. It is designed to handle all the common OreSat
`CANopen`_ Node functionality including support for `ECSS CANBus Extended
Protocol`_, file transfer over CAN, and updating the Linux board.

Installing
----------

Install using pip:

.. code-block:: text

   $ pip install oresat-olaf

Contributing
------------

For guidance on setting up a development environment and how to contribution
to OLAF, see the `<CONTRIBUTING.rst>`_.

.. References
.. _unittest: https://docs.python.org/3/library/unittest.html#module-unittest
.. _sphinx: https://www.sphinx-doc.org/en/master/
.. _python-canopen: https://github.com/christiansandberg/canopen
.. _CANopen: https://www.can-cia.org/canopen
.. _ECSS CANBus Extended Protocol: https://ecss.nl/standard/ecss-e-st-50-15c-space-engineering-canbus-extension-protocol-1-may-2015/
