Metadata-Version: 2.1
Name: brad
Version: 0.1.0a2
Summary: Brad is a Python package for Bootstrap, permutation tests and other resampling functions.
Home-page: https://github.com/tcbegley/brad
Author: tcbegley
Author-email: tomcbegley@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
Requires-Dist: numpy (<2.0.0,>=1.18.0)
Requires-Dist: scikit-learn (>0.24.0)
Requires-Dist: scipy (<2.0.0,>=1.4.1)
Requires-Dist: importlib-metadata (<4.0.0,>=3.4.0) ; python_version == "3.7"

# Brad

![gh-actions](https://github.com/tcbegley/brad/workflows/Tests/badge.svg)
[![codecov](https://codecov.io/gh/tcbegley/brad/branch/main/graph/badge.svg?token=aJUDsDeu1t)](https://codecov.io/gh/tcbegley/brad)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/brad)
![PyPI - License](https://img.shields.io/pypi/l/brad)


Brad is a Python package for Bootstrap, permutation tests and other resampling
functions.

## Development

You can install `brad` and its dependencies from source from the root of this
repo with

```sh
python -m pip install .
```

Tests and linters are run with [`nox`][nox]. Install with

```sh
python -m pip install nox
```

You can then run one of the pre-configured nox "sessions" with

```sh
nox -s lint
```

The available sessions are:
- `lint`: run source code linters (`black`, `flake8`, `isort`, `mypy`)
- `test`: run test suite with PyTest. Will try to run on Python 3.7, 3.8 and
3.9.
- `test-3.x`: run tests for only Python 3.x (replace x with 7, 8, or 9)
- `format`: format source code with `black` and `isort`.

Running only the command

```sh
nox
```

will run `lint` and `test` by default (so in particular `nox` will not format
the source code unless explicitly told to do so).

[nox]: https://nox.thea.codes


