{"id":14065105,"url":"https://github.com/vertigis/vertigis-reporting-client-py","last_synced_at":"2026-03-08T23:34:52.613Z","repository":{"id":43831512,"uuid":"288808790","full_name":"vertigis/vertigis-reporting-client-py","owner":"vertigis","description":"An easy to use Python API for generating reports using VertiGIS Studio Reporting, or prints using VertiGIS Studio Printing","archived":false,"fork":false,"pushed_at":"2022-02-16T21:37:17.000Z","size":61,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-16T16:51:44.980Z","etag":null,"topics":["arcgis","geocortex","printing","python","reporting","vertigis"],"latest_commit_sha":null,"homepage":"https://developers.vertigisstudio.com/docs/reporting/sdk-py-overview","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vertigis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-19T18:34:18.000Z","updated_at":"2025-10-06T09:32:55.000Z","dependencies_parsed_at":"2022-09-26T21:51:30.375Z","dependency_job_id":null,"html_url":"https://github.com/vertigis/vertigis-reporting-client-py","commit_stats":null,"previous_names":["geocortex/vertigis-reporting-client-py"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/vertigis/vertigis-reporting-client-py","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertigis%2Fvertigis-reporting-client-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertigis%2Fvertigis-reporting-client-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertigis%2Fvertigis-reporting-client-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertigis%2Fvertigis-reporting-client-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vertigis","download_url":"https://codeload.github.com/vertigis/vertigis-reporting-client-py/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vertigis%2Fvertigis-reporting-client-py/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30277043,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-08T20:45:49.896Z","status":"ssl_error","status_checked_at":"2026-03-08T20:45:49.525Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arcgis","geocortex","printing","python","reporting","vertigis"],"created_at":"2024-08-13T07:04:18.111Z","updated_at":"2026-03-08T23:34:52.588Z","avatar_url":"https://github.com/vertigis.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# VertiGIS Studio Reporting Client for Python\n\n![CI](https://github.com/geocortex/vertigis-reporting-client-py/workflows/CI/badge.svg) ![PyPI](https://img.shields.io/pypi/v/geocortex-reporting-client)\n\nThis 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.\n\n## Requirements\n\n- Python 3.6.1 or later\n\n## Installing the package\n\nThis package is published to [PyPi](https://pypi.org/project/geocortex-reporting-client/), and can be installed using `pip`:\n\n```bash\npip install geocortex-reporting-client\n```\n\n## Generating a report\n\nThe client exports a `run` async function that will return a url to the report upon completion.\n\n```py\nfrom geocortex.reporting.client import run\n\nurl = await run(\"itemid\", [... other arguments])\n```\n\n### Arguments\n\n`item_id` is required. All other arguments are optional.\n\n| Argument       | Type | Description                                                                                                                                                                                                                    |\n| -------------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| item_id        | str  | The portal item ID of the Reporting or Printing item.                                                                                                                                                                          |\n| portal_url     | str  | The URL of the ArcGIS Portal instance to use. Defaults to ArcGIS Online: `\"https://www.arcgis.com\"`                                                                                                                            |\n| token          | str  | The Portal access token to be used to access secured resources. If not provided requests to secured resources will fail.                                                                                                       |\n| culture        | str  | The culture to use for localization. For example `\"en-US\"`.                                                                                                                                                                    |\n| result_file_name    | str  | The name assigned to the output file. It is used as the suggested name when downloading the result.  |\n| dpi            | int  | The DPI to use when rendering a map print. Defaults to `96`.                                                                                                                                                                   |\n| 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`. |\n| \\*\\*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])`                                                                                  |\n\n## Documentation\n\nFind [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/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvertigis%2Fvertigis-reporting-client-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvertigis%2Fvertigis-reporting-client-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvertigis%2Fvertigis-reporting-client-py/lists"}