Skip to main content

Plot Google Benchmark results

Project description

# ScopePlot

[![Build Status](https://travis-ci.com/rai-project/scope_plot.svg?branch=master)](https://travis-ci.com/rai-project/scope_plot)


Plot Google Benchmark results

## Getting Started with ScopePlot

ScopePlot is available on [PyPI](https://pypi.org/project/scope-plot/) can be installed with `pip`

$ python -m pip install scope_plot

To install the latest development version from [Github](https://github.com/rai-project/scope_plot)

$ python -m pip install git+git://github.com/rai-project/scope_plot.git

If your current Python installation doesn't have pip available, try [get-pip.py](bootstrap.pypa.io)

After installing ScopePlot you can use it like any other Python module.
Here's a very simple example:

```bash
$ python -m scope_plot bar data.json
```

There are multiple subcommands available

```
$ python -m scope_plot --help

Usage: __main__.py [OPTIONS] COMMAND [ARGS]...

Options:
--debug / --no-debug print debug messages to stderr.
--include DIRECTORY Search location for input_file in spec.
--help Show this message and exit.

Commands:
bar Create a bar graph from BENCHMARK and write...
deps Create a Makefile dependence
spec Create a figure from a spec file
```

More information about the subcommands can be accessed with `python -m scope_plot COMMAND --help`, and also in the documentation: [bar](docs/bar.md), [spec](docs/spec.md), [deps](docs/makefiles.md).

API Reference
-------------

coming soon...

Support / Report Issues
-----------------------

All support requests and issue reports should be
[filed on Github as an issue](https://github.com/rai-project/scope_plot/issues).
Make sure to follow the template so your request may be as handled as quickly as possible.
Please respect contributors by not using personal contacts for support requests.

Contributing
------------

We happily welcome contributions, please see [our guide for Contributors](CONTRIBUTORS.md) for the best places to start and help.

License
-------

scope_plot is made available under the MIT License. For more details, see [LICENSE.txt](https://github.com/rai-project/scope_plot/blob/master/LICENSE.txt).


Changelog
=========

Release 0.1.3 (Development)
---------------------------

* Change documentation to docsify
* Fix a bug with unexpected "strict" argument

Release 0.1.2 (Development)
---------------------------

* rename to `scope_plot`
* Initial support for `spec` and `bar` subcommands.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scope_plot-0.1.5.tar.gz (15.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page