Skip to main content

Python client for PMEase QuickBuild

Project description

Status

Build status Docs status Coverage status Version status Downloads status

Documentation

Read the Docs

Official REST API documentation

Installation

pip3 install -U quickbuild

Examples

Get server version:

from quickbuild import QBClient

client = QBClient('http://server', 'login', 'password')
version = client.system.get_version()
print(version)

With async client:

import asyncio
from quickbuild import AsyncQBClient

client = AsyncQBClient('http://server', 'login', 'password')

async def example():
    await client.system.get_version()

loop = asyncio.get_event_loop()
try:
    loop.run_until_complete(example())
finally:
    loop.run_until_complete(client.close())
    loop.close()

Content type

By default QuickBuild returns XML content, but starting from 10 version it also has native support of JSON content, usually it’s much more convenient to use native Python types (parsed XML) instead of pure XML string.

So, that is why current package introducing three types of content, this type and behaviour can be set globally for client instances, and can be rewritten for some methods.

  • PARSE (using by default)
    • GET: parse XML to native Python types.

    • POST: pure XML string.

  • XML
    • GET: return native XML without any transformations.

    • POST: pure XML string.

  • JSON (QuickBuild 10+)
    • GET: parsed JSON string.

    • POST: dumps object to JSON string.

Development

It’s possible to run QuickBuild community edition locally using docker:

Build locally:

docker build .  -f docker/QB10.Dockerfile -t quickbuild:10
docker run --restart always --name qb10 -d -p 8810:8810 quickbuild:10

Or using existed images:

docker run --restart always --name qb10 -d -p 8810:8810 pbelskiy/quickbuild:10

Then open http://localhost:8810/

Testing

Prerequisites: tox

Then just run tox, all dependencies and checks will run automatically

tox

Contributing

Feel free for any contributions.

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

quickbuild-0.6.0.tar.gz (27.7 kB view hashes)

Uploaded Source

Built Distribution

quickbuild-0.6.0-py3-none-any.whl (41.2 kB view hashes)

Uploaded Python 3

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