init

Author: long2ice

.github/workflows/pypi.yml

@@ -0,0 +1,24 @@
+name: pypi
+on:
+  release:
+    types:
+      - created
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Install and configure Poetry
+        uses: snok/[email protected]
+        with:
+          virtualenvs-create: false
+      - name: Build dists
+        run: make build
+      - name: Pypi Publish
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: __token__
+          password: ${{ secrets.pypi_password }}

.gitignore

@@ -127,3 +127,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+.idea

.idea/.gitignore

@@ -0,0 +1,27 @@
+checkfiles = tortoise_cli/ tests/ examples/ conftest.py
+black_opts = -l 100 -t py38
+py_warn = PYTHONDEVMODE=1
+
+up:
+	@poetry update
+
+deps:
+	@poetry install
+
+style: deps
+	isort -src $(checkfiles)
+	black $(black_opts) $(checkfiles)
+
+check: deps
+	black --check $(black_opts) $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
+	flake8 $(checkfiles)
+	mypy $(checkfiles)
+
+
+test: deps
+	$(py_warn) py.test
+
+build: deps
+	@poetry build
+
+ci: check test

CHANGELOG.md

@@ -1,2 +1,59 @@
 # tortoise-cli
-A manage shell for tortoise-orm, build on top of ptpython
+
+[![image](https://img.shields.io/pypi/v/tortoise-cli.svg?style=flat)](https://pypi.python.org/pypi/tortoise-cli)
+[![image](https://img.shields.io/github/license/tortoise/tortoise-cli)](https://github.com/tortoise/tortoise-cli)
+[![image](https://github.com/tortoise/tortoise-cli/workflows/pypi/badge.svg)](https://github.com/tortoise/tortoise-cli/actions?query=workflow:pypi)
+
+A cli tool for tortoise-orm, build on top of click and ptpython.
+
+## Installation
+
+You can just install from pypi.
+
+```shell
+pip install tortoise-cli
+```
+
+## Quick Start
+
+```shell
+> 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  [required]
+  -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`.
+
+```python
+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.
+
+```shell
+tortoise-cli -c examples.TORTOISE_ORM shell
+```
+
+## License
+
+This project is licensed under the
+[Apache-2.0](https://github.com/tortoise/tortoise-cli/blob/main/LICENSE) License.

Makefile

@@ -0,0 +1,8 @@
+TORTOISE_ORM = {
+    "connections": {
+        "default": "sqlite://:memory:",
+    },
+    "apps": {
+        "models": {"models": ["examples.models"], "default_connection": "default"},
+    },
+}

README.md

@@ -0,0 +1,6 @@
+from tortoise import Model, fields
+
+
+class User(Model):
+    name = fields.CharField(max_length=20)
+    age = fields.IntField()