Metadata-Version: 2.1
Name: peewee-erd
Version: 0.1.2
Summary: Draw the ER diagram based on peewee models.
Home-page: https://github.com/rominf/peewee-erd
License: Apache-2.0
Author: Roman Inflianskas
Author-email: infroma@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Provides-Extra: live-view
Requires-Dist: PySide2 (>=5.13,<6.0); extra == "live-view"
Requires-Dist: dataclasses (>=0.6,<0.7); python_version < "3.7"
Requires-Dist: docopt (>=0.6.2,<0.7.0)
Requires-Dist: graphviz (>=0.13.0,<0.14.0)
Requires-Dist: jinja2 (>=2.10,<3.0)
Requires-Dist: peewee (>=3.0,<4.0)
Requires-Dist: poetry-version (>=0.1.3,<0.2.0)
Requires-Dist: watchdog (>=0.9.0,<0.10.0)
Project-URL: Repository, https://github.com/rominf/peewee-erd
Description-Content-Type: text/markdown

peewee ERD
==========

Draw ER diagram based on peewee models.

This project is heavily based on https://github.com/gustavi/peewee-graph-models.

Installation
------------

To install the peewee ERD use `pip`:

```shell
$ pip install peewee-erd
```

To install the peewee ERD with live view use `pip` with extras:

```shell
$ pip install peewee-erd[live-view]
```

Usage
-----

To draw the diagram, display, and update it on file changes, run it with the path of models file:
```shell
$ PATH_OF_MODELS_FILE=...
$ peewee-erd $PATH_OF_MODELS_FILE
```

For more other variants of usage see help:
```shell
$ peewee-erd --help
```

