A collection of benchmarking tools.
Project description
Benchmark Utilities
About
A collection of benchmarking tools. PYPI Package
Table of Contents
Using the library
Installing and using the library
First, you need to install the library either using pip:
$ pip install bench_utils
Then, import it and use it like so:
from bench_utils import timeit, profileit
# --- Timeit --- #
# Context Manager
with timeit():
# A code block
pass
@timeit()
def my_func():
# Function code
pass
# --- Profileit --- #
# Context Manager
with profileit():
# A code block
pass
@profileit()
def my_func():
# Function code
pass
For more advanced examples check example_timeit.py and example_profileit.py .
Manually install the library
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Prerequisites
You need to have a machine with anaconda installed and any Bash based shell (e.g. zsh) installed.
$ conda -V
conda 4.10.1
$ echo $SHELL
/usr/bin/zsh
Install the requirements
All the installation steps are being handled by the Makefile.
First, modify the python version (min_python
) and everything else you need in
the settings.ini.
Then, execute the following commands:
$ make create_env
$ conda activate yaml_config_wrapper
$ make dist
Now you are ready to use and modify the library.
Update PyPI package
This is mainly for future reference for the developers of this project. First,
create a file called ~/.pypirc
with your pypi login details, as follows:
[pypi]
username = your_pypi_username
password = your_pypi_password
Then, modify the python version (min_python
), project status (status
), release version (version
)
and everything else you need in
the settings.ini.
Finally, execute the following commands:
$ make create_env
$ conda activate yaml_config_wrapper
$ make release
For a dev release, change the testing_version
and instead of make release
, run make release_test
.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bench_utils-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d91ec46e10c3eb6243291f6f353361c70184dd6a4bef68cac9d97439233a04b |
|
MD5 | c0646e26c2c47cbf6360582b034ecb44 |
|
BLAKE2b-256 | 45297cd1aab9288b154918793e87fc9d7d3a07baa61cf5d4b90d5cb30e67cf30 |