Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bencheeorg/benchee_csv
Output your Benchee benchmarks as CSV to generate graphs in your favorite spreadsheet tool!
https://github.com/bencheeorg/benchee_csv
benchee benchmarking csv formatter plugin spreadsheet
Last synced: about 1 month ago
JSON representation
Output your Benchee benchmarks as CSV to generate graphs in your favorite spreadsheet tool!
- Host: GitHub
- URL: https://github.com/bencheeorg/benchee_csv
- Owner: bencheeorg
- License: mit
- Created: 2016-06-05T17:36:38.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-12-10T10:23:33.000Z (about 1 year ago)
- Last Synced: 2024-10-30T02:03:54.519Z (about 2 months ago)
- Topics: benchee, benchmarking, csv, formatter, plugin, spreadsheet
- Language: Elixir
- Size: 113 KB
- Stars: 10
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# benchee_csv [](https://hex.pm/packages/benchee_csv) [](https://hexdocs.pm/benchee_csv/) [](https://github.com/bencheeorg/benchee_csv/actions/workflows/main.yml) [](https://coveralls.io/github/bencheeorg/benchee_csv?branch=main)
Formatter for [benchee](https://github.com/PragTob/benchee) to turn the statistics output into a CSV file. This can then be used in the Spreadsheet tool of your choice to generate graphs to your liking.
These might then look like this one (quickly generated with LibreOffice from the output of the sample):
## Installation
Add benchee_csv to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:benchee_csv, "~> 1.0", only: :dev}]
end
```
Afterwards, run `mix deps.get` to install it.
## Usage
Simply configure `Benchee.Formatters.CSV` as one of the formatters for `Benchee.run/2` along with the file path you want the output to go (otherwise defaults to "benchmark_output.csv"):
```elixir
list = Enum.to_list(1..10_000)
map_fun = fn i -> [i, i * i] end
Benchee.run(
%{
"flat_map" => fn -> Enum.flat_map(list, map_fun) end,
"map.flatten" => fn -> list |> Enum.map(map_fun) |> List.flatten() end
},
formatters: [
{Benchee.Formatters.CSV, file: "my.csv"},
Benchee.Formatters.Console
]
```
The sample defines both the standard console formatter and the CSV formatter, if you don't care about the console output you can just delet that line.
You can also use the more verbose and versatile API of Benchee. When it comes to formatting just use `Benchee.Formatters.CSV.format/2` and then write it to a file (taking into account the new input structure). Check out the [samples directory](https://github.com/PragTob/benchee_csv/tree/master/samples) for the verbose samples to see how it's done.
## Contributing
Contributions to benchee_csv are very welcome! Bug reports, documentation, spelling corrections, whole features, feature ideas, bugfixes, new plugins, fancy graphics... all of those (and probably more) are much appreciated contributions!
Please respect the [Code of Conduct](//github.com/PragTob/benchee_csv/blob/master/CODE_OF_CONDUCT.md).
You can get started with a look at the [open issues](https://github.com/PragTob/benchee_csv/issues).
A couple of (hopefully) helpful points:
* Feel free to ask for help and guidance on an issue/PR ("How can I implement this?", "How could I test this?", ...)
* Feel free to open early/not yet complete pull requests to get some early feedback
* When in doubt if something is a good idea open an issue first to discuss it
* In case I don't respond feel free to bump the issue/PR or ping me on other places
## Development
* `mix deps.get` to install dependencies
* `mix test` to run tests
* `mix credo` or `mix credo --strict` to find code style problems (not too strict with the 80 width limit for sample output in the docs)