| Name | cloai JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A CLI for OpenAI's API |
| upload_time | 2024-04-18 18:53:42 |
| maintainer | None |
| docs_url | None |
| author | Reinder Vos de Wael |
| requires_python | <4.0,>3.10 |
| license | LGPL-2.1 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CLI OpenAI
CLI OpenAI (cloai) is a command-line interface for interacting with the OpenAI API. It provides a set of commands to interact with various OpenAI services such as GPT, Speech-to-Text (STT), Text-to-Speech (TTS), and Image Generation.
## Installation
To install cloai, you can use the following command:
```sh
pip install cloai
```
## Usage
Before running cloai, make sure the environment variable `OPENAI_API_KEY` is set to your OpenAI API key.
To use the CLI, run `cloai --help` in your terminal. This will display a list of available commands and their descriptions.
Here is a brief overview of the main commands:
- `cloai gpt --help`: Shows the usages of the GPT command. The GPT command is used to generate text with OpenAI's GPT models. As there are several usage
options, the help command is the best way to learn how to use it.
- `cloai dalle <prompt>`: Generates images with OpenAI's DALL-E. The `prompt` argument is the text prompt to generate the image from.
- `cloai 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.
- `cloai tts <text>`: Generates audio files with OpenAI's Text to Speech models. The `text` argument is the text to convert to speech.
Each command has additional options that can be viewed by running `cloai <command> --help`.
## Contributing
Contributions are welcome! Please see the [contributing guidelines](CONTRIBUTING.md) for more information.
## License
cloai 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/childmindresearch/cloai/issues).
Raw data
{
"_id": null,
"home_page": null,
"name": "cloai",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>3.10",
"maintainer_email": null,
"keywords": null,
"author": "Reinder Vos de Wael",
"author_email": "reinder.vosdewael@childmind.org",
"download_url": "https://files.pythonhosted.org/packages/78/a9/e074f1e8bcff5dfaa7e9753326a21f27900d6090b67cadae7cc8ee89d13f/cloai-0.1.0.tar.gz",
"platform": null,
"description": "# CLI OpenAI\n\nCLI OpenAI (cloai) is a command-line interface for interacting with the OpenAI API. It provides a set of commands to interact with various OpenAI services such as GPT, Speech-to-Text (STT), Text-to-Speech (TTS), and Image Generation.\n\n## Installation\n\nTo install cloai, you can use the following command:\n\n```sh\npip install cloai\n```\n\n## Usage\n\nBefore running cloai, make sure the environment variable `OPENAI_API_KEY` is set to your OpenAI API key.\n\nTo use the CLI, run `cloai --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- `cloai gpt --help`: Shows the usages of the GPT command. The GPT command is used to generate text with OpenAI's GPT models. As there are several usage\n options, the help command is the best way to learn how to use it.\n\n- `cloai dalle <prompt>`: Generates images with OpenAI's DALL-E. The `prompt` argument is the text prompt to generate the image from.\n\n- `cloai 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- `cloai tts <text>`: Generates audio files with OpenAI's Text to Speech models. The `text` argument is the text to convert to speech.\n\nEach command has additional options that can be viewed by running `cloai <command> --help`.\n\n## Contributing\n\nContributions are welcome! Please see the [contributing guidelines](CONTRIBUTING.md) for more information.\n\n## License\n\ncloai 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/childmindresearch/cloai/issues).\n\n",
"bugtrack_url": null,
"license": "LGPL-2.1",
"summary": "A CLI for OpenAI's API",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9673b1514bcc543fe85a31f443244d672763fbf9585ef2990bf92daef50e84d4",
"md5": "9b5683439b6bfc715a2e286401eb2adc",
"sha256": "7febaa8354ca29caf13630742285e1f6d6d12d086539d4720f0627434c8c75d3"
},
"downloads": -1,
"filename": "cloai-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b5683439b6bfc715a2e286401eb2adc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>3.10",
"size": 25654,
"upload_time": "2024-04-18T18:53:41",
"upload_time_iso_8601": "2024-04-18T18:53:41.185102Z",
"url": "https://files.pythonhosted.org/packages/96/73/b1514bcc543fe85a31f443244d672763fbf9585ef2990bf92daef50e84d4/cloai-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "78a9e074f1e8bcff5dfaa7e9753326a21f27900d6090b67cadae7cc8ee89d13f",
"md5": "10adcaefc91e27376edbaf0ecc1e5735",
"sha256": "85984f3f2c73d9cc2aaaffa777b4912c8d761e3ccc74ee3148f8dbb7e1c569a2"
},
"downloads": -1,
"filename": "cloai-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "10adcaefc91e27376edbaf0ecc1e5735",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>3.10",
"size": 23589,
"upload_time": "2024-04-18T18:53:42",
"upload_time_iso_8601": "2024-04-18T18:53:42.871344Z",
"url": "https://files.pythonhosted.org/packages/78/a9/e074f1e8bcff5dfaa7e9753326a21f27900d6090b67cadae7cc8ee89d13f/cloai-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 18:53:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cloai"
}
