Metadata-Version: 2.1
Name: sqlite2png
Version: 1.1.4
Summary: Command line tool to get a png diagram of SQLite DB
Author-email: Anatoli Babenia <anatoli@rainforce.org>
Project-URL: homepage, https://github.com/abitrolly/sqlite2png
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Database :: Front-Ends
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE.sqlalchemy_schemadisplay
Requires-Dist: sqlalchemy
Requires-Dist: pydot

`sqlite2png` tool generates .png image of database schema.

[![PyPI](https://img.shields.io/pypi/v/sqlite2png)](https://pypi.org/project/sqlite2png/)

### Usage

From checkout without installing (needs `sqlalchemy` and `pydot`).
```bash
./sqlite2png.py sqlite.db
```
The diagram is written into `db.png`.

Install with pip and run as module.
```bash
pip install sqlite2png
sqlite2png /usr/share/ibus-libpinyin/db/english.db
```
```
sqlite:////usr/share/ibus-libpinyin/db/english.db
writing db.png
```

![](examples/english.png)

### About and examples

`sqlite2png` is a CLI wrapper over
[`sqlalchemy_schemadisplay`](https://github.com/fschulze/sqlalchemy_schemadisplay)
lib by Florian Schulze, which uses `SQLAlchemy`, `pydot` and `graphviz`
under the hood. `Graphviz-cairo` is also recommended to improve image quality.

See [./examples](./examples).

### Roadmap / Changelog

* [ ] de-vendorize `sqlalchemy_schemadisplay` after it is released
* [ ] output .png to stdout
* [ ] option to show the image (needs PIL and image viewer)
* [ ] option to diff the image
* [ ] support full urls
```
    {py} postgres://user:pwd@host/database
    {py} sqlite:////usr/share/my.db
```
* [x] (1.1.4) install command line script with `pip`
* [x] (1.1.4) add example DB to the repo (uses some public DBs)
* [x] reproducuble .png (seems like it already is)
