| Name | cmi-oai-cli JSON |
| Version |
0.0.1a6
JSON |
| download |
| home_page | |
| Summary | A CLI for OpenAI's API |
| upload_time | 2023-12-15 20:53:45 |
| maintainer | |
| docs_url | None |
| author | Reinder Vos de Wael |
| requires_python | >3.8,<4.0 |
| license | LGPL-2.1 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CLI-OAI
CLI-OAI is a Python command-line interface for interacting with the OpenAI API. It provides a set of commands to interact with various OpenAI services such as Speech-to-Text (STT), Text-to-Speech (TTS), and Image Generation.
## Installation
To install CLI-OAI, you can use the following command:
```sh
poetry add git+https://github.com/cmi-dair/cli-oai
```
## Usage
Before running CLI-OAI, make sure the environment variable `OPENAI_API_KEY` is set to your OpenAI API key.
To use the CLI, run `oai --help` in your terminal. This will display a list of available commands and their descriptions.
Here is a brief overview of the main commands:
- `oai stt <filename>`: Transcribes audio files with OpenAI's STT models. The `filename` argument is the file to transcribe. It can be any format that ffmpeg supports. Use the `--clip` option to clip the file if it is too large.
- `oai tts <text>`: Generates audio files with OpenAI's Text to Speech models. The `text` argument is the text to convert to speech.
- `oai image <prompt>`: Generates images with OpenAI's DALL-E. The `prompt` argument is the text prompt to generate the image from.
Each command has additional options that can be viewed by running `oai <command> --help`.
## Contributing
Contributions are welcome! Please see the [contributing guidelines](CONTRIBUTING.md) for more information.
## License
CLI-OAI is licensed under the terms of the [L-GPLv2.1 license](LICENSE).
## Support
If you encounter any issues or have any questions, please report them on our [issues page](https://github.com/cmi-dair/cli-oai/issues).
Raw data
{
"_id": null,
"home_page": "",
"name": "cmi-oai-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Reinder Vos de Wael",
"author_email": "reinder.vosdewael@childmind.org",
"download_url": "https://files.pythonhosted.org/packages/2b/c8/3bbfe82991d3ba852c2ba9834eb518066b1d465cf7a71918171651b08c8e/cmi_oai_cli-0.0.1a6.tar.gz",
"platform": null,
"description": "# CLI-OAI\n\nCLI-OAI is a Python command-line interface for interacting with the OpenAI API. It provides a set of commands to interact with various OpenAI services such as Speech-to-Text (STT), Text-to-Speech (TTS), and Image Generation.\n\n## Installation\n\nTo install CLI-OAI, you can use the following command:\n\n```sh\npoetry add git+https://github.com/cmi-dair/cli-oai\n```\n\n## Usage\n\nBefore running CLI-OAI, make sure the environment variable `OPENAI_API_KEY` is set to your OpenAI API key.\n\nTo use the CLI, run `oai --help` in your terminal. This will display a list of available commands and their descriptions.\n\nHere is a brief overview of the main commands:\n\n- `oai stt <filename>`: Transcribes audio files with OpenAI's STT models. The `filename` argument is the file to transcribe. It can be any format that ffmpeg supports. Use the `--clip` option to clip the file if it is too large.\n\n- `oai tts <text>`: Generates audio files with OpenAI's Text to Speech models. The `text` argument is the text to convert to speech.\n\n- `oai image <prompt>`: Generates images with OpenAI's DALL-E. The `prompt` argument is the text prompt to generate the image from.\n\nEach command has additional options that can be viewed by running `oai <command> --help`.\n\n## Contributing\n\nContributions are welcome! Please see the [contributing guidelines](CONTRIBUTING.md) for more information.\n\n## License\n\nCLI-OAI is licensed under the terms of the [L-GPLv2.1 license](LICENSE).\n\n## Support\n\nIf you encounter any issues or have any questions, please report them on our [issues page](https://github.com/cmi-dair/cli-oai/issues).\n\n",
"bugtrack_url": null,
"license": "LGPL-2.1",
"summary": "A CLI for OpenAI's API",
"version": "0.0.1a6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1de861788a1bca83a43b994256e9faa878d389d3f4e39bbadd7dbfbcf4314635",
"md5": "a2286b9e8bbfe861570461c979a62e6e",
"sha256": "e426d0828d7cdb61f979afa623c9ed7159fd9200bba1ae7fa7e7279f91657658"
},
"downloads": -1,
"filename": "cmi_oai_cli-0.0.1a6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2286b9e8bbfe861570461c979a62e6e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">3.8,<4.0",
"size": 20049,
"upload_time": "2023-12-15T20:53:43",
"upload_time_iso_8601": "2023-12-15T20:53:43.360807Z",
"url": "https://files.pythonhosted.org/packages/1d/e8/61788a1bca83a43b994256e9faa878d389d3f4e39bbadd7dbfbcf4314635/cmi_oai_cli-0.0.1a6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2bc83bbfe82991d3ba852c2ba9834eb518066b1d465cf7a71918171651b08c8e",
"md5": "8a8ab16d9b6a92cb87d333610045c0a9",
"sha256": "a10ea34317b37128ade7afbfe6303785e191acd9ef070820f42ba8d339f2cb16"
},
"downloads": -1,
"filename": "cmi_oai_cli-0.0.1a6.tar.gz",
"has_sig": false,
"md5_digest": "8a8ab16d9b6a92cb87d333610045c0a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.8,<4.0",
"size": 17890,
"upload_time": "2023-12-15T20:53:45",
"upload_time_iso_8601": "2023-12-15T20:53:45.059052Z",
"url": "https://files.pythonhosted.org/packages/2b/c8/3bbfe82991d3ba852c2ba9834eb518066b1d465cf7a71918171651b08c8e/cmi_oai_cli-0.0.1a6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 20:53:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cmi-oai-cli"
}
