Metadata-Version: 2.3
Name: speechscore
Version: 0.0.1
Summary: speechscore is a Python package for benchmarking models on speech perception behavioral and neural data.
License: Apache-2.0
Keywords: python,package,template
Author: gelbanna
Author-email: gelbanna@mit.edu
Maintainer: gelbanna
Maintainer-email: gelbanna@mit.edu
Requires-Python: >=3.10,<3.13
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Dist: click (>=8.2,<9.0)
Description-Content-Type: text/markdown

# The ```speechscore``` repo

[![Build](https://github.com/mcdermottLab/speech-score.git/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/mcdermottLab/speech-score.git/actions/workflows/test.yaml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/gelbanna/speechscore/branch/main/graph/badge.svg?token=CODECOV_TOKEN)](https://codecov.io/gh/gelbanna/speechscore)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![PyPI](https://img.shields.io/pypi/v/speechscore.svg)](https://pypi.org/project/speechscore/)
[![Python Version](https://img.shields.io/pypi/pyversions/speechscore)](https://pypi.org/project/speechscore)
[![License](https://img.shields.io/pypi/l/speechscore)](https://opensource.org/licenses/Apache-2.0)

[![pages](https://img.shields.io/badge/api-docs-blue)](https://gelbanna.github.io/speechscore)

Welcome to the ```speechscore``` repo! This is a Python package for doing incredible stuff.

**Caution:**: this package is still under development and may change rapidly over the next few weeks.

## Features
- A few
- Cool
- Things
- These may include a wonderful CLI interface.

## Installation
Install this package via :

```sh
pip install speechscore
```

Or get the newest development version via:

```sh
pip install git+https://github.com/mcdermottLab/speech-score.git.git
```

## Quick start
```Python
from speechscore.app import hello_world

hello_world()
```

## To do:
- [ ] A
- [ ] lot

