https://github.com/andreaschandra/aomori
a pet project using fastapi skeleton and gcp stack
https://github.com/andreaschandra/aomori
Last synced: about 1 year ago
JSON representation
a pet project using fastapi skeleton and gcp stack
- Host: GitHub
- URL: https://github.com/andreaschandra/aomori
- Owner: andreaschandra
- License: apache-2.0
- Created: 2023-06-28T14:09:48.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-15T16:05:00.000Z (almost 3 years ago)
- Last Synced: 2025-02-12T09:50:11.069Z (over 1 year ago)
- Language: Python
- Size: 612 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Aomori
A pet project for deploying machine learning API using FastAPI and GCP Stack.
The struture of the project and its configuration is forked from [here](https://github.com/eightBEC/fastapi-ml-skeleton)
## Installation
Install the required packages in your local environment (ideally virtualenv, conda, etc.).
```bash
pip install -r requirements
```
## Run It
1. Start your app with:
```bash
uvicorn aomori.main:app
```
2. Go to [http://localhost:8000/docs](http://localhost:8000/docs).
3. Click `Authorize` and enter the API key as stated in the .env.
## Run Tests
If you're not using `tox`, please install with:
```bash
pip install tox
```
Run your tests with:
```bash
tox
```
This runs tests and coverage for Python 3.6 and Flake8, Autopep8, Bandit.