Metadata-Version: 2.1
Name: erdantic
Version: 0.1.2
Summary: Entity relationship diagrams for Python data model classes like Pydantic.
Home-page: https://github.com/drivendataorg/erdantic
Author: DrivenData
Author-email: info@drivendata.org
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/drivendataorg/erdantic/issues
Project-URL: Documentation, https://erdantic.drivendata.org/
Project-URL: Source Code, https://github.com/drivendataorg/erdantic
Description: # erdantic: Entity Relationship Diagrams
        
        [![Docs Status](https://img.shields.io/badge/docs-latest-blueviolet)](https://erdantic.drivendata.org/)
        [![PyPI](https://img.shields.io/pypi/v/erdantic.svg)](https://pypi.org/project/erdantic/)
        [![conda-forge](https://img.shields.io/conda/vn/conda-forge/erdantic.svg)](https://anaconda.org/conda-forge/erdantic)
        [![tests](https://github.com/drivendataorg/erdantic/workflows/tests/badge.svg?branch=main)](https://github.com/drivendataorg/erdantic/actions?query=workflow%3Atests+branch%3Amain)
        [![codecov](https://codecov.io/gh/drivendataorg/erdantic/branch/main/graph/badge.svg)](https://codecov.io/gh/drivendataorg/erdantic)
        
        **erdantic** is a simple tool for drawing [entity relationship diagrams (ERDs)](https://en.wikipedia.org/wiki/Data_modeling#Entity%E2%80%93relationship_diagrams) for Python data model classes. Diagrams are rendered using the venerable [Graphviz](https://graphviz.org/) library. Supported data modeling frameworks are:
        
        - [Pydantic](https://pydantic-docs.helpmanual.io/)
        - [dataclasses](https://docs.python.org/3/library/dataclasses.html) from the Python standard library
        
        Features include a convenient CLI, automatic native rendering in Jupyter notebooks, and easy extensibility to other data modeling frameworks. Docstrings are even accessible as tooltips for SVG outputs. Great for adding a simple and clean data model reference to your documentation.
        
        <img alt="Example diagram created by erdantic" src="https://raw.githubusercontent.com/drivendataorg/erdantic/main/docs/docs/examples/pydantic.svg">
        
        ## Installation
        
        erdantic's graph modeling depends on [pygraphviz](https://pygraphviz.github.io/documentation/stable/index.html) and [Graphviz](https://graphviz.org/), an open-source C library. Graphviz must be installed first, and the simplest way is with [conda](https://anaconda.org/conda-forge/graphviz). For other options and installation troubleshooting, see the [pygraphviz docs](https://pygraphviz.github.io/documentation/stable/install.html).
        
        To install erdantic from PyPI:
        
        ```bash
        pip install erdantic
        ```
        
        ### Development version
        
        You can get the development version from GitHub with:
        
        ```bash
        pip install https://github.com/drivendataorg/erdantic.git#egg=erdantic
        ```
        
        ## Quick Usage
        
        The fastest way to produce a diagram like the above example is to use the erdantic CLI. Simply specify the full dotted path to your data model class and an output path. The rendered format is interpreted from the filename extension.
        
        ```bash
        erdantic erdantic.examples.pydantic.Party -o diagram.png
        ```
        
        You can also import the erdantic Python library and use its functions.
        
        ```python
        import erdantic as erd
        from erdantic.examples.pydantic import Party
        
        # Easy one-liner
        erd.draw(Party, out="diagram.png")
        
        # Or create a diagram object that you can inspect and do stuff with
        diagram = erd.create(Party)
        diagram.models
        #> [PydanticModel(Adventurer), PydanticModel(Party), PydanticModel(Quest), PydanticModel(QuestGiver)]
        diagram.draw("diagram.png")
        ```
        
        Check out the "Usage Examples" section of our [docs](https://erdantic.drivendata.org/) to see more.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Code Generators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
