# README
[](https://opensource.org/license/apache-2-0/)
[](https://hex.pm/packages/openai_ex)
`OpenaiEx` is an Elixir library that provides a community-maintained OpenAI API client especially for Livebook development.
The library closely follows the naming / structure of the [official OpenAI API client libraries](https://platform.openai.com/docs/api-reference) for [Python](https://github.com/openai/openai-python) and [JavaScript](https://github.com/openai/openai-node), making it easy to understand and reuse existing documentation.
## Installation and Usage
For installation instructions and detailed usage examples, please look at the [User Guide](./notebooks/userguide.livemd). The guide is a Livebook, so you can run all of the code in it without creating a new project. There are also Livebook Kino App starter samples for Images and Continuations.
Discussion and announcements on [this thread in Elixir Forum](https://elixirforum.com/t/openai-ex-openai-api-client-library/)
All documentation can also be found on [hexdocs](https://hexdocs.pm/openai_ex)
* [User Guide](https://hexdocs.pm/openai_ex/userguide.html)
* [Continuation Kino App](https://hexdocs.pm/openai_ex/continuations.html)
* [Image Kino App](https://hexdocs.pm/openai_ex/images.html)
## Development
The following section is only for developers that want to contribute to this repository.
This library was developed using a Livebook docker image that runs inside a VS Code devcontainer. The `.devcontainer` folder contains all of the relevant files.
To get started, clone the repository to your local machine and open it in VS Code. Follow the prompts to open it in a container.
After the container is up and running in VS Code, you can access livebook at http://localhost:8080. However, you'll need to enter a password that's stored in the environment variable `LIVEBOOK_PASSWORD`. This variable needs to be defined in the `.devcontainer/.env` file, which is explained below.
### Environment Variables and Secrets
To set environment variables for devcontainer development, you can create a `.env` file in the `.devcontainer` folder. Any secrets, such as `OPENAI_API_KEY` and `LIVEBOOK_PASSWORD`, can be defined in this file as environment variables. Note that this `.env` file should not be included in version control, and it is already included in the .gitignore file for this reason.
You can find a sample `env` file in the same folder, which you can use as a template for your own `.env` file. These variables will be passed to Livebook via `docker-compose.yml`.
