Metadata-Version: 2.1
Name: locuplot
Version: 0.1.2
Summary: Python application for generating plot from locust statistics csv
Author: pawndev
Author-email: coquelet.c@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: jinja2 (>=2.11.2,<3.0.0)
Requires-Dist: logzero (>=1.5.0,<2.0.0)
Requires-Dist: matplotlib (>=3.2.1,<4.0.0)
Requires-Dist: mpld3 (>=0.3,<0.4)
Requires-Dist: numpy (>=1.18.5,<2.0.0)
Requires-Dist: pandas (>=1.0.4,<2.0.0)
Project-URL: Bug Tracker, https://github.com/pawndev/locuplot/issues
Project-URL: issues, https://github.com/pawndev/locuplot/issues
Description-Content-Type: text/markdown

# Locuplot

Locuplot is a python application to generate graph based on locust statistics reporting.

## Usage
TODO: When we will release locuplot to the pip registry, complete this section.
TODO: Reference how to install the application.
TODO: Reference command line arguments

### Install
Locuplot is available on pypi registry, you can:
```bash
pip install locuplot
```

### Usage

There is a help command `locuplot -h`

To use this project, there is 3 arguments to give.
`locuplot -d example\stats -p sample -e dist`

Arguments list:
- -d | --directory => Specify the folder where the locust stats are.
- -p | --prefix    => The prefix you gave to locust for generated stats
- -e | --export    => The export directory you want png and html generated files (default to `./dist`)

## Local setup

Make sure to install [poetry](https://python-poetry.org/) first. Then, make a `poetry install` in the project
root directory. 

To execute locuplot locally, use this commands:
```bash
poetry run locuplot -d example\stats -p sample
```

For further information you can display the helper like this:

```bash
poetry run locuplot -h
```

### Commands

These custom commands are launched via poetry and an awesome plugin named
[taskipy](https://github.com/illBeRoy/taskipy). Go check out this project !

Non exhaustive custom commands:

| Command                 | Description                                     |
|-------------------------|-------------------------------------------------|
| poetry run task locust  | Run sample locust test                          |
| poetry run task jupyter | Launch jupyter notebook with example statistics |


