diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..915a6ff --- /dev/null +++ b/.gitignore @@ -0,0 +1,40 @@ +*.py[cod] + +# C extensions +*.so + +# Packages +*.egg +*.egg-info +dist +build +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg +lib +lib64 + +# Doug +*.env +docs/_build +comments.txt + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox +nosetests.xml + +# Translations +*.mo + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..fa5e6e2 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,22 @@ +Copyright (c) 2013, Doug Napoleone +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..18a1458 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,5 @@ +include README.rst +include LICENSE.txt +recursive-include docs Makefile *.py *.rst +recursive-exclude *.env * +recursive-exclude * *.py[co] diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..0bed231 --- /dev/null +++ b/README.rst @@ -0,0 +1,23 @@ +`Plantuml`_ is a library for generating UML diagrams from a simple text markup +language. + +This is a simple python remote client interface to a `plantuml`_ server using +the same custom encoding used by most other plantuml `clients`_. Python was +missing from the list, and while there are other plantuml python libraries, +like `sphinxcontrib-plantuml`_, they require downloading and installing the +java executable and spawning a shell subprocesses. + +This client defaults to the public `plantuml server`_, but can be used against +any server. + +Project Links: + +* `Documentation `_ +* `PyPi `_ +* `GitHub `_ + + +.. _plantuml: http://plantuml.sourceforge.net/index.html +.. _clients: http://plantuml.sourceforge.net/running.html +.. _plantuml server: http://www.plantuml.com/plantuml/ +.. _sphinxcontrib-plantuml: https://pypi.python.org/pypi/sphinxcontrib-plantuml diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..833ac81 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/plantuml.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/plantuml.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/plantuml" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/plantuml" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..59bc071 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,255 @@ +# -*- coding: utf-8 -*- +# +# plantuml documentation build configuration file, created by +# sphinx-quickstart on Fri May 17 16:20:50 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +sys.path.append(os.path.dirname(os.path.dirname(__file__))) +import plantuml + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'plantuml' +copyright = u'2013, ' + plantuml.__author__ + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '.'.join(str(x) for x in plantuml.__version__[:-1]) +# The full version, including alpha/beta/rc tags. +release = plantuml.__version_string__ + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'plantumldoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'plantuml.tex', u'plantuml Documentation', + u'Doug Napoleone', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'plantuml', u'plantuml Documentation', + [u'Doug Napoleone'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'plantuml', u'plantuml Documentation', + u'Doug Napoleone', 'plantuml', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..12c6e9c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,53 @@ +.. plantuml documentation master file, created by + sphinx-quickstart on Fri May 17 16:20:50 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to plantuml's documentation! +==================================== + +.. include:: ../README.rst + +Commandline Use +=============== + +**sample.txt** + +.. literalinclude:: ../test/basic.txt + +**commandline** + +.. code:: console + + $ ls + sample.txt + $ python -m plantuml sample.txt + sample.txt: success. + $ ls + sample.png sample.txt + + +**sample.png** + +.. image:: ../test/basic_out.png + + + +Library +=========== + +.. automodule:: plantuml + :members: + +License +=========== + +.. include:: ../LICENSE.txt + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` + diff --git a/plantuml.py b/plantuml.py new file mode 100644 index 0000000..657215d --- /dev/null +++ b/plantuml.py @@ -0,0 +1,219 @@ +""" +""" +import zlib +import httplib2 +import os +import sys + +__version__ = [0,1,0] +__version_string__ = '.'.join(str(x) for x in __version__) + +__author__ = 'Doug Napoleone' +__email__ = 'doug.napoleone+plantuml@gmail.com' + +#: Default plantuml service url +SERVER_URL = 'http://www.plantuml.com/plantuml/img/' + +class PlantUMLError(Exception): + """Error in processing. + """ + pass + +class PlantUMLConnectionError(PlantUMLError): + """Error connecting or talking to PlantUML Server. + """ + pass + +class PlantUMLHTTPError(PlantUMLConnectionError): + """Request to PlantUML server returned HTTP Error. + """ + def __init__(self, response, content, *args, **kwdargs): + super(PlantUMLConnectionError, self).__init__(*args, **kwdargs) + self.response = response + self.content = content + if not self.message: + self.message = "%d: %s" % ( + self.response.status, self.response.reason) + +def deflate_and_encode(plantuml_text): + """zlib compress the plantuml text and encode it for the plantuml server. + """ + zlibbed_str = zlib.compress(plantuml_text) + compressed_string = zlibbed_str[2:-4] + return encode(compressed_string) + +def encode(data): + """encode the plantuml data which may be compresses in the proper + encoding for the plantuml server + """ + res = "" + for i in xrange(0,len(data), 3): + if (i+2==len(data)): + res += _encode3bytes(ord(data[i]), ord(data[i+1]), 0) + elif (i+1==len(data)): + res += _encode3bytes(ord(data[i]), 0, 0) + else: + res += _encode3bytes(ord(data[i]), ord(data[i+1]), ord(data[i+2])) + return res + +def _encode3bytes(b1, b2, b3): + c1 = b1 >> 2; + c2 = ((b1 & 0x3) << 4) | (b2 >> 4); + c3 = ((b2 & 0xF) << 2) | (b3 >> 6); + c4 = b3 & 0x3F; + res = ""; + res += _encode6bit(c1 & 0x3F); + res += _encode6bit(c2 & 0x3F); + res += _encode6bit(c3 & 0x3F); + res += _encode6bit(c4 & 0x3F); + return res; + +def _encode6bit(b): + if b < 10: + return chr(48 + b) + b -= 10 + if b < 26: + return chr(65 + b) + b -= 26 + if b < 26: + return chr(97 + b); + b -= 26 + if b == 0: + return '-' + if b == 1: + return '_' + return '?' + + +class PlantUML(object): + """Connection to a PlantUML server with optional authentication. + + All parameters are optional. + + :param str url: URL to the PlantUML server image CGI. defaults to + http://www.plantuml.com/plantuml/img/ + :param dict basic_auth: This is if the plantuml server requires basic HTTP + authentication. Dictionary containing two keys, 'username' + and 'password', set to appropriate values for basic HTTP + authentication. + :param dict form_auth: This is for plantuml server requires a cookie based + webform login authentication. Dictionary containing two + primary keys, 'url' and 'body'. The 'url' should point to + the login URL for the server, and the 'body' should be a + dictionary set to the form elements required for login. + The key 'method' will default to 'POST'. The key 'headers' + defaults to + {'Content-type':'application/x-www-form-urlencoded'}. + Example: form_auth={'url': 'http://example.com/login/', + 'body': { 'username': 'me', 'password': 'secret'} + :param dict http_opts: Extra options to be passed off to the + httplib2.Http() constructor. + :param dict request_opts: Extra options to be passed off to the + httplib2.Http().request() call. + + """ + def __init__(self, url=SERVER_URL, basic_auth={}, form_auth={}, + http_opts={}, request_opts={}): + self.url = url + self.request_opts = request_opts + self.auth_type = 'basic_auth' if basic_auth else ( + 'form_auth' if form_auth else None) + self.auth = basic_auth if basic_auth else ( + form_auth if form_auth else None) + + self.http = httplib2.Http(**http_opts) + if self.auth_type == 'basic_auth': + self.http.add_credentials( + self.auth['username'], self.auth['password']) + elif self.auth_type == 'form_auth': + if 'url' not in self.auth: + raise PlantUMLError( + "The form_auth option 'url' must be provided and point to " + "the login url.") + if 'body' not in self.auth: + raise PlantUMLError( + "The form_auth option 'body' must be provided and include " + "a dictionary with the form elements required to log in. " + "Example: form_auth={'url': 'http://example.com/login/', " + "'body': { 'username': 'me', 'password': 'secret'}") + login_url = self.auth['url'] + body = self.auth['body'] + method = self.auth.get('method', 'POST') + headers = self.auth.get( + 'headers',{'Content-type':'application/x-www-form-urlencoded'}) + + try: + response, content = http.request( + login_url, method, headers=headers, + body=urllib.urlencode(body)) + except HttpLib2Error, e: + raise PlantUMLConnectionError(e) + if response.status != 200: + raise PlantUMLHTTPError(response, content) + self.request_opts['Cookie'] = response['set-cookie'] + + def get_url(self, plantuml_text): + """Return the server URL for the image. + You can use this URL in an IMG HTML tag. + + :param str plantuml_text: The plantuml markup to render + :returns: the plantuml server image URL + """ + return self.url + deflate_and_encode(plantuml_text) + + def processes(self, plantuml_text): + """Processes the plantuml text into the raw PNG image data. + + :param str plantuml_text: The plantuml markup to render + :returns: the raw image data + """ + url = self.get_url(plantuml_text) + try: + response, content = self.http.request(url, **self.request_opts) + except HttpLib2Error, e: + raise PlantUMLConnectionError(e) + if response.status != 200: + raise PlantUMLHTTPError(response, content) + return content + + def processes_file(self, filename, outfile=None, errorfile=None): + """Take a filename of a file containing plantuml text and processes + it into a .png image. + + :param str filename: Text file containing plantuml markup + :param str outfile: Filename to write the output image to. If not + supplied, then it will be the input filename with the + file extension replaced with '.png'. + :param str errorfile: Filename to write server html error page + to. If this is not supplined, then it will be the + input ``filename`` with the extension replaced with + '_error.html'. + :returns: ``True`` if the image write succedded, ``False`` if there was + an error written to ``errorfile``. + """ + if outfile is None: + outfile = os.path.splitext(filename)[0] + '.png' + if errorfile is None: + errorfile = os.path.splitext(filename)[0] + '_error.html' + data = open(filename, 'U').read() + try: + content = self.processes(data) + except PlantUMLHTTPError, e: + err = open(errorfile, 'w') + err.write(e.content) + err.close() + return False + out = open(outfile, 'wb') + out.write(content) + out.close() + return True + +if __name__ == '__main__': + pl = PlantUML() + for filename in sys.argv[1:]: + print filename+':', + if pl.processes_file(filename): + print 'success.' + else: + print 'failure.' + \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..ceeb7f8 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +sphinx +sphinx-PyPI-upload +httplib2 + diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..5257e7f --- /dev/null +++ b/setup.cfg @@ -0,0 +1,10 @@ +[metadata] +description-file = README.rst + +[build_sphinx] +source-dir = docs/ +build-dir = docs/_build +all_files = 1 + +[upload_sphinx] +upload-dir = docs/_build/html diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..7050cfa --- /dev/null +++ b/setup.py @@ -0,0 +1,28 @@ +from setuptools import setup, find_packages +import plantuml + +setup( + name="plantuml", + version=plantuml.__version_string__, + description="", + long_description=open('README.rst').read(), + url="https://github.com/dougn/python-plantuml/", + author=testtrackpro.__author__, + author_email=testtrackpro.__email__, + license="BSD", + py_modules=['plantuml'], + classifiers=[ + "Development Status :: 3 - Alpha", + "Programming Language :: Python", + "Programming Language :: Python :: 2.6", + "Programming Language :: Python :: 2.7", + "Intended Audience :: Developers", + "Intended Audience :: System Administrators", + "License :: OSI Approved :: BSD License", + "Topic :: Internet :: WWW/HTTP", + "Topic :: Utilities", + "Topic :: Software Development :: Libraries :: Python Modules", + ], + install_requires=['httplib2',], + keywords=["plantuml", "uml"], +) diff --git a/test/.DS_Store b/test/.DS_Store new file mode 100644 index 0000000..5008ddf Binary files /dev/null and b/test/.DS_Store differ diff --git a/test/basic.png b/test/basic.png new file mode 100644 index 0000000..86306a6 Binary files /dev/null and b/test/basic.png differ diff --git a/test/basic.txt b/test/basic.txt new file mode 100644 index 0000000..2d74a6c --- /dev/null +++ b/test/basic.txt @@ -0,0 +1,5 @@ +title Authentication Sequence + +Alice->Bob: Authentication Request +note right of Bob: Bob thinks about it +Bob->Alice: Authentication Response diff --git a/test/basic_out.png b/test/basic_out.png new file mode 100644 index 0000000..5556bbe Binary files /dev/null and b/test/basic_out.png differ