A Python client for running Geocortex Reporting jobs.
Project description
Geocortex Reporting Client for Python
This Python library makes it easy to run Geocortex Reporting or Geocortex Printing jobs.
Requirements
- Python 3.6 or later
Installing the package
pip install geocortex-reporting-client
Generating a report
The client exports a run
async function that will return a url to the report upon completion.
from geocortex.reporting.client import run
url = await run("itemid", [... other arguments])
Arguments
item_id
is required. All other arguments are optional.
Argument | Type | Description |
---|---|---|
item_id | str | The portal item ID of the Reporting or Printing item. |
portal_url | str | The URL of the ArcGIS Portal instance to use. Defaults to ArcGIS Online: "https://www.arcgis.com" |
token | str | The Portal access token to be used to access secured resources. If not provided requests to secured resources will fail. |
culture | str | The culture to use for localization. For example "en-US" . |
dpi | int | The DPI to use when rendering a map print. Defaults to 96 . |
use_polling | bool | When True , the job service will be polled periodically for results. When False , connect to the job service using WebSockets to listen for results. It's recommended to use WebSockets where possible. Defaults to False . |
**kwargs** | any | Other parameters to pass to the job. These are commonly used to parameterize your template. For example run("itemid", FeatureIds=[1, 2, 3]) |
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
Built Distribution
Close
Hashes for geocortex-reporting-client-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3936d4d39abaf860cd4a66913180c5d96866b86fb71ad9092f56ed26592be04e |
|
MD5 | f67ac7749735b20ef92b83b8e478eec3 |
|
BLAKE2b-256 | e68bcb205480eabd5eff5b4a4da3795e21686d6f96561909c45fbebea54def30 |
Close
Hashes for geocortex_reporting_client-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff95acd1abdacb1a2492d55c28144f1a3f53026532f03f1860ce12f7c0176342 |
|
MD5 | b47518a0f96f16b92240833fc76cd93e |
|
BLAKE2b-256 | feefb6ba707eab6c3fe0fa06b504658eb97f2d0904879c881e6a55a2ca7fe8d9 |