https://github.com/bugbiteme/cocktail-ai-api
https://github.com/bugbiteme/cocktail-ai-api
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bugbiteme/cocktail-ai-api
- Owner: bugbiteme
- Created: 2023-12-18T18:21:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T23:41:25.000Z (about 2 years ago)
- Last Synced: 2025-01-31T12:36:09.887Z (over 1 year ago)
- Language: Python
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cocktail-ai-api
RestAPI integration to openAI and DALL-E to create a cocktail recipe based on a prompt.
API call will also return a DALL-E generated image based on the cocktail.
`OPENAI_API_KEY` is an environment variable on your system on in your container that has your OpenAI API key
To be called from web front end.
To build and run a container:
```
podman build -t cocktail-ai .
podman run -e OPENAI_API_KEY=$OPENAI_API_KEY -e DEBUG=[true/false] -p 8000:8080 cocktail-ai
```
This command runs the podman container, mapping port 8000 on your local machine to port 8080 in the podman container (which your FastAPI app should be listening on).
## To test locally
If you're not already doing so, consider using a virtual environment. This isolates your project's dependencies from the global Python environment and can often resolve conflicts and dependency issues.
```
python -m venv venv
source venv/bin/activate # For Unix or MacOS
venv\Scripts\activate # For Windows
pip install --upgrade pip
pip install -r requirements.txt
export OPENAI_API_KEY=
export DEBUG=true #to call mock API that is free and fast for testing purposes
uvicorn main:app --reload
```
Note: If using OpenShift DevSpaces, there is no need to create a virtual environment (venv). Also no need to run pip install locally.
## To clean up python virtual environment
- If you are currently inside a virtual environment, you'll need to deactivate it first. You can do this by running the deactivate command in your terminal or command prompt.
```
deactivate
```
This will return you to your system's default Python environment.
Once you've deactivated the virtual environment, you can simply delete its directory to remove it completely. The virtual environment is just a directory containing all the necessary files, so removing this directory will delete the environment.
```
rm -rf venv # Unix/Linux/MacOS
rmdir /s /q venv # Windows
```
For some swagger action:
```
/docs
/redocs
```