Git Product home page Git Product logo

copier-mindsdb-handler's Introduction

Copier MindsDB Handler

Copier template for developers willing to implement new handlers for MindsDB. It generates the boilerplate code so you can focus on what really matters and speed up the implementation process

Note: For now it's only supported to generate the boilerplate code for MindsDB Application Handlers, mainly because there is a high amount of opened issues waiting for contributors who wish to support

Requirements

To use this Copier template, you will need:

To install Copier, use pip or pipx:

pip install --user copier
pip install --user pipx
pipx install copier

Usage

Make sure you are placed into the mindsdb's root directory. Then:

copier copy "https://github.com/rmaceissoft/copier-mindsdb-handler.git" .

Or even shorter:

copier copy "gh:rmaceissoft/copier-mindsdb-handler" .

You will be asked some questions.

๐ŸŽค What is your handler name?
๐ŸŽค What is your handler table name? (if more than one, separate by comma)
๐ŸŽค Do you want to generate APITable' select() method?
๐ŸŽค Do you want to generate APITable' insert() method?
๐ŸŽค Do you want to generate APITable' update() method?
๐ŸŽค Do you want to generate APITable' delete() method?

Answer them and the following directory structure will be scaffolded:

.
โ”‚ย ย  โ”œโ”€โ”€ mindsdb
โ”‚ย ย  โ”‚   โ”œโ”€โ”€ integrations
โ”‚ย ย  โ”‚   โ”‚   โ”œโ”€โ”€ handlers
โ”‚ย ย  โ”‚   โ”‚   โ”‚ย ย  โ”œโ”€โ”€ <handler_name>_handler
โ”‚ย ย  โ”‚   โ”‚ย  ย โ”‚ย ย  โ”‚   โ”œโ”€โ”€ README.md
โ”‚ย ย  โ”‚   โ”‚ย  ย โ”‚ย ย  โ”‚   โ”œโ”€โ”€ __about__.py
โ”‚ย ย  โ”‚   โ”‚ ย ย โ”‚ย ย  โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚ย ย  โ”‚   โ”‚ ย ย โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ icon.svg
โ”‚ย ย  โ”‚   โ”‚ ย ย โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ requirements.txt
โ”‚ย ย  โ”‚   โ”‚ ย ย โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ <handler_name>_handler.py
โ”‚ย ย  โ”‚   โ”‚ ย ย โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ <handler_name>_tables.py

copier-mindsdb-handler's People

Contributors

rmaceissoft avatar

Stargazers

 avatar  avatar  avatar  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.