sqlcli

A command line interface (CLI) for interacting with SQLModel.


Keywords
sql, cli, typer, python, sqlmodel, rich, sqlalchemy
License
MIT
Install
pip install sqlcli==0.1.0

Documentation

sqlcli

PyPI version PyPI - Downloads

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        β”‚
β””β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜