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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53bb167f53588ed95f87a819935c84971be264dd686d32fbdc377d8cac01f5bb |
|
MD5 | 89dc8c9a3cbe50b1019d710881f7760b |
|
BLAKE2b-256 | 010a3972a40173f8de2ee471c9154dda092585f9f37c8249c94c8825a7c65f45 |
Close
Hashes for geocortex_reporting_client-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c5fb3a9a876166e6802fdf9d8f75fbb67970e7ba1708bfccd8765e7a98e667b |
|
MD5 | 45991c75ccb159b3e2d678dc13a5e1a9 |
|
BLAKE2b-256 | 48cc7689b17077c9473afec937d55c5591a9a0899dbba8674c663a153dc6c305 |