Common Python libraries used by parts of Bell AVR
Project description
AVR-Python-Libraries
Install
To install the base package, run:
pip install bell-avr-libraries
Additionally, the serial
and qt
extras are available if you want to use
the PCC or PySide functionality.
pip install bell-avr-libraries[serial,qt]
Usage
See the documentation website at https://bellflight.github.io/AVR-Python-Libraries
Development
It's assumed you have a version of Python installed from
python.org that is the same or newer as
defined in the .python-version
file.
First, install Poetry:
python -m pip install pipx --upgrade
pipx ensurepath
pipx install poetry
# (Optionally) Add pre-commit plugin
poetry self add poetry-pre-commit-plugin
Now, you can clone the repo and install dependencies:
git clone https://github.com/bellflight/AVR-Python-Libraries
cd AVR-Python-Libraries
poetry install --sync --all-extras
poetry run pre-commit install --install-hooks
Run
poetry shell
to activate the virtual environment.
Build the auto-generated code with poetry run python build.py
. From here,
you can now produce a package with poetry build
.
To add new message definitions, add entries to the bell/avr/mqtt/asyncapi.yml
file.
This is an AsyncAPI definition,
which is primarily JSONSchema with some association
of classes and topics.
The generator that turns this definition file into Python code is the homebrew build.py, so double-check that the output makes sense.
To generate the documentation, run the build.py
script with the --docs
option.
This requires that Node.js is installed, and npm
install has been run.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bell_avr_libraries-0.2.0a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3718468c1e1e0347d83d0d2bf18b10cde37f20c3e732ee82e0c2ff9a799edc19 |
|
MD5 | 580df2ad2e1ce70886f42d2a66aa857a |
|
BLAKE2b-256 | 9b6a7840ab9861165a7afd529bd810e3ff2be733d20ef3d0c39b784d0f4e0912 |
Hashes for bell_avr_libraries-0.2.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95c1f447c20cf48aac016c4a34967aec3614641f9ef836e8c00e1117ea062288 |
|
MD5 | 88d337fe359d0d3da6d5ea36c7079ea0 |
|
BLAKE2b-256 | ddd3a5267d1ae4a3c4f009c585b92aac34f8e13d89c5e5751f7ddc29ff530525 |