BotBlox Manager CLI tool
Project description
BotBlox software
Software created by BotBlox to configure settings on our products
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
Welcome to BotBlox Software. We designed this software to go along with our firmware to allow our community of customers and developers to manually configure custom settings on BotBlox products, such as the SwitchBlox: our flagship Ethernet switch. For a while now, our customers have requested that they want to be able to program VLAN membership, Quality-of-service, Port mirroring, etc on our products. The software comes as a packaged module that you can use as a CLI application. This can be further extended on request to an application that can be used cleanly with a Python codebase. This application was designed with developers in mind; to make developing features for this application as simple as possible. We very much encourage people to point out improvements, bugs or missing features they want implemented as we want to be very responsive to the needs of both the developer and customer.
Built With
Installation
You'll need to install Python version 3.6+ in order to use this application.
pip install botblox
Usage
Before using the software, it is recommended that you create a python virtual environment in the project directory that you use. There are multiple ways to do this. The easiest way to do this is using the venv module, which is part of the Python standard library. You can check the docks here.
In short;
- In your shell, navigate to project root:
cd /path/to/project/root - Execute command in your shell
python -m venv /path/to/virtual/environment
For example: python -m venv botblox-env
- Execute in your shell
source /path/to/virtual/environment
For example: source botblox-env
4) Execute pip install botblox to install the package in the virtual environment
For specific information on what commands you can run, refer to the Documentation
Testing
python -m pytest tests/
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Please also note the Developer Guidelines that BotBlox kindly asks of all those who are generous enough to devote their time using or developing on this product.
License
Distributed under the MIT License. See LICENSE for more information.
Contact
Project Link: https://github.com/botblox/botblox-manager-software
Acknowledgements
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.
