xsdata-plantuml


Namexsdata-plantuml JSON
Version 24.3 PyPI version JSON
download
home_page
Summaryxsdata PlantUML generator
upload_time2024-03-10 09:59:40
maintainer
docs_urlNone
author
requires_python>=3.8
licenseMIT
keywords xsd wsdl schema dtd plantuml generator cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # [xsdata](https://pypi.org/project/xsdata/) - PlantUML plugin

Generate [PlantUML](https://plantuml.com/class-diagram) class diagrams from xml schemas,
wsdl definitions and directly from xml documents.

[![image](https://github.com/tefra/xsdata-plantuml/workflows/tests/badge.svg)](https://github.com/tefra/xsdata-plantuml/actions)
[![image](https://codecov.io/gh/tefra/xsdata-plantuml/branch/main/graph/badge.svg)](https://codecov.io/gh/tefra/xsdata-plantuml)
[![image](https://www.codefactor.io/repository/github/tefra/xsdata-plantuml/badge)](https://www.codefactor.io/repository/github/tefra/xsdata-plantuml)
[![image](https://img.shields.io/pypi/pyversions/xsdata-plantuml.svg)](https://pypi.org/pypi/xsdata-plantuml/)
[![image](https://img.shields.io/pypi/v/xsdata-plantuml.svg)](https://pypi.org/pypi/xsdata-plantuml/)

---

## Usage

```console
$ pip install xsdata-plantuml

$ xsdata samples/order.xsd --output plantuml --package samples
```

```
@startuml

class Items {
    +item : item[]
}
Items +-- item
class item {
    +productName : string
    +quantity : positiveInteger
    +USPrice : decimal
    +comment : comment
    +shipDate : date
    +partNum : string
}
class PurchaseOrderType {
    +shipTo : USAddress
    +billTo : USAddress
    +comment : comment
    +items : Items
    +orderDate : date
}
class USAddress {
    +name : string
    +street : string
    +city : string
    +state : string
    +zip : decimal
    +country : NMTOKEN
}
class comment {
    +value : string
}
class purchaseOrder {
}
purchaseOrder *- PurchaseOrderType

@enduml
```

![order.svg](https://github.com/tefra/xsdata-plantuml/raw/main/samples/order.svg)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "xsdata-plantuml",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "xsd,wsdl,schema,dtd,plantuml,generator,cli",
    "author": "",
    "author_email": "Christodoulos Tsoulloftas <chris@komposta.net>",
    "download_url": "https://files.pythonhosted.org/packages/13/19/0e4a73c384edd6638dd33f0e9f4b18c76456b9e4461cee41e01ca5299a10/xsdata_plantuml-24.3.tar.gz",
    "platform": null,
    "description": "# [xsdata](https://pypi.org/project/xsdata/) - PlantUML plugin\n\nGenerate [PlantUML](https://plantuml.com/class-diagram) class diagrams from xml schemas,\nwsdl definitions and directly from xml documents.\n\n[![image](https://github.com/tefra/xsdata-plantuml/workflows/tests/badge.svg)](https://github.com/tefra/xsdata-plantuml/actions)\n[![image](https://codecov.io/gh/tefra/xsdata-plantuml/branch/main/graph/badge.svg)](https://codecov.io/gh/tefra/xsdata-plantuml)\n[![image](https://www.codefactor.io/repository/github/tefra/xsdata-plantuml/badge)](https://www.codefactor.io/repository/github/tefra/xsdata-plantuml)\n[![image](https://img.shields.io/pypi/pyversions/xsdata-plantuml.svg)](https://pypi.org/pypi/xsdata-plantuml/)\n[![image](https://img.shields.io/pypi/v/xsdata-plantuml.svg)](https://pypi.org/pypi/xsdata-plantuml/)\n\n---\n\n## Usage\n\n```console\n$ pip install xsdata-plantuml\n\n$ xsdata samples/order.xsd --output plantuml --package samples\n```\n\n```\n@startuml\n\nclass Items {\n    +item : item[]\n}\nItems +-- item\nclass item {\n    +productName : string\n    +quantity : positiveInteger\n    +USPrice : decimal\n    +comment : comment\n    +shipDate : date\n    +partNum : string\n}\nclass PurchaseOrderType {\n    +shipTo : USAddress\n    +billTo : USAddress\n    +comment : comment\n    +items : Items\n    +orderDate : date\n}\nclass USAddress {\n    +name : string\n    +street : string\n    +city : string\n    +state : string\n    +zip : decimal\n    +country : NMTOKEN\n}\nclass comment {\n    +value : string\n}\nclass purchaseOrder {\n}\npurchaseOrder *- PurchaseOrderType\n\n@enduml\n```\n\n![order.svg](https://github.com/tefra/xsdata-plantuml/raw/main/samples/order.svg)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "xsdata PlantUML generator",
    "version": "24.3",
    "project_urls": {
        "Source": "https://github.com/tefra/xsdata-plantuml"
    },
    "split_keywords": [
        "xsd",
        "wsdl",
        "schema",
        "dtd",
        "plantuml",
        "generator",
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "402eb613514af26e48867258178b86ac7b84014202e1792fc9a521634f8b235f",
                "md5": "b051a0b0c3583a8463fe6a5bc2fe5ab6",
                "sha256": "a0d32f8bc514c7ae52242702fc852f57135768611fb523910a352f704ba45e8b"
            },
            "downloads": -1,
            "filename": "xsdata_plantuml-24.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b051a0b0c3583a8463fe6a5bc2fe5ab6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 5663,
            "upload_time": "2024-03-10T09:59:39",
            "upload_time_iso_8601": "2024-03-10T09:59:39.447950Z",
            "url": "https://files.pythonhosted.org/packages/40/2e/b613514af26e48867258178b86ac7b84014202e1792fc9a521634f8b235f/xsdata_plantuml-24.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "13190e4a73c384edd6638dd33f0e9f4b18c76456b9e4461cee41e01ca5299a10",
                "md5": "2e25306f96a4298fc062644786f6f06e",
                "sha256": "069e678207a7f9691d2e301512776640b3619de664ad58ecade30776e703c990"
            },
            "downloads": -1,
            "filename": "xsdata_plantuml-24.3.tar.gz",
            "has_sig": false,
            "md5_digest": "2e25306f96a4298fc062644786f6f06e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6490,
            "upload_time": "2024-03-10T09:59:40",
            "upload_time_iso_8601": "2024-03-10T09:59:40.999091Z",
            "url": "https://files.pythonhosted.org/packages/13/19/0e4a73c384edd6638dd33f0e9f4b18c76456b9e4461cee41e01ca5299a10/xsdata_plantuml-24.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-10 09:59:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tefra",
    "github_project": "xsdata-plantuml",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "xsdata-plantuml"
}
        
Elapsed time: 0.20050s