Skip to main content

Python client for the PlantUML server

Project description

Plantweb is a project that provides a command line interface, Sphinx directives and an API that allows to render powerful plain text UML diagrams, ASCII diagrams and complex graphs.

It is a Python client for the PlantUML server and thus it can render PlantUML, Graphviz and Ditaa diagrams without the need to install them.

Plantweb features a local cache that prevents requesting the server for previously rendered diagrams, speeding up building documentation with lots of diagrams.

Finally, being pure Python, non-local rendering, Plantweb is an excellent way to display and render PlantUML, Graphviz and Ditaa diagrams in ReadTheDocs published documentation.

Documentation

https://plantweb.readthedocs.io/

Changelog

0.5.0 (Unreleased)

New

  • Sphinx directives now support passing a source file as argument.

0.4.0

New

  • Added a set of Sphinx directives uml, graph and diagram.

0.3.0

New

  • Default options can now be overriden with a .plantwebrc file in the user home or in the git repository root.

0.2.0

Fixes

  • Fixed bug when calling render_cache that returned a non-tuple.

Changes

  • Documentation was greatly improved.

0.1.0

New

  • Initial public release.

License

Copyright (C) 2016 Carlos Jenkins

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plantweb-1.0.0.tar.gz (15.5 kB view details)

Uploaded Source

File details

Details for the file plantweb-1.0.0.tar.gz.

File metadata

  • Download URL: plantweb-1.0.0.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for plantweb-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e5990f777324c47117ad464be2b66dcebb69108b9655006fe38a724f5dff97c0
MD5 4937cf48c5924174e59ae21526253292
BLAKE2b-256 947fb9f8cfdf6aca31161e3a92887fd7fd2b137a9644c0ad2ad7da07c11e6fac

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page