Metadata-Version: 2.1
Name: easybird
Version: 0.0.3a1
Summary: A python toolkit for Bird Activity Detection (BAD)
Home-page: https://github.com/realzza/easybird
Author: Ziang Zhou
Author-email: ziang.zhou518@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/realzza/easybird/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: audiofile
Requires-Dist: torch
Requires-Dist: torchaudio
Requires-Dist: torchvision
Requires-Dist: soxr
Requires-Dist: tqdm
Requires-Dist: scipy
Requires-Dist: python-speech-features

# easybird
![PyPI](https://img.shields.io/pypi/v/easybird?color=df&style=flat)&nbsp;
![GitHub](https://img.shields.io/github/license/realzza/easybird?color=%23FFB6C1&style=flat)&nbsp;
![GitHub last commit](https://img.shields.io/github/last-commit/realzza/easybird?color=orange&style=flat)&nbsp;
![GitHub top language](https://img.shields.io/github/languages/top/realzza/easybird?color=%236495ed&style=flat)&nbsp;
[![CodeFactor](https://www.codefactor.io/repository/github/realzza/easybird/badge)](https://www.codefactor.io/repository/github/realzza/easybird)&nbsp;

**easybird** is python toolkit for Bird Activity Detection (BAD).

## Setup and Install
We recommend using conda to create virtual environment, since we use conda-forge to install an essential library [`libsndfile`](https://anaconda.org/conda-forge/libsndfile/). To setup, copy the following command to your terminal.
```bash
conda create -n bird
conda activate bird
conda install -c conda-forge libsndfile
```

Easy install with `pip`.
```bash
pip install easybird
```

## Single Wav
Identify bird activities for single waveform.
```python
from easybird import detection

hasBird, confidence = detection.from_wav('bird.wav')
```
Output
```python
print(hasBird)
>>> True
print(confidence)
>>> 0.9996312260627747
```

## Multiple Wavs
Identify bird activities for multiple wavforms.
```python
from easybird import detection

results = detection.from_wavs(['bird1.wav','bird2.wav','bird3.wav'])
```
Output
```python
print(results)
>>> [(bird1, True, 0.99963122), (bird2, True, 0.37834975), (bird3, True, 0.87340939)]
```

