Skip to content

Commit 5d90588

Browse files
authored
Merge pull request #20 from jmeisele/jason/poetry-only
using only poetry for deps management
2 parents c8227fd + e8f983c commit 5d90588

File tree

8 files changed

+94
-1090
lines changed

8 files changed

+94
-1090
lines changed

.tool-versions

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
python 3.8.0

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
PROJECT=fastapi-ml-scaffolding
2-
PYTHON_VERSION=3.6.13
2+
PYTHON_VERSION=3.8.0
33

44
SOURCE_OBJECTS=app tests
55

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,49 @@
11
[![tests](https://github.com/jmeisele/fastapi-ml-scaffolding/actions/workflows/python-app.yml/badge.svg)](https://github.com/jmeisele/fastapi-ml-scaffolding/actions/workflows/python-app.yml)
22

3-
43
# FastAPI Model Server Scaffolding
54

65
Serving machine learning models production-ready, fast, easy and secure powered by FastAPI by [Sebastián Ramírez](https://github.com/tiangolo).
76

8-
This repository contains a starter app which can be used to speed-up your next machine learning project.
7+
This repository contains a starter app which can be used to speed-up your next machine learning project.
98

109
To experiment and get a feeling on how to use this scaffolding, a sample regression model for house price prediction is included in this project. Follow the installation and setup instructions to run the sample model and serve it aso RESTful API.
1110

1211
## Requirements
1312

14-
Python 3.6+
13+
Python 3.8+
1514

1615
## Installation/Setup
16+
1717
Makefile provided to get you up and going quickly.
18+
1819
```bash
1920
make setup
2021
```
2122

2223
## Run It
23-
1. Start your app with:
24+
25+
1. Start your app with:
26+
2427
```bash
2528
poetry run uvicorn app.main:app
2629
```
2730

2831
2. Go to [http://localhost:8000/docs](http://localhost:8000/docs).
29-
3032
3. You can use the sample payload from the `docs/sample_payload.json` file when trying out the house price prediction model using the API.
3133
![Prediction with example payload](./docs/sample_payload.png)
3234

33-
3435
## Testing
36+
3537
Makefile provided to provide test suite.
38+
3639
```bash
3740
make test
3841
```
3942

4043
## Linting & Formatting
44+
4145
Makefile provided to provide linting & formatting suite.
46+
4247
```bash
4348
make format
44-
```
49+
```

0 commit comments

Comments
 (0)