Metadata-Version: 2.1
Name: running-ng
Version: 0.4.2
Summary: Running: Next Generation
Author-email: Zixian Cai <u5937495@anu.edu.au>
License: Apache
Project-URL: Homepage, https://github.com/anupli/running-ng
Project-URL: Bug Tracker, https://github.com/anupli/running-ng/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: System :: Benchmark
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyyaml~=6.0
Provides-Extra: zulip
Requires-Dist: zulip~=0.8.2; extra == "zulip"
Provides-Extra: tests
Requires-Dist: pytest<7.5.0,>=7.1.3; extra == "tests"
Requires-Dist: types-PyYAML~=6.0.11; extra == "tests"
Requires-Dist: mypy<2.0,>=0.971; extra == "tests"

# `running-ng`
`running-ng` is a collection of scripts that help people run workloads in a methodologically sound settings.

## Installation
`pip3 install running-ng`

## Development setup
```console
virtualenv env
source env/bin/activate
pip install -U pip setuptools build[virtualenv]
```

To make a distribution archives, run `python -m build` within the virtual environment.
To run an editable build in the virtual environment, run `pip install -e .`.
To install to user `site-packages`, run `pip install dist/running_ng-<VERSION>-py3-none-any.whl` outside the virtual environment.

There are two [extras](https://peps.python.org/pep-0508/#extras) available.
- `zulip`: dependencies for the `Zulip` `runbms` plugin.
- `tests`: dependencies for running tests.

## Documentation
Please refer to [this site](https://anupli.github.io/running-ng/) for up-to-date documentations.

## License
This project is licensed under the Apache License, Version 2.0.
