Skip to content

Update README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Server-Side Example Python Flask

This repository hosts a Python Flask application that demonstrates server-side operations with Flask. This project is structured to provide a straightforward example of how to manage API integrations and environment configurations.

## Prerequisites

Before you begin, ensure you have met the following requirements:
- Python 3.6 or higher
- Poetry for dependency management

## Installation

To install the necessary libraries and setup the project environment, follow these steps:

1. Clone the repository:
```bash
git clone https://github.com/VapiAI/server-side-example-python-flask.git
2. Navigate to the project directory:
```bash
cd server-side-example-python-flask
3. Install dependencies using Poetry:
```bash
poetry install
## Configuring Environment Variables
This project requires certain environment variables to be set. Create a .env file in the root directory of your project and add the following keys:

```bash
WEATHER_API_KEY=<your_weather_api_key_here>
OPENAI_API_KEY=<your_openai_api_key_here>
VAPI_BASE_URL=https://api.vapi.ai
VAPI_API_KEY=<your_vapi_api_key_here>
```

Replace <your_weather_api_key_here>, <your_openai_api_key_here>, and <your_vapi_api_key_here> with the actual API keys.

## Running the Project
To run the project, use Poetry to handle the environment:

```bash
poetry run flask --app ./app/main run
```

This command starts the Flask server on http://127.0.0.1:5000/. You can access the server from your web browser at this address.