-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Just the installation instructions. I will have them tested.
- Loading branch information
Showing
1 changed file
with
37 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,39 @@ | ||
[](https://github.com/pylint-dev/pylint) [](https://www.buymeacoffee.com/mrbeverage) | ||
|
||
In progress. | ||
# OpenAI Language Quiz Generator | ||
|
||
## Contents | ||
|
||
## Why | ||
|
||
## Getting started | ||
|
||
Right now it is a simple Python app, installable from the command line via [Poetry](https://python-poetry.org/): | ||
``` | ||
python -m pip install --upgrade pip | ||
pip install poetry | ||
poetry install | ||
``` | ||
This app will additiionally require a postgresql database, and an OpenAI API key in your environment. (This will be configurable, and hidden later.) | ||
``` | ||
# It is probably better to put this into a dotfile: | ||
export $OPENAI_API_KEY=... | ||
``` | ||
A postgresql database is then required, however this is already configured in a docker-compose.yml: | ||
``` | ||
# From the root directory of the repo: | ||
docker-compose up | ||
``` | ||
Better secrets management for both the OpenAI keys and database passwords will be coming shortly when the effort to cloud host this as an API will be undertaken. | ||
|
||
Once running, you will need to pre-populate the database with a minimal verb set before any sentence or problem generation. To do that, run the following: | ||
``` | ||
dbtest database init | ||
``` | ||
From there the application is ready to start generating problem data from the command line. See the documentation below. | ||
|
||
## Usage | ||
|
||
## Examples | ||
|
||
## Roadmap |