Giter Club home page Giter Club logo

katana's Introduction

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 [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
  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 [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

Screenshot 2020-03-25 at 7 12 51 PM

Contributors ๐Ÿ˜Ž

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

License ๐Ÿ‘ฉ๐Ÿปโ€๐Ÿ’ผ

MIT License

katana's People

Contributors

adityasoni19031997 avatar shaz13 avatar shaz13-socgen avatar ucalyptus avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.