Parasect#

PyPI Status Python Version License

Read the documentation at https://parasect.readthedocs.io/ Tests Codecov

pre-commit Black

Welcome to Parasect, a utility for manipulating parameter sets for autopilots!

Features#

Parasect has two-fold capabilities:

  1. Compare two parameter sets and highlighting their differences.

  2. Parsing from user-defined content and generating new parameter sets, ready for loading into an autopilot.

List of currently supported autopilots:

Requirements#

Parasect is a pure-Python project. Its requirements are managed by the Poetry dependency manager. When you install Parasect via pip its requirements will also be installed automatically.

Currently Parasect has been tested:

  • in Continuous Integration servers for Ubuntu Linux, Windows

  • manually in Ubuntu Linux.

Installation#

You can install Parasect via pip from PyPI:

$ pip install parasect

If you don’t care about using Parasect as a library and are only interested in command-line use, you can also use pipx, that provides better isolation from the rest of the system:

$ pipx install parasect

Usage#

Parasect is primarily used as a command-line program. In its simplest form, two parameter files can be compared via:

$ parasect compare <FILE_1> <FILE_2>

The usage for building parameter sets is more involved. Please see the Command-line Reference for details.

Additionally, it exposes a minimal API, enabling automated operations. This is described in the API Reference.

It is strongly recommended that you read the Concepts that Parasect employs, if you plan to make full use of it.

Contributing#

Contributions are very welcome. To learn more, see the Contributor Guide.

License#

Distributed under the terms of the MIT license, Parasect is free and open source software.

Issues#

If you encounter any problems, please file an issue along with a detailed description.

Credits#

This project was sponsored by Avy B.V., a UAV company in Amsterdam.

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.

The project logo was created by Cynthia de Vries.