Skip to content
/ katana Public template

Katana project is a FastAPI template for ASAP 🚀 ML API deployment

Notifications You must be signed in to change notification settings

shaz13/katana

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Katana Cover

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 git@github.com: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
  1. Install requirements using pip install -r requirements.txt
  2. For debugging run from root - python main.py
  3. Deploy using Procfile or bash scripts/launch.sh
  4. Your API is being served at localhost:9000

Docker Setup â›´

  1. Clone this repo with git@github.com: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

Capture

Contributors 😎

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

License 👩�?��?💼

MIT License

About

Katana project is a FastAPI template for ASAP 🚀 ML API deployment

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •