A command line interface (CLI) for interacting with SQLModel.
Project description
sqlcli
A command line interface (CLI) for interacting with SQLModel.
Source code: https://github.com/SamEdwardes/sqlcli
Docs: https://samedwardes.github.io/sqlcli/
PyPi: https://pypi.org/project/sqlcli/
Features
The key features are:
- Read data using the
sqlcli select
command. - Insert data using the
sqlcli insert
command. - Interactive console powered by typer, rich, and sqlmodel.
- Pretty terminal outputs generated by rich.
- Multiple output formats including rich, json, and python dictionaries.
Installation
You can install sqlcli using pip:
pip install sqlcli
This will make the sqlcli
command available in your python environment.
Usage
The quickest way to get started with sqlcli is to create a demo sqlite database:
sqlcli init-demo
This will create a small sqlite database on your computer. The you can use sqlcli to explore your database. View your table by using the select
command.
sqlcli select athlete -d "sqlite:///sqlcli_demo/database.db" -m "sqlcli_demo/models.py"
┏━━━━┳━━━━━━━━━━┳━━━━━━━━━━┓
┃ id ┃ name ┃ sport_id ┃
┡━━━━╇━━━━━━━━━━╇━━━━━━━━━━┩
│ 1 │ Ronaldo │ 1 │
│ 2 │ Messi │ 1 │
│ 3 │ Beckham │ 1 │
│ 4 │ Gretzky │ 2 │
│ 5 │ Crosby │ 2 │
│ 6 │ Ovechkin │ 2 │
│ 7 │ Sundin │ 2 │
│ 8 │ Domi │ 2 │
│ 9 │ Carter │ 1 │
└────┴──────────┴──────────┘
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sqlcli-0.1.0.tar.gz
(9.3 kB
view hashes)
Built Distribution
sqlcli-0.1.0-py3-none-any.whl
(10.1 kB
view hashes)