balto 0.3.0
BAlto is a Language independent Test Orchestrator
License: MIT
Requires Python: >=3.6,<4.0

# ![Logo of Balto](logo-100x.png) BALTO
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

`BAlto is a Language independent Test Orchestrator` is an unique tool to drive
all your test-runners with one common interface.

## Installation

Install balto with [pipx](https://github.com/cs01/pipx):

```bash
pipx install balto
```

You should see at the end of the command:

```
  These binaries are now globally available
    - balto
    - balto-curses
    - balto-server
done! ✨ �� ✨

```

It is highly recommended to avoid installing Balto in either your global Python environment or a virtual environment as it might causes conflicts with some dependencies.

## Usage

To use it, point balto to a directory containing a `.balto.toml` file:
    
```bash
balto tests/
```

The `.balto.toml` file should look like:

```toml
name = "Acceptance Test Suite Subprocess"
tool = "pytest"

```

If you just want to give Balto a try, you can use the `--tool` to indicate which tool you want to use. For example:

```
balto --tool pytest tests
```

The tool must be one of the supported one, you can see the list here: https://github.com/lothiraldan/litf#compatible-emitters

You can test balto against examples for supported test runners. Clone this repository and launch `balto` against one of the examples directories. For `pytest`, launch:

```bash
balto examples/pytest/
```

For more help:

```bash
balto --help
```


## Development

Balto is composed of two components: the server and the web interface.

> Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Please report unacceptable behavior to [lothiraldan@gmail.com](lothiraldan@gmail.com).

### Balto-server

Balto-server is a Python 3.7 project using Asyncio. To build the development version, first create a virtualenv (or equivalent):

```bash
virtualenv .venv
source .venv/bin/activate
```

Install the project in development mode:

```bash
pip install -e .
```

Then start the server:

```bash
balto-server --debug examples/pytest/
```

The server will start on port 8889.

### Web interface

The web interface is a React project communicating with the server using WebSockets. You can start developing on it with these instructions:

```bash
cd balto/web_interfaces/balto_react
yarn start
```

The web interface is then available on http://localhost:3000/ and will connect to the server started before.

Warning: the WebSocket doesn't auto-reconnect yet, sometimes your React modification requires you to reload your browser tab.

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://lothiraldan.github.io/"><img src="https://avatars2.githubusercontent.com/u/243665?v=4" width="100px;" alt=" Boris Feld"/><br /><sub><b> Boris Feld</b></sub></a><br /><a href="https://github.com/lothiraldan/balto/commits?author=Lothiraldan" title="Code">��</a> <a href="#design-Lothiraldan" title="Design">��</a> <a href="https://github.com/lothiraldan/balto/commits?author=Lothiraldan" title="Documentation">��</a> <a href="#ideas-Lothiraldan" title="Ideas, Planning, & Feedback">��</a> <a href="#talk-Lothiraldan" title="Talks">��</a></td>
    <td align="center"><a href="https://eliasdorneles.github.io"><img src="https://avatars0.githubusercontent.com/u/37565?v=4" width="100px;" alt="Elias Dorneles"/><br /><sub><b>Elias Dorneles</b></sub></a><br /><a href="https://github.com/lothiraldan/balto/commits?author=eliasdorneles" title="Code">��</a> <a href="https://github.com/lothiraldan/balto/issues?q=author%3Aeliasdorneles" title="Bug reports">��</a></td>
    <td align="center"><a href="https://github.com/madprog"><img src="https://avatars0.githubusercontent.com/u/539272?v=4" width="100px;" alt="Paul Morelle"/><br /><sub><b>Paul Morelle</b></sub></a><br /><a href="https://github.com/lothiraldan/balto/commits?author=madprog" title="Code">��</a></td>
  </tr>
</table>

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!