/katana

Katana project is a template for ASAP 🚀 ML application deployment

Primary LanguagePython

katana_cover

Introduction 🌻

Katana project is a template for ASAP 🚀 ML application deployment

Checkout demo at- https://katana-demo.herokuapp.com/

Features 🎉

  1. Flask RestX for ReSTFul requests
  2. Swagger UI and gunicorn integration
  3. Colored logging with custom handlers
  4. Docker ready configuration
  5. Integrated GitHub actions
  6. Production ready code 🚀

Set-up Instructions 🔧

We recommend using flask default serving for development and gunicorn 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/start.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

Screenshot 2020-03-25 at 7 12 51 PM

Contributors 😎

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

License 👩🏻‍💼

MIT License