README.md

tortoise-cli

A cli tool for tortoise-orm, build on top of click and ptpython.

Installation

You can just install from pypi.

pip install tortoise-cli

Quick Start

> tortoise-cli -h                                                                                                                                                                 23:59:38
Usage: tortoise-cli [OPTIONS] COMMAND [ARGS]...

Options:
  -V, --version      Show the version and exit.
  -c, --config TEXT  TortoiseORM config dictionary path, like
                     settings.TORTOISE_ORM
  -h, --help         Show this message and exit.

Commands:
  shell  Start an interactive shell.

Usage

First, you need make a TortoiseORM config object, assuming that in settings.py.

TORTOISE_ORM = {
    "connections": {
        "default": "sqlite://:memory:",
    },
    "apps": {
        "models": {"models": ["examples.models"], "default_connection": "default"},
    },
}

Interactive shell

Then you can start an interactive shell for TortoiseORM.

tortoise-cli -c settings.TORTOISE_ORM shell

Or you can set config by set environment variable.

export TORTOISE_ORM=settings.TORTOISE_ORM

Then just run:

tortoise-cli shell

License

This project is licensed under the Apache-2.0 License.