acugis-report — Python SDK

Official Python client and CLI for AcuGIS Report Server.

Package: acugis-report · Import: acugis_report · Version: 0.1.0 · Python 3.10+

API contract: openapi.bundle.yaml

Product docs: Python SDK · CLI overview

Install

pip install acugis-report
acugis-report --help

from acugis_report import ReportServer

To work on this repository:

cd sdk/python
pip install -e ".[dev]"
pytest

Quick start

from acugis_report import ReportServer

client = ReportServer("https://reports.example.com", token="jrs_…")

me = client.auth.me()
reports = client.reports.list()
pdf, content_type = client.reports.run("Invoice", format="pdf", params={"city": "NYC"})
client.reports.run_to_file("Invoice", "invoice.pdf", format="pdf")

tree = client.folders.tree()
client.resources.upload("logo.png", folder_id=0)
client.health.check()
client.explorer.query({"datasource": "main", "sql": "SELECT 1"})
client.map_reports.run("Parcels", geometry="…", srid=4326)
client.embedded_maps.debug("Parcels")
client.datasources.list()

Flat methods remain available for backward compatibility (client.list_reports(), client.run_report(…), etc.).

Environment

Service namespaces

Errors

Typed errors derive from ReportServerError:

• AuthenticationError (401)
• PermissionError (403)
• ValidationError (400 / 422)
• NotFoundError (404)
• ServerError (5xx)
• NetworkError
• NotImplementedByServerError

CLI

acugis-report --help

See the CLI reference and the CLI overview.

Build & test

cd sdk/python
pip install -e ".[dev]"
pytest
python -m build
python -m twine check dist/*

License

MIT — see LICENSE.