Metadata-Version: 2.1
Name: plantumlcli
Version: 0.0.2
Summary: An easy-to-use plantuml cli for everyone.
Home-page: UNKNOWN
Author: HansBug
Author-email: hansbug@buaa.edu.cn
License: UNKNOWN
Project-URL: Documentation, https://github.com/HansBug/plantumlcli/blob/main/README.md
Project-URL: Source, https://github.com/HansBug/plantumlcli
Project-URL: Issue tracker, https://github.com/HansBug/plantumlcli/issues
Description: # plantumlcli
        
        [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
        [![Code Lint](https://github.com/HansBug/plantumlcli/workflows/Code%20Lint/badge.svg)](https://github.com/HansBug/plantumlcli/actions?query=workflow%3A%22Code+Lint%22)
        [![Code Test](https://github.com/HansBug/plantumlcli/workflows/Code%20Test/badge.svg)](https://github.com/HansBug/plantumlcli/actions?query=workflow%3A%22Code+Test%22)
        [![Coverage Status](https://coveralls.io/repos/github/HansBug/plantumlcli/badge.svg?branch=main)](https://coveralls.io/github/HansBug/plantumlcli?branch=main)
        
        An easy-to-use plantuml cli for everyone.
        
        ## Install
        
        Install from official pypi
        
        ```bash
        pip install plantumlcli  # not online yet, do not use
        ```
        
        Install from source code
        
        ```bash
        git clone https://github.com/HansBug/plantumlcli
        cd plantumlcli && pip install .
        ```
        
        ## Using with cli
        
        ### Basic Usage
        
        Show version of `plantumlcli`
        
        ```bash
        plantumlcli -v
        ```
        
        Show help information of `plantumlcli`
        
        ```bash
        plantumlcli -h
        ```
        
        Check the local plantuml environment and remote plantuml host
        
        ```bash
        plantumlcli -c   # check both environments
        plantumlcli -cL  # check local environment only
        plantumlcli -cR  # check remote environment only
        ```
        
        In default, no local plantuml jar can be used, the remote host is set to the official one (http://www.plantuml.com/plantuml). But don't worry, you can specify your plantuml jar file or remote host by environment variables or command lines.
        
        ```bash
        plantumlcli -c                                             # local not okay, remote okay
        PLANTUML_HOST=http://plantuml.example.com plantumlcli -cR  # remote okay
        plantumlcli -cR -r http://plantuml.example.com             # remote okay
        PLANTUML_JAR=/my/path/plantuml.jar plantumlcli -cL         # local okay
        plantumlcli -cL -p /my/path/plantuml.jar                   # local okay
        ```
        
        Build image from plantuml source code
        
        ```bash
        plantumlcli source.puml                # the target image will be named as 'source.png'
        plantumlcli -o image.png source.puml   # the target image will be named as 'image.png'
        plantumlcli -t eps source.puml         # eps format is supported
        plantumlcli source1.puml source2.puml  # 2 source codes, the images' names will be 'source1.png' and 'source2.png'
        plantumlcli -o image1.png -o image2.png source1.puml source2.puml  # 2 source codes, image will be 'image1.png' and 'image2.png'
        
        PLANTUML_JAR=/my/path/plantuml.jar plantumlcli source.puml     # use local plantuml jar to build png
        PLANTUML_JAR=/my/path/plantuml.jar plantumlcli -L source.puml  # force use local plantuml jar to build png
        PLANTUML_HOST=http://plantuml.example.com plantuml source.puml     # use your plantuml host to build png
        PLANTUML_HOST=http://plantuml.example.com plantuml -R source.puml  # force use your plantuml host to build png
        ```
        
        You can also get the URL address of remote plantuml (in these cases, remote plantuml will be used regardless of `-L` and `-R` commands)
        
        ```bash
        plantumlcli -u helloworld.puml              # get png URL of helloworld.puml
        plantumlcli -u -t eps helloworld.puml       # get eps URL of helloworld.puml
        plantumlcli --homepage-url helloworld.puml  # get online editor's URL of helloworld.puml
        plantumlcli -u helloworld.puml common.puml  # get png URL of the 2 puml files (one line for one URL, in order)
        ```
        
        ## Using from python
        
        You can also use plantumlcli in python source code by `import`
        
        ```python
        # environment variables
        # PLANTUML_JAR=/path/to/plantuml.jar
        # PLANTUML_HOST=https://plantuml.example.com
        
        from pathlib import Path
        from plantumlcli import LocalPlantuml, RemotePlantuml
        
        if __name__ == "__main__":
            code = Path('source.puml').read_text()
        
            local = LocalPlantuml.autoload()
            print(local.dump_txt(code))                           # print text graph of code
            local.dump('/my/path/source_local.png', 'png', code)  # save png to /my/path/source_local.png
            local.dump('/my/path/source_local.eps', 'eps', code)  # save eps to /my/path/source_local.eps
        
            remote = RemotePlantuml.autoload()
            print(remote.dump_txt(code))                            # print text graph of code
            remote.dump('/my/path/source_remote.png', 'png', code)  # save png to /my/path/source_remote.png
            remote.dump('/my/path/source_remote.eps', 'eps', code)  # save eps to /my/path/source_remote.eps
            print(remote.get_url('png', code))                      # get png url from remote host
            print(remote.get_homepage_url(code))                    # get online editor's url from remote host
        
        ```
        
        ## Contributing
        
        Thank you for considering contributing to plantumlcli!
        
        The contribution guide will be completed soon after. (TODO: complete contribution guide)
        
        ## Links
        
        Github: [https://github.com/HansBug/plantumlcli](https://github.com/HansBug/plantumlcli)
        
        Documentation(just readme yet, will be written soon): [https://github.com/HansBug/plantumlcli/blob/main/README.md](https://github.com/HansBug/plantumlcli/blob/main/README.md)
        
        Issue Tracker: [https://github.com/HansBug/plantumlcli/issues](https://github.com/HansBug/plantumlcli/issues)
        
        Pypi: [https://test.pypi.org/project/plantumlcli/](https://test.pypi.org/project/plantumlcli/)
        
        ## Change log
        
        ### Version 0.0.1
        
        Released 2020-11-29
        
        * The first official `plantumlcli` version, cheers!!! :beers:
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.5
Description-Content-Type: text/markdown
