Metadata-Version: 2.1
Name: cloai
Version: 0.0.1a9
Summary: A CLI for OpenAI's API
License: LGPL-2.1
Author: Reinder Vos de Wael
Author-email: reinder.vosdewael@childmind.org
Requires-Python: >3.8,<4.0
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: ffmpeg-python (>=0.2.0,<0.3.0)
Requires-Dist: openai (>=1.6.0,<2.0.0)
Requires-Dist: pydantic (>=2.5.2,<3.0.0)
Requires-Dist: pydantic-settings (>=2.1.0,<3.0.0)
Requires-Dist: pypdf (>=3.17.3,<4.0.0)
Requires-Dist: python-docx (>=1.1.0,<2.0.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Description-Content-Type: text/markdown

# cloai

cloai 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 cloai, you can use the following command:

```sh
poetry add git+https://github.com/cmi-dair/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 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.

- `cloai 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 `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/cmi-dair/cloai/issues).

