https://github.com/lnxpy/cookiecutter-mindsdb
@MindsDB (Handler) Integration Cookiecutter Template :cookie:
https://github.com/lnxpy/cookiecutter-mindsdb
Last synced: 11 months ago
JSON representation
@MindsDB (Handler) Integration Cookiecutter Template :cookie:
- Host: GitHub
- URL: https://github.com/lnxpy/cookiecutter-mindsdb
- Owner: lnxpy
- License: mit
- Created: 2023-08-23T21:21:18.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-27T17:50:53.000Z (almost 3 years ago)
- Last Synced: 2025-04-15T23:29:05.190Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 6.84 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## MindsDB Integration Cookiecutter
Use this cookiecutter template to create integrations into MindsDB. This template is designed for _Handler Integrations_.
### Usage
Make sure you have `cookiecutter` installed on your machine via running the following commands.
```sh
$ pip install -U cookiecutter
...
$ cookiecutter -V
```
Make sure you already have `mindsdb/mindsdb` cloned locally. We assume that it's located on `~/mindsdb` for now.
To create your handler, run the following command and keep answering the questions.
```sh
cookiecutter gh:lnxpy/cookiecutter-mindsdb -o ~/mindsdb/mindsdb/integrations/handlers/
```
### Versioning
If you've decided to use `bump2version` for managing your handler version, simply navigate to your handler directory and bump up/down your handler version via:
```sh
bumpversion patch/minor/major
```
Then you'll see that it's updated your handler's version!
### Implementation
All the files you need to update are listed as follows.
- `README.md`
- `requirments.txt` (if you already have it)
- `icon.svg`
- `_handler.py`
- `_tables.py`
Once you're satisfied with your changes, you can open a merge request for your changes to be reviewed.