README.md

BlueEngine

BlueEngine is the Python CLI package for the WAFER Project. The project serves as the brains of the project. All of the research, implementation, development, packaging and distribution is done through this project's releases. The package itself is a python virtual environment that can be installed or run locally as a command line interface utility.

Getting Started

To get this package, download it through releases or to get souruce code,

git clone https://github.com/WAFERed/BlueEngine.git

The dependencies are listed in the requiremments.txt package and can be automatically installed by following the below setup instructions.

---

Setup

To enter venv (virtual environment) on Unix-based systems,

source venv/bin/activate

To pull package dependencies,

pip install -r requirements.txt

To install package,

pip install --editable .

To use package,

blue [--OPTIONS] [COMMAND] [ARGUMENTS]

To get list of available commands and help,

blue --help

Generating A Release

To generate a .whl release package yourself, run the shell script in the root directory,

sh buildwhl.sh

Contributing

To contribute, fork the project or create a pull request. Alternatively, contact us using any of the below methods,

• Email Address: email.wafer@gmail.com
• Website: projectwafer.com