shane-kercheval / openai-template

project-template

This repo contains a minimal project template for making asynchronous OpenAI API calls. It has additional functionality that, for example, parses the responses and calculates the costs of API calls.

---

This project contains

• dockerfile
• linting
• unit tests
• doctests
• code coverage (100%)
• makefile and command line program (via click)

Running the Project

All commmands for running the project can be found in the Makefile and ran in the command-line with the command make [command].

Starting Docker

Build and run docker-compose:

make docker_run

make docker_open

Running the entire project (tests, ETL, EDA, etc.) from command-line (outside of docker container):

make docker_all

Running the entire project (tests, ETL, EDA, etc.) from command-line (inside docker container):

make all

OpenAI Token

The OpenAI token should be stored in a file in the home directory called .openai_template.env in the following format:

OPENAI_TOKEN=<token-goes-here-without-brackets>

Running the Code

The Makefile runs all components of the project. You can think of it as containing the implicit DAG, or recipe, of the project.

Run make commands from terminal connected to container via make docker_run or make zsh.

If you want to run the entire project from start to finish, including unit tests and linting, run:

make all