Metadata-Version: 2.1
Name: speakerbox
Version: 0.0.2
Summary: Speaker Annotation for Transcripts using Audio Classification
Home-page: https://github.com/CouncilDataProject/speakerbox
Author: Jackson Maxfield Brown
Author-email: jmaxfieldbrown@gmail.com
License: MIT license
Keywords: speakerbox
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: setup
Provides-Extra: test
Provides-Extra: dev
Provides-Extra: all
License-File: LICENSE

# speakerbox

[![Build Status](https://github.com/CouncilDataProject/speakerbox/workflows/Build/badge.svg)](https://github.com/CouncilDataProject/speakerbox/actions)
[![Documentation](https://github.com/CouncilDataProject/speakerbox/workflows/Documentation/badge.svg)](https://CouncilDataProject.github.io/speakerbox)
[![Code Coverage](https://codecov.io/gh/CouncilDataProject/speakerbox/branch/main/graph/badge.svg)](https://codecov.io/gh/CouncilDataProject/speakerbox)

Speaker Annotation for Transcripts using Audio Classification

---

## Installation

**Stable Release:** `pip install speakerbox`<br>
**Development Head:** `pip install git+https://github.com/CouncilDataProject/speakerbox.git`

## Documentation

For full package documentation please visit [councildataproject.github.io/speakerbox](https://councildataproject.github.io/speakerbox).

## Quickstart

Load the 2021 Seattle Prototype Dataset, get summary statistics
about speaker time, finally pull the matching audio file for each annotation file
and store annotation file matched to audio as a `pandas.DataFrame`.

```python
from speakerbox import datasets

seattle_2021_ds_dir = datasets.unpack_seattle_2021_proto(clean=True)
seattle_2021_ds_summary_stats = datasets.summarize_annotation_statistics(
    seattle_2021_ds_dir / "annotations"
)
seattle_2021_ds = datasets.pull_seattle_2021_proto_audio()
```

## Development

See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.

**MIT license**


