Python support for using the FlockLab testbed (flocklab CLI, creating flocklab xml, visualization).
Project description
FlockLab Tools
This python package provides:
- Python API for managing FlockLab tests
- Command-line interface (CLI) for Interfacing with FlockLab
- Programmatic creation of FlockLab test xml files (in python)
- Visualization of FlockLab test results
Installation
Dependencies:
python3.6+
pip
Install with
python -m pip install flocklab-tools
Uninstall
python3 -m pip uninstall flocklab-tools
Usage
Command Line Interface (CLI)
System wide command:
flocklab -h
Alternative (using the python module):
python3 -m flocklab -h
Command Line Options:
-h, --help show this help message and exit
-v <testconfig.xml>, --validate <testconfig.xml>
validate test config
-c <testconfig.xml>, --create <testconfig.xml>
create / schedule new test
-a <testid>, --abort <testid>
abort test
-d <testid>, --delete <testid>
delete test
-g <testid>, --get <testid>
get test results (via https)
-f <testid>, --fetch <testid>
fetch test results (via webdav) [NOT IMPLEMENTED YET!]
-o <platform>, --observers <platform>
get a list of the currently available (online)
observers
-p, --platforms get a list of the available platforms
-x <result directory>, --visualize <result directory>
Visualize FlockLab result data
Visualization of FlockLab Results
flocklab -x <result directory>
Python Support
Example
from flocklab import Flocklab as fl
from flocklab import *
testId = 0
fl.getResults(testId)
fc = FlocklabXmlConfig()
fc.generalConf.name = 'Example Test'
fc.generalConf.description = 'Description of example test'
fc.generalConf.duration = 60 # duration in seconds
# ...
Development
Bug Reports / Feature Requests
Please send bug reports and feature requests to rtrueb@ethz.ch.
Installation for Development
Clone this repository and run the following from inside the root folder of the project (where setup.py
is located):
python -m pip install -e .
You can edit the source files and the module will reflect the changes automatically (the -e
option which means editable install).
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
flocklab-tools-0.1.0.tar.gz
(11.7 kB
view hashes)
Built Distribution
Close
Hashes for flocklab_tools-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1afb27d93ae89804ffaf78e4ea7042ddeef650ccfb0d48ae63483d8367b3eb9f |
|
MD5 | 387933e5d4db6d0f1cf6e3860e713a54 |
|
BLAKE2b-256 | 25929dfac2f75f45d35ab7b15b76f610c57263979dad3f68ff2f02635395054d |