Metadata-Version: 2.4
Name: bpdp_cli
Version: 0.1.0
Summary: CLI of BPDP
Author-email: "林彥廷(Yen-Ting, Lin)" <d26923050@gmail.com>
License-Expression: BSD-3-Clause
License-File: LICENSE.txt
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Requires-Python: >=3.10
Requires-Dist: bpdp>=0.1.0
Requires-Dist: torchaudio>=2.0.0
Description-Content-Type: text/markdown

# bpdp_cli: The command line interface of bpdp algrithm
This package is separated from the bpdp package because it needs additional libraries to read the wav/mp3/... files. 

## Installation 
One can install the scripts using pip
```Bash
pip install bpdp_cli
```

## Usage:
1. Extract from single .wav file using default arguments
```Bash
bpdp -i test.wav
```
This will create a test.bpdp.txt contains the epochs.

2. Extract all .wav files from directory
```Bash
bpdp -I test_dir/
```
This will extract all .wav files in the directory recursively. 
For example, if a file test_dir/a/01/a01.wav is in the test_dir/, test_dir/a/01/a01.bpdp.txt will be created.

3. Dry run mode
```
bpdp -I test_dir/ --dry_run
```
This will prevent the actual calculation, file reads and writes.
