Skip to content

A CLI utility to use the airborne.cam app to process several rooms at once, under multiple conditions from an input file

License

Notifications You must be signed in to change notification settings

drearondov/airborne-cli

Airborne CLI

Note: This project is still under active development/testing.

Python Version License Tests Codecov pre-commit Black

A CLI utility to use the airborne.cam app to process several rooms at once, under multiple conditions from an input file size.

Features

  • Support to process data in a .xlsx, .csv or .json format
  • Fully configurable default mode for fast running
  • Exports graphics in png and html(coming soon) format for risk analysis.

Requirements

To install and use the program Python >= 3.10 is required.

Install

Note: This package is still under development, and as such it has not been published to PyPI. Also, because of the nature of the package I haven't decided if it'll ever be.

Package instalation

If you still would like to use this tools, you can get the latest version of Airborne CLI following this steps.

repo='https://github.com/drearondov/airborne-cli'

# Find the latest release.
latest=$(git ls-remote --tags --refs $repo | # Fetch remote tags.
                 sort -t '/' -k 3 -V |       # Sort them by version.
                 tail -n 1 |                 # Take the latest one.
                 awk -F / '{print $3}')      # Return only the tag.

# Craft the URL for the release asset.
version=$(echo $latest | tr -d 'v')  # Remove the leading v.
wheel="airborne-cli-${version}-py3-none-any.whl"
release="${repo}/releases/download/${latest}/${wheel}"

# Install the release.
pip install $release

Building from source

To build the package straight from source, there are two requirements.

  1. Python 3.10 and higher
  2. Poetry package manager

With that, you can clone or download the repo into you machine, and use Poetry to install.

git clone https://github.com/drearondov/airborne-cli.git
cd airborne-cli
poetry install

Usage

Please see the Command-line Reference for details.

Contributing

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

License

Distributed under the terms of the GPL 3.0 license, Airborne CLI is free and open source software.

Issues

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

Credits

About

A CLI utility to use the airborne.cam app to process several rooms at once, under multiple conditions from an input file

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages