https://github.com/vertigis/vertigis-reporting-client-py
An easy to use Python API for generating reports using VertiGIS Studio Reporting, or prints using VertiGIS Studio Printing
https://github.com/vertigis/vertigis-reporting-client-py
arcgis geocortex printing python reporting vertigis
Last synced: 4 months ago
JSON representation
An easy to use Python API for generating reports using VertiGIS Studio Reporting, or prints using VertiGIS Studio Printing
- Host: GitHub
- URL: https://github.com/vertigis/vertigis-reporting-client-py
- Owner: vertigis
- License: mit
- Created: 2020-08-19T18:34:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-16T21:37:17.000Z (about 3 years ago)
- Last Synced: 2024-05-28T03:22:30.222Z (11 months ago)
- Topics: arcgis, geocortex, printing, python, reporting, vertigis
- Language: Python
- Homepage: https://developers.vertigisstudio.com/docs/reporting/sdk-py-overview
- Size: 59.6 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - vertigis/vertigis-reporting-client-py - An easy to use Python API for generating reports using VertiGIS Studio Reporting, or prints using VertiGIS Studio Printing (Python)
README
# VertiGIS Studio Reporting Client for Python
 
This Python library makes it easy to run [VertiGIS Studio Reporting](https://www.vertigisstudio.com/products/vertigis-studio-reporting/) or [VertiGIS Studio Printing](https://www.vertigisstudio.com/products/vertigis-studio-printing/) jobs.
## Requirements
- Python 3.6.1 or later
## Installing the package
This package is published to [PyPi](https://pypi.org/project/geocortex-reporting-client/), and can be installed using `pip`:
```bash
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.
```py
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"`. |
| result_file_name | str | The name assigned to the output file. It is used as the suggested name when downloading the result. |
| 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])` |
## Documentation
Find [further documentation on the SDK](https://developers.geocortex.com/docs/reporting/sdk-overview/) on the [VertiGIS Studio Developer Center](https://developers.geocortex.com/docs/reporting/overview/)