Metadata-Version: 2.1
Name: tscribe
Version: 1.2.0
Summary: Produce .docx transcriptions from AWS Transcribe output.
Home-page: https://github.com/kibaffo33/aws_transcribe_to_docx
Author: Robert Williams
Author-email: robertedwardwilliams@me.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: python-docx
Requires-Dist: matplotlib
Requires-Dist: pandas

tscribe
=======

Produce Word Document, CSV or SQLite transcriptions using the automatic speech recognition from AWS Transcribe.

[![Build Status](https://travis-ci.com/kibaffo33/aws_transcribe_to_docx.svg?branch=master)](https://travis-ci.com/kibaffo33/aws_transcribe_to_docx)


# Installation

```bash
pip install tscribe
```


# Results

| Time    | Speaker | Comment     |
| ------- | ------- | ----------- |
| 0:00:03 | spk_0   | Is this on? |
| 0:00:05 | spk_1   | Yep.        |
| 0:00:06 | spk_0   | Great.      |


# Usage

## Getting started

Simply `import tscribe` and point `tscribe.write(...)` at your `.json` file.

```python
import tscribe

tscribe.write("output.json")
```
```
output.docx written in x seconds.
```

## Output formats

Supported output formats include:
* `docx` (default)
* `csv`
* `sqlite`

```python
import tscribe
tscribe.write("output.json", format="docx")
tscribe.write("output.json", format="csv")
tscribe.write("output.json", format="sqlite")
```
```
output.docx written in x seconds.
output.csv written in x seconds.
output.db written in x seconds.
```

## Target directory or filename 

You may wish to be explicit in specifying the output filename or directory written to. Use cases may include following a naming convention or operating in a serverless environment.

```python
import tscribe
tscribe.write("output.json", save_as="transcript.docx")
tscribe.write("output.json", save_as="/tmp/transcript.docx")
```
```
transcript.docx written in x seconds.
/tmp/transcript.docx written in x seconds.
```

## Combining format and target

```python
import tscribe
tscribe.write("output.json", format="csv", save_as="output/output.csv")
```
```
output/output.csv written in x seconds.
```


