Introduction
ðŧ
Katana project is a template for ASAP
ð ML application deploymentCheckout demo at- https://katana-demo.herokuapp.com/
Features
ð
- FastAPI inbuilt
- Swagger UI and uvicorn integration
- Docker ready configuration
- Integrated GitHub actions
- Production ready code
ð
Set-up Instructions
ð§
We recommend using flask default serving for development and uvicorn server for production
We included following setup instructions;
- Local development
- Docker supported deployment
Local Development ðĻðŧâðŧ
- Clone this repo with
[email protected]:shaz13/katana.git - Set up environment using
python3 -m venv .env - Activate envrionment using
# Linux / Mac / Unix
$ source .env/bin/activate
# Windows
$ \.env\Scripts\activate
- Install requirements using
pip install -r requirements.txt - For debugging run from root -
python main.py - Deploy using
Procfileorbash scripts/launch.sh - Your API is being served at
localhost:9000
Docker Setup
âī
- Clone this repo with
[email protected]:shaz13/katana.git - Install docker in your system
- Run
docker-compose up - Your local port is mapped and being served at
localhost:9000
Contributors
ð
- Mohammad Shahebaz - @shaz13
- Aditya Soni - @AdityaSoni19031997
License ðĐðŧâðž
MIT License
