Skip to content

Commit 93a9feb

Browse files
authored
Update README.md
1 parent f335feb commit 93a9feb

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
# Python API Example
1+
# Building and deploying a Python API
2+
3+
### About
4+
5+
In this session we will build some API endpoints, documentation for those endpoints, and the ability to test on a live site deploying on render.com. This is a simple example to get started, but hopefully it will provide the foundation for you all to build more complex APIs in the future. If you have any questions, I recommend leaving them on the YouTube recording of the lunch & learn on Tina's channel.
6+
7+
### Setup
8+
9+
1. **Clone the repository**:
10+
```bash
11+
git clone -b lunch-and-learn https://github.com/KeithGalli/python-api-example.git
12+
```
13+
2. **Navigate to directory**
14+
```bash
15+
cd python-api-example
16+
```
17+
3. **Install Python libraries**
18+
```bash
19+
pip install -r requirements.txt
20+
21+
4. **Run Flask Endpoint**
22+
```bash
23+
python3 app.py
24+
```
25+
26+
5. **Navigate to server** <br/>
27+
Open up URL app is running on (should say when you run above command -- http://127.0.0.1:5000 for example). Navigate to http://127.0.0.1:5000/apidocs to see Swagger endpoint specs.

0 commit comments

Comments
 (0)