| Name | wordcab JSON |
| Version |
0.7.2
JSON |
| download |
| home_page | None |
| Summary | 📖 Transcribe and Summarize any business communication at scale with Wordcab's API |
| upload_time | 2023-09-25 15:38:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.12,>=3.8 |
| license | None |
| keywords |
api
sdk
summarization
transcription
wordcab
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">Wordcab Python</h1>
<p align="center">📖 Transcribe and Summarize any business communication at scale with Wordcab's API</p>
<div align="center">
<a href="https://pypi.org/project/wordcab" target="_blank">
<img src="https://img.shields.io/pypi/v/wordcab.svg" />
</a>
<a href="https://pypi.org/project/wordcab" target="_blank">
<img src="https://img.shields.io/pypi/pyversions/wordcab" />
</a>
<a href="https://github.com/Wordcab/wordcab-python/blob/main/LICENSE" target="_blank">
<img src="https://img.shields.io/pypi/l/wordcab" />
</a>
<a href="https://github.com/Wordcab/wordcab-python/actions?workflow=ci-cd" target="_blank">
<img src="https://github.com/Wordcab/wordcab-python/workflows/ci-cd/badge.svg" />
</a>
<a href="https://app.codecov.io/gh/Wordcab/wordcab-python" target="_blank">
<img src="https://codecov.io/gh/Wordcab/wordcab-python/branch/main/graph/badge.svg" />
</a>
<a href="https://github.com/pypa/hatch" target="_blank">
<img src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg" />
</a>
</div>
---
**Wordcab** is a transcription and summarization service that provides a simple API to summarize any `audio`, `text`, or `JSON` file.
It also includes compatibility with other transcripts platforms like:
[](https://www.assemblyai.com/)
[](https://deepgram.com/)
[](https://www.rev.ai/)
[](https://otter.ai/)
[](https://sonix.ai/)
## Getting started
You can learn more about Wordcab services and pricing on our [website](https://wordcab.com/).
If you want to try out the API, you can [signup](https://wordcab.com/signup/) for a free account and start using the API
right away.
## Requirements
- OS:
- 
- 
- 
- Python:
- 
## Installation
You can install _Wordcab Python_ via pip from [PyPI](https://pypi.org/project/wordcab/):
```console
$ pip install wordcab
```
Start using the API with any python script right away!
## Usage
### Start Summary full pipeline
```python
import time
from wordcab import retrieve_job, retrieve_summary, start_summary
from wordcab.core_objects import AudioSource, GenericSource, InMemorySource
# Prepare your input source
## For a transcript stored as a .txt or .json file
source = GenericSource(filepath="path/to/file.txt") # Or file.json
## For a transcript stored as an audio file
source = AudioSource(filepath="path/to/file.mp3")
## For a transcript already in memory
transcript = {"transcript": ["SPEAKER A: Hello.", "SPEAKER B: Hi."]}
source = InMemorySource(obj=transcript)
# Launch the Summarization job
job = start_summary(
source_object=source,
display_name="sample_txt",
summary_type="narrative",
summary_lens=[1, 3],
tags=["sample", "text"],
)
# Wait for the job completion
while True:
job = retrieve_job(job_name=job.job_name)
if job.job_status == "SummaryComplete":
break
else:
time.sleep(3)
# Get the summary id
summary_id = job.summary_details["summary_id"]
# Retrieve the summary
summary = retrieve_summary(summary_id=summary_id)
# Get the summary as a human-readable string
print(summary.get_formatted_summaries())
# Save the json object to a file
with open("wordcab_summary.json", "w") as f:
f.write(summary)
```
## Documentation
Please see the [Documentation](https://wordcab.github.io/wordcab-python/) for more details.
## Contributing
Contributions are very welcome. 🚀
To learn more, see the [Contributor Guide](https://github.com/Wordcab/wordcab-python/blob/main/CONTRIBUTING.md).
## License
- Distributed under the terms of the [](https://opensource.org/licenses/Apache-2.0)
- _Wordcab Python SDK_ is free and open source software.
## Issues
If you encounter any problems,
please [file an issue](https://github.com/Wordcab/wordcab-python/issues) along with a detailed description.
Raw data
{
"_id": null,
"home_page": null,
"name": "wordcab",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.8",
"maintainer_email": null,
"keywords": "api,sdk,summarization,transcription,wordcab",
"author": null,
"author_email": "Thomas Chaigneau <thomas@wordcab.com>, Wordcab <info@wordcab.com>",
"download_url": "https://files.pythonhosted.org/packages/41/5e/47e4644073f65ab89efdc95b58590d18e988c19468cfa49dd79dc67df268/wordcab-0.7.2.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">Wordcab Python</h1>\n<p align=\"center\">\ud83d\udcd6 Transcribe and Summarize any business communication at scale with Wordcab's API</p>\n\n<div align=\"center\">\n\t<a href=\"https://pypi.org/project/wordcab\" target=\"_blank\">\n\t\t<img src=\"https://img.shields.io/pypi/v/wordcab.svg\" />\n\t</a>\n\t<a href=\"https://pypi.org/project/wordcab\" target=\"_blank\">\n\t\t<img src=\"https://img.shields.io/pypi/pyversions/wordcab\" />\n\t</a>\n\t<a href=\"https://github.com/Wordcab/wordcab-python/blob/main/LICENSE\" target=\"_blank\">\n\t\t<img src=\"https://img.shields.io/pypi/l/wordcab\" />\n\t</a>\n\t<a href=\"https://github.com/Wordcab/wordcab-python/actions?workflow=ci-cd\" target=\"_blank\">\n\t\t<img src=\"https://github.com/Wordcab/wordcab-python/workflows/ci-cd/badge.svg\" />\n\t</a>\n\t<a href=\"https://app.codecov.io/gh/Wordcab/wordcab-python\" target=\"_blank\">\n\t\t<img src=\"https://codecov.io/gh/Wordcab/wordcab-python/branch/main/graph/badge.svg\" />\n\t</a>\n\t<a href=\"https://github.com/pypa/hatch\" target=\"_blank\">\n\t\t<img src=\"https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg\" />\n\t</a>\n</div>\n\n---\n\n**Wordcab** is a transcription and summarization service that provides a simple API to summarize any `audio`, `text`, or `JSON` file.\n\nIt also includes compatibility with other transcripts platforms like:\n[](https://www.assemblyai.com/)\n[](https://deepgram.com/)\n[](https://www.rev.ai/)\n[](https://otter.ai/)\n[](https://sonix.ai/)\n\n## Getting started\n\nYou can learn more about Wordcab services and pricing on our [website](https://wordcab.com/).\n\nIf you want to try out the API, you can [signup](https://wordcab.com/signup/) for a free account and start using the API\nright away.\n\n## Requirements\n\n- OS:\n - \n - \n - \n- Python:\n - \n\n## Installation\n\nYou can install _Wordcab Python_ via pip from [PyPI](https://pypi.org/project/wordcab/):\n\n```console\n$ pip install wordcab\n```\n\nStart using the API with any python script right away!\n\n## Usage\n\n### Start Summary full pipeline\n\n```python\nimport time\nfrom wordcab import retrieve_job, retrieve_summary, start_summary\nfrom wordcab.core_objects import AudioSource, GenericSource, InMemorySource\n\n\n# Prepare your input source\n## For a transcript stored as a .txt or .json file\nsource = GenericSource(filepath=\"path/to/file.txt\") # Or file.json\n## For a transcript stored as an audio file\nsource = AudioSource(filepath=\"path/to/file.mp3\")\n## For a transcript already in memory\ntranscript = {\"transcript\": [\"SPEAKER A: Hello.\", \"SPEAKER B: Hi.\"]}\nsource = InMemorySource(obj=transcript)\n\n# Launch the Summarization job\njob = start_summary(\n\tsource_object=source,\n\tdisplay_name=\"sample_txt\",\n\tsummary_type=\"narrative\",\n\tsummary_lens=[1, 3],\n\ttags=[\"sample\", \"text\"],\n)\n\n# Wait for the job completion\nwhile True:\n\tjob = retrieve_job(job_name=job.job_name)\n\tif job.job_status == \"SummaryComplete\":\n\t\tbreak\n\telse:\n\t\ttime.sleep(3)\n\n# Get the summary id\nsummary_id = job.summary_details[\"summary_id\"]\n# Retrieve the summary\nsummary = retrieve_summary(summary_id=summary_id)\n\n# Get the summary as a human-readable string\nprint(summary.get_formatted_summaries())\n\n# Save the json object to a file\nwith open(\"wordcab_summary.json\", \"w\") as f:\n\tf.write(summary)\n```\n\n## Documentation\n\nPlease see the [Documentation](https://wordcab.github.io/wordcab-python/) for more details.\n\n## Contributing\n\nContributions are very welcome. \ud83d\ude80\nTo learn more, see the [Contributor Guide](https://github.com/Wordcab/wordcab-python/blob/main/CONTRIBUTING.md).\n\n## License\n\n- Distributed under the terms of the [](https://opensource.org/licenses/Apache-2.0)\n\n- _Wordcab Python SDK_ is free and open source software.\n\n## Issues\n\nIf you encounter any problems,\nplease [file an issue](https://github.com/Wordcab/wordcab-python/issues) along with a detailed description.\n",
"bugtrack_url": null,
"license": null,
"summary": "\ud83d\udcd6 Transcribe and Summarize any business communication at scale with Wordcab's API",
"version": "0.7.2",
"project_urls": {
"Changelog": "https://github.com/Wordcab/wordcab-python/releases",
"Documentation": "https://wordcab-python.readthedocs.io",
"Homepage": "https://github.com/Wordcab/wordcab-python",
"Issues": "https://github.com/Wordcab/wordcab-python/issues",
"Source": "https://github.com/Wordcab/wordcab-python"
},
"split_keywords": [
"api",
"sdk",
"summarization",
"transcription",
"wordcab"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ab11d849441c91128341690579b8521b32d8368e45f84db875f40410d4e561ad",
"md5": "ff1362ff264fa3a4375276ab9dca60cb",
"sha256": "c08307bca6fc8338c2da4b6e1f9f634124f73c0cf90226285a081ae5f61c106d"
},
"downloads": -1,
"filename": "wordcab-0.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff1362ff264fa3a4375276ab9dca60cb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 36658,
"upload_time": "2023-09-25T15:38:43",
"upload_time_iso_8601": "2023-09-25T15:38:43.770099Z",
"url": "https://files.pythonhosted.org/packages/ab/11/d849441c91128341690579b8521b32d8368e45f84db875f40410d4e561ad/wordcab-0.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "415e47e4644073f65ab89efdc95b58590d18e988c19468cfa49dd79dc67df268",
"md5": "68665f7ad61f58a7ba155366bc3803f9",
"sha256": "9a2975ffda0a0bafbbab2f36b3fbf151ab38b2c35f1b524053e12a5f19347c79"
},
"downloads": -1,
"filename": "wordcab-0.7.2.tar.gz",
"has_sig": false,
"md5_digest": "68665f7ad61f58a7ba155366bc3803f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 31611,
"upload_time": "2023-09-25T15:38:45",
"upload_time_iso_8601": "2023-09-25T15:38:45.095892Z",
"url": "https://files.pythonhosted.org/packages/41/5e/47e4644073f65ab89efdc95b58590d18e988c19468cfa49dd79dc67df268/wordcab-0.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 15:38:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Wordcab",
"github_project": "wordcab-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wordcab"
}
