### Get PlantUML Image URL

Source: http://pythonhosted.org/plantuml

Generates the server URL for a PlantUML image, which can be directly used in an HTML IMG tag.

```python
get_url(_plantuml_text_)
```

--------------------------------

### PlantUML Class Initialization

Source: http://pythonhosted.org/plantuml

Initialize the PlantUML client to connect to a PlantUML server. Supports optional basic or form-based authentication and custom HTTP options.

```python
plantuml.PlantUML(url='http://www.plantuml.com/plantuml/img/', basic_auth={}, form_auth={}, http_opts={}, request_opts={})
```

--------------------------------

### PlantUML Class Initialization

Source: http://pythonhosted.org/plantuml

Initialize the PlantUML client to connect to a PlantUML server. Supports custom URLs and various authentication methods.

```APIDOC
## class plantuml.PlantUML(url='http://www.plantuml.com/plantuml/img/', basic_auth={}, form_auth={}, http_opts={}, request_opts={})

### Description
Connection to a PlantUML server with optional authentication.

### Parameters
* **url** (str) – URL to the PlantUML server image CGI. defaults to http://www.plantuml.com/plantuml/img/
* **basic_auth** (dict) – For basic HTTP authentication. Dictionary containing 'username' and 'password'.
* **form_auth** (dict) – For cookie-based webform login authentication. Dictionary containing 'url' for the login endpoint and 'body' for form elements. 'method' defaults to 'POST', 'headers' defaults to {'Content-type':'application/x-www-form-urlencoded'}.
* **http_opts** (dict) – Extra options for httplib2.Http() constructor.
* **request_opts** (dict) – Extra options for httplib2.Http().request() call.
```

--------------------------------

### Generate PNG from PlantUML Text File

Source: http://pythonhosted.org/plantuml

Use this command-line utility to convert a PlantUML text file into a PNG image. The output filename defaults to the input filename with a .png extension. Errors are written to a separate file.

```bash
$ python -m plantuml sample.txt
```

--------------------------------

### processes

Source: http://pythonhosted.org/plantuml

Processes PlantUML text markup and returns the raw PNG image data.

```APIDOC
## processes(plantuml_text)

### Description
Processes the plantuml text into the raw PNG image data.

### Parameters
* **plantuml_text** (str) – The plantuml markup to render

### Returns
the raw image data
```

--------------------------------

### deflate_and_encode

Source: http://pythonhosted.org/plantuml

Compresses PlantUML text using zlib and encodes it for the PlantUML server.

```APIDOC
## deflate_and_encode(plantuml_text)

### Description
zlib compress the plantuml text and encode it for the plantuml server.

### Parameters
* **plantuml_text** (str) – The plantuml markup to render
```

--------------------------------

### processes_file

Source: http://pythonhosted.org/plantuml

Processes a file containing PlantUML text markup into a PNG image file.

```APIDOC
## processes_file(filename, outfile=None, errorfile=None)

### Description
Take a filename of a file containing plantuml text and processes it into a .png image.

### Parameters
* **filename** (str) – Text file containing plantuml markup
* **outfile** (str) – Filename to write the output image to. If not supplied, then it will be the input filename with the file extension replaced with ‘.png’.
* **errorfile** (str) – Filename to write server html error page to. If this is not suppplied, 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`.
```

--------------------------------

### Process PlantUML File to PNG

Source: http://pythonhosted.org/plantuml

Converts a file containing PlantUML markup into a PNG image. Allows specifying output and error file names.

```python
processes_file(_filename_, _outfile=None_, _errorfile=None_)
```

--------------------------------

### get_url

Source: http://pythonhosted.org/plantuml

Generates the server URL for a given PlantUML text markup, suitable for use in HTML IMG tags.

```APIDOC
## get_url(plantuml_text)

### Description
Return the server URL for the image. You can use this URL in an IMG HTML tag.

### Parameters
* **plantuml_text** (str) – The plantuml markup to render

### Returns
the plantuml server image URL
```

--------------------------------

### Deflate and Encode PlantUML Text

Source: http://pythonhosted.org/plantuml

Compresses PlantUML text using zlib and encodes it for transmission to the PlantUML server.

```python
deflate_and_encode(_plantuml_text_)
```

--------------------------------

### Process PlantUML Text to PNG Data

Source: http://pythonhosted.org/plantuml

Processes PlantUML markup text and returns the raw PNG image data. This is useful for direct image manipulation or embedding.

```python
processes(_plantuml_text_)
```

--------------------------------

### encode

Source: http://pythonhosted.org/plantuml

Encodes PlantUML data, potentially compressed, for the PlantUML server.

```APIDOC
## encode(data)

### Description
encode the plantuml data which may be compresses in the proper encoding for the plantuml server

### Parameters
* **data** (str) – The plantuml data to encode
```

--------------------------------

### PlantUML Default Server URL

Source: http://pythonhosted.org/plantuml

The default URL for the public PlantUML image generation service.

```python
plantuml.SERVER_URL = 'http://www.plantuml.com/plantuml/img/'
```

--------------------------------

### Encode PlantUML Data

Source: http://pythonhosted.org/plantuml

Encodes PlantUML data, potentially compressed, into the format required by the PlantUML server.

```python
encode(_data_)
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.