Metadata-Version: 2.1
Name: sqlcli
Version: 0.1.0a0
Summary: A command line interface (CLI) for interacting with SQLModel.
License: MIT
Author: SamEdwardes
Author-email: edwardes.s@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: rich (>=11.0.0,<12.0.0)
Requires-Dist: sqlmodel (>=0.0.6,<0.0.7)
Requires-Dist: typer (>=0.3.0,<0.4.0)
Description-Content-Type: text/markdown

# sqlcli

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

<hr>

**Source code:** [https://github.com/SamEdwardes/sqlcli](https://github.com/SamEdwardes/sqlcli)

**Docs:** [https://samedwardes.github.io/sqlcli/](https://samedwardes.github.io/sqlcli/)

**PyPi:** *not yet published*

<hr>

## Installation

You can install *sqlcli* using pip:

```bash
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:

```bash
sqlcli init-demo
```

This will create a small sqlite database on your computer. The you can use sqlcli to explore your database.

```bash
sqlcli select athlete --database-url "sqlite:///demo_database.db" --models-module "demo_models.py"
```

