Metadata-Version: 2.1
Name: audio2book
Version: 0.1.3
Summary: Converts audiobook completion into page completion
Home-page: https://www.github.com/safuya/books
Author: Robert Hughes
Author-email: roberts.ginger.email@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Intended Audience :: End Users/Desktop
Description-Content-Type: text/markdown
Requires-Dist: logbook

# Audio2book

This program is for converting an audiobooks pages read into print pages read.

## Usage

To use this program, you must have Python 3.6 or higher installed. You may then install it through
pip.

```
pip install audio2book
```

Run the program under Python as a module. Arguments to be supplied are:

* -c, --completed: How much of the audiobook have you completed.
* -o, --overall: How long is the audiobook overall.
* -p, --pages: How many pages is the print book overall.

```
audio2book -c 0:53 -o 10:58 -p 310
```

You can also use the long arguments.

```
audio2book --completed 0:53 --overall 10:58 -p 310
```

And you can get help.

```
audio2book -h
```

## Development

A contribution guide is coming.

### Running the tests

Pull the [source code](https://www.github.com/safuya/books).

Then make sure you have first installed the requirements:

```
pip install -r requirements.txt
```

Then run the tests.

```
./test.sh
```

The tests include unit tests and mutation tests. All new functionality must have 100% test
coverage and provide any useful logging. Any reasonable exceptions to this will be considered.


