| Name | coaiapy JSON |
| Version |
0.2.12
JSON |
| download |
| home_page | https://github.com/jgwill/coaiapy |
| Summary | A Python package for audio transcription, synthesis, and tagging using Boto3. |
| upload_time | 2024-12-01 02:24:05 |
| maintainer | None |
| docs_url | None |
| author | Jean GUillaume ISabelle |
| requires_python | >=3.6 |
| license | Creative Commons Legal Code CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER. Statement of Purpose The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. 1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; ii. moral rights retained by the original author(s) and/or performer(s); iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; v. rights protecting the extraction, dissemination, use and reuse of data in a Work; vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. 2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. 3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. 4. Limitations and Disclaimers. a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
boto3
certifi
charset-normalizer
idna
redis
markdown
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CoAiAPy
CoAiAPy is a Python package that provides functionality for audio transcription, synthesis, and tagging of MP3 files using Boto3 and the Mutagen library. This package is designed to facilitate the processing of audio files for various applications.
## Features
- **Audio Transcription**: Convert audio files to text using AWS services.
- **Audio Synthesis**: Generate audio files from text input.
- **MP3 Tagging**: Add metadata tags to MP3 files for better organization and identification.
- **Redis Stashing**: Stash key-value pairs to a Redis service.
## Installation
To install the package, you can use pip:
```bash
pip install coaiapy
```
## Usage
### CLI Tool
CoAiAPy provides a CLI tool for audio transcription, summarization, and stashing to Redis.
#### Help
To see the available commands and options, use the `--help` flag:
```bash
coaia --help
```
#### Setup
Set these environment variables to use the AWS transcription service:
```bash
OPENAI_API_KEY
AWS_KEY_ID
AWS_SECRET_KEY
AWS_REGION
REDIS_HOST
REDIS_PORT
REDIS_PASSWORD
REDIS_SSL
```
#### Transcribe Audio
To transcribe an audio file to text:
```bash
coaia transcribe <file_path>
```
Example:
```bash
coaia transcribe path/to/audio/file.mp3
```
#### Summarize Text
To summarize a text:
```bash
coaia summarize <text>
```
Example:
```bash
coaia summarize "This is a long text that needs to be summarized."
```
To summarize text from a file:
```bash
coaia summarize --f <file_path>
```
Example:
```bash
coaia summarize --f path/to/text/file.txt
```
#### Stash Key-Value Pair to Redis
To stash a key-value pair to Redis:
```bash
coaia tash <key> <value>
```
Example:
```bash
coaia tash my_key "This is the value to stash."
```
To stash a key-value pair from a file:
```bash
coaia tash <key> --f <file_path>
```
Example:
```bash
coaia tash my_key --f path/to/value/file.txt
```
#### Process Custom Tags
Enable custom quick addons for assistants or bots using process tags. To add a new process tag to `config.json`, include entries like:
```
"dictkore_temperature":0.2,
"dictkore_instruction": "You do : Receive a dictated text that requires correction and clarification.\n\n# Corrections\n\n- In the dictated text, spoken corrections are made. You make them and remove the text related to that to keep the essence of what is discussed.\n\n# Output\n\n- You keep all the essence of the text (same length).\n- You keep the same style.\n- You ensure annotated dictation errors in the text are fixed.",
```
```bash
coaia p dictkore "my text to correct"
```
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
## License
This project is licensed under the MIT License. See the LICENSE file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/jgwill/coaiapy",
"name": "coaiapy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Jean GUillaume ISabelle",
"author_email": "Jean GUillaume ISabelle <jgi@jgwill.com>",
"download_url": "https://files.pythonhosted.org/packages/23/2d/388bae7eb1668abd516b55c9d4275a03f08d2873771d29080da33d229703/coaiapy-0.2.12.tar.gz",
"platform": null,
"description": "# CoAiAPy\n\nCoAiAPy is a Python package that provides functionality for audio transcription, synthesis, and tagging of MP3 files using Boto3 and the Mutagen library. This package is designed to facilitate the processing of audio files for various applications.\n\n## Features\n\n- **Audio Transcription**: Convert audio files to text using AWS services.\n- **Audio Synthesis**: Generate audio files from text input.\n- **MP3 Tagging**: Add metadata tags to MP3 files for better organization and identification.\n- **Redis Stashing**: Stash key-value pairs to a Redis service.\n\n## Installation\n\nTo install the package, you can use pip:\n\n```bash\npip install coaiapy\n```\n\n## Usage\n\n### CLI Tool\n\nCoAiAPy provides a CLI tool for audio transcription, summarization, and stashing to Redis.\n\n#### Help\n\nTo see the available commands and options, use the `--help` flag:\n\n```bash\ncoaia --help\n```\n\n#### Setup\n\nSet these environment variables to use the AWS transcription service:\n\n```bash\nOPENAI_API_KEY\nAWS_KEY_ID\nAWS_SECRET_KEY\nAWS_REGION\nREDIS_HOST\nREDIS_PORT\nREDIS_PASSWORD\nREDIS_SSL\n```\n#### Transcribe Audio\n\nTo transcribe an audio file to text:\n\n```bash\ncoaia transcribe <file_path>\n```\n\nExample:\n\n```bash\ncoaia transcribe path/to/audio/file.mp3\n```\n\n#### Summarize Text\n\nTo summarize a text:\n\n```bash\ncoaia summarize <text>\n```\n\nExample:\n\n```bash\ncoaia summarize \"This is a long text that needs to be summarized.\"\n```\n\nTo summarize text from a file:\n\n```bash\ncoaia summarize --f <file_path>\n```\n\nExample:\n\n```bash\ncoaia summarize --f path/to/text/file.txt\n```\n\n#### Stash Key-Value Pair to Redis\n\nTo stash a key-value pair to Redis:\n\n```bash\ncoaia tash <key> <value>\n```\n\nExample:\n\n```bash\ncoaia tash my_key \"This is the value to stash.\"\n```\n\nTo stash a key-value pair from a file:\n\n```bash\ncoaia tash <key> --f <file_path>\n```\n\nExample:\n\n```bash\ncoaia tash my_key --f path/to/value/file.txt\n```\n\n#### Process Custom Tags\n\nEnable custom quick addons for assistants or bots using process tags. To add a new process tag to `config.json`, include entries like:\n```\n\t\"dictkore_temperature\":0.2,\n\t\"dictkore_instruction\": \"You do : Receive a dictated text that requires correction and clarification.\\n\\n# Corrections\\n\\n- In the dictated text, spoken corrections are made. You make them and remove the text related to that to keep the essence of what is discussed.\\n\\n# Output\\n\\n- You keep all the essence of the text (same length).\\n- You keep the same style.\\n- You ensure annotated dictation errors in the text are fixed.\",\n```\n```bash\ncoaia p dictkore \"my text to correct\"\n```\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for more details.\n\n",
"bugtrack_url": null,
"license": "Creative Commons Legal Code CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN \"AS-IS\" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER. Statement of Purpose The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an \"owner\") of an original work of authorship and/or a database (each, a \"Work\"). Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works (\"Commons\") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the \"Affirmer\"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. 1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights (\"Copyright and Related Rights\"). Copyright and Related Rights include, but are not limited to, the following: i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; ii. moral rights retained by the original author(s) and/or performer(s); iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; v. rights protecting the extraction, dissemination, use and reuse of data in a Work; vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. 2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the \"Waiver\"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. 3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the \"License\"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. 4. Limitations and Disclaimers. a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. ",
"summary": "A Python package for audio transcription, synthesis, and tagging using Boto3.",
"version": "0.2.12",
"project_urls": {
"Homepage": "https://github.com/jgwill/coaiapy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b0a76ad8138811aa775213020e4b2d77c109e7dfa485bd5b8b04e922e091f60c",
"md5": "f390f291bdcd3ccd63b9f0f89ade3e46",
"sha256": "a375836d3c04d28df05c1c61b0dbc1aadd252cae3b5c42dedd3ff9c61d4485fa"
},
"downloads": -1,
"filename": "coaiapy-0.2.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f390f291bdcd3ccd63b9f0f89ade3e46",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 16818,
"upload_time": "2024-12-01T02:23:52",
"upload_time_iso_8601": "2024-12-01T02:23:52.238443Z",
"url": "https://files.pythonhosted.org/packages/b0/a7/6ad8138811aa775213020e4b2d77c109e7dfa485bd5b8b04e922e091f60c/coaiapy-0.2.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "232d388bae7eb1668abd516b55c9d4275a03f08d2873771d29080da33d229703",
"md5": "6d6a989bf01e20be9d8ba9a41f2734fe",
"sha256": "70f1014aca136522a3ec3d57dfdcfcf6e3caab4195f1a781bc8c0df8c42ecf59"
},
"downloads": -1,
"filename": "coaiapy-0.2.12.tar.gz",
"has_sig": false,
"md5_digest": "6d6a989bf01e20be9d8ba9a41f2734fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 17515,
"upload_time": "2024-12-01T02:24:05",
"upload_time_iso_8601": "2024-12-01T02:24:05.926042Z",
"url": "https://files.pythonhosted.org/packages/23/2d/388bae7eb1668abd516b55c9d4275a03f08d2873771d29080da33d229703/coaiapy-0.2.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-01 02:24:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jgwill",
"github_project": "coaiapy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "boto3",
"specs": []
},
{
"name": "certifi",
"specs": []
},
{
"name": "charset-normalizer",
"specs": []
},
{
"name": "idna",
"specs": []
},
{
"name": "redis",
"specs": []
},
{
"name": "markdown",
"specs": []
}
],
"lcname": "coaiapy"
}
