shaz13/katana

Introduction 🌻

Katana project is a template for ASAP 🚀 ML application deployment

Features 🎉

1. FastAPI inbuilt
2. Swagger UI and uvicorn integration
3. Docker ready configuration
4. Integrated GitHub actions
5. Production ready code 🚀

Set-up Instructions 🔧

We recommend using flask default serving for development and uvicorn server for production

We included following setup instructions;

1. Local development
2. Docker supported deployment

Local Development 👨🏻‍💻

1. Clone this repo with [email protected]:shaz13/katana.git
2. Set up environment using python3 -m venv .env
3. Activate envrionment using

# Linux / Mac / Unix
$ source .env/bin/activate

# Windows
$ \.env\Scripts\activate

4. Install requirements using pip install -r requirements.txt
5. For debugging run from root - python main.py
6. Deploy using Procfile or bash scripts/launch.sh
7. Your API is being served at localhost:9000

Docker Setup ⛴

1. Clone this repo with [email protected]:shaz13/katana.git
2. Install docker in your system
3. Run docker-compose up
4. Your local port is mapped and being served at localhost:9000

Contributors 😎

1. Mohammad Shahebaz - @shaz13
2. Aditya Soni - @AdityaSoni19031997

License 👩🏻‍💼

MIT License