BrainFrame CLI

The BrainFrame CLI is a tool for installing and managing a BrainFrame server.

Installation

The CLI is installable with Pip. Ubuntu 18.04 and 20.04 are officially supported, but other versions of Linux are expected to work as well.

On Ubuntu:

sudo -H pip3 install brainframe-cli

Upgrading

Pip can be used to upgrade to a new version.

sudo -H pip3 install --upgrade brainframe-cli

Usage

To install BrainFrame, simply run the install command as root:

sudo brainframe install

BrainFrame can then be controlled like a normal Docker Compose application using the compose command, which can be run from any directory.

brainframe compose up -d

For more information, take a look at the Getting Started guide.

Contributing

We happily take community contributions! If there's something you'd like to work on, but you're not sure how to start, feel free to create an issue on Github and we'll try to point you in the right direction.

We use a couple formatting tools to keep our code style consistent. If you get any CI failures, you can run the following commands to automatically format your code to fit our guidelines:

pip install poetry==1.8.3
poetry install
poetry run isort .
poetry run black .

Build & install local build for test:

python3 deployment/build.py --version 3.8
python3 deployment/build.py --version 3.10 3.12
pip install dist/brainframe_cli-0.3.0-py3-none-any.whl

The above build.py will copy pyproject.toml & poetry.lock in deployment folder to the project root, and automatically run poetry build. Similar to below,

poetry build
pip install dist/brainframe_cli-0.3.0-py3-none-any.whl

The wheel build & test commands have been integrated in deployment/do script, which support build & test on Ubuntu 18.04/20.04/22.04/24.04

deployment/do

Pyinstaller build:

The result will be in the dist/ directory

pyinstaller package/main.spec