GPP Client Documentation¶
Welcome to the documentation for the GPP Python Client, a modern, fully asynchronous interface for interacting with GPP without requiring any GraphQL knowledge.
The client provides a clean Python API for GPP resources such as programs, observations, targets, and more. It also includes a configuration system, credential manager, command-line interface, and a high-level orchestration layer for complex multi-manager workflows.
This documentation serves both users of the client and developers maintaining or extending the library.
What This Documentation Covers¶
The documentation is organized to guide you from basic usage to advanced internals:
Getting Started — Install the client, configure credentials, and connect to GPP in minutes.
Client Overview — How
GPPClientresolves credentials, selects environments, and executes operations.Configuration — Learn how settings, tokens, and environments are stored and managed.
Authentication and Credentials — All supported authentication methods and how resolution precedence works.
CLI Reference — Command-line tools for configuring and interacting with GPP.
Resource Managers — Program-level APIs for resources such as programs, observations, and calls for proposals.
Orchestration Layer — Directors and Coordinators for service-specific, multi-manager workflows.
GPP GraphQL Building Blocks — Auto-generated types, inputs, and fields used internally by the client.
Exceptions — All exception types raised by the client.
Getting Started¶
If you’re new to the client:
Start with Getting Started.
Continue with the Client Overview to understand the core execution model.
These two pages provide everything needed to authenticate and begin interacting with GPP.
Contents¶
User Guide
Advanced