How cognitedata/cognite-sdk-python works
The Cognite Python SDK lets developers and data scientists call Cognite Data Fusion (CDF) from Python. The principal workflow is to construct a client, invoke a domain API, send requests through shared asynchronous API and HTTP layers, and receive Python resource objects or errors. The README documents both native async use and a synchronous client that wraps the async client. The graph groups major API capabilities and shared runtime layers; several domain APIs are represented by their exact enclosing directories because their individual implementations were not sampled.
Main entry points: _api_client.py API operations · _cognite_client.py Async client · _basic_api_client.py HTTP API base · _sync_cognite_client.py Sync client
Components 27
Client entry points
- Async client
cognite/client/_cognite_client.py - Sync client
cognite/client/_sync_cognite_client.py
CDF domain APIs
- Time series and datapoints
cognite/client/_api - Data modeling
cognite/client/_api/data_modeling - Files and documents
cognite/client/_api - Transformations
cognite/client/_api/transformations - Workflows
cognite/client/_api/workflows - IAM and Raw
cognite/client/_api
Request runtime
- API operations
cognite/client/_api_client.py - HTTP API base
cognite/client/_basic_api_client.py - HTTP transport
cognite/client/_http_client.py
Data and results
- Resource models
cognite/client/data_classes/_base.py - Datapoint models
cognite/client/data_classes/datapoints.py - Query filters
cognite/client/data_classes/filters.py - IAM models
cognite/client/data_classes/iam.py - Workflow models
cognite/client/data_classes/workflows.py - HTTP responses
cognite/client/response.py
Runtime support
- Client configuration
cognite/client/config.py - SDK errors
cognite/client/exceptions.py - SDK constants
cognite/client/_constants.py - Async helpers
cognite/client/utils/_async_helpers.py - Concurrency
cognite/client/utils/_concurrency.py - Shared utilities
cognite/client/utils/_auxiliary.py - Identifiers
cognite/client/utils/_identifier.py - JSON conversion
cognite/client/utils/_json_extended.py - Text utilities
cognite/client/utils/_text.py
Other components
- SDK user
Connections 35
- SDK user → Async client: creates
README.md - SDK user → Sync client: creates
README.md - Async client → Time series and datapoints: exposes APIs
cognite/client/_cognite_client.py - Async client → Data modeling: exposes APIs
cognite/client/_cognite_client.py - Async client → Files and documents: exposes APIs
cognite/client/_cognite_client.py - Async client → Transformations: exposes APIs
cognite/client/_cognite_client.py - Async client → Workflows: exposes APIs
cognite/client/_cognite_client.py - Async client → IAM and Raw: exposes APIs
cognite/client/_cognite_client.py - Sync client → Async client: wraps
README.md - Sync client → Async helpers: runs synchronously
cognite/client/_sync_cognite_client.py - Time series and datapoints → API operations: uses operations
cognite/client/_api/raw/databases.py - Data modeling → API operations: uses operations
- Files and documents → API operations: uses operations
cognite/client/_api/document_preview.py - Transformations → API operations: uses operations
- Workflows → API operations: uses operations
cognite/client/_api/workflows/tasks.py - IAM and Raw → API operations: uses operations
cognite/client/_api/raw/databases.py - API operations → HTTP API base: delegates requests
cognite/client/_api_client.py - API operations → Resource models: loads resources
cognite/client/_api_client.py - API operations → Query filters: uses filters
cognite/client/_api_client.py - API operations → SDK errors: raises errors
cognite/client/_api_client.py - API operations → Shared utilities: uses helpers
cognite/client/_api_client.py - API operations → Concurrency: coordinates tasks
cognite/client/_api_client.py - API operations → Identifiers: uses identifiers
cognite/client/_api_client.py - API operations → Text utilities: uses text helpers
cognite/client/_api_client.py - HTTP API base → HTTP transport: sends requests
cognite/client/_basic_api_client.py - HTTP API base → Client configuration: reads settings
cognite/client/_basic_api_client.py - HTTP API base → HTTP responses: builds responses
cognite/client/_basic_api_client.py - HTTP API base → SDK errors: handles errors
cognite/client/_basic_api_client.py - HTTP API base → JSON conversion: converts JSON
cognite/client/_basic_api_client.py - Async helpers → Concurrency: uses executor
cognite/client/utils/_async_helpers.py - Shared utilities → Resource models: converts resources
cognite/client/utils/_auxiliary.py - Shared utilities → HTTP responses: unpacks responses
cognite/client/utils/_auxiliary.py - Time series and datapoints → Datapoint models: uses models
cognite/client/_api/datapoint_tasks.py - IAM and Raw → IAM models: uses models
cognite/client/_api/iam/sessions.py - Workflows → Workflow models: uses models
cognite/client/_api/workflows/tasks.py