Skip to main content

Built-in platform provider for Pragmatiks

Project description

Pragma Provider

Built-in platform resources for Pragmatiks.

Declaratively manage secrets, non-sensitive configuration, and file storage alongside the rest of your infrastructure. The resources in this provider are available out of the box in every organization and are commonly referenced by other providers through FieldReference.

Installation

pip install pragmatiks-pragma-provider

or with uv:

uv add pragmatiks-pragma-provider

Resources

Resource Type Slug Description
Secret pragma/secret Platform-managed secrets referenced by other resources
Config pragma/config Non-sensitive configuration values shared across resources
File pragma/file Platform-managed file storage with public download URLs

Secret

Stores sensitive key-value data and exposes each entry as an output so that other resources can reference individual values through FieldReference.

Config:

  • data (dict[str, str], required, mutable) -- Key-value pairs of secret data. Values must be strings.

Outputs:

  • Each key-value pair from data is exposed as a separately referenceable output field (e.g., outputs.username, outputs.password).
resources:
  database-credentials:
    provider: pragma
    resource: secret
    config:
      data:
        username: app_service
        password: hunter2

Behavior:

  • Create: Stores each key as a separate output for downstream references.
  • Update: Replaces the full output set with the new data keys and values.
  • Delete: No-op. Secret state is held alongside the resource itself.

Config

Non-sensitive configuration store. Unlike pragma/secret, values may be any JSON-serializable type, which makes it a natural place to keep shared defaults (project IDs, regions, feature flags) that many resources reference.

Config:

  • data (dict[str, Any], required, mutable) -- Key-value pairs of configuration data. Values may be strings, numbers, booleans, lists, or nested objects.

Outputs:

  • Each key-value pair from data is exposed as a separately referenceable output field (e.g., outputs.project_id, outputs.region), preserving its original type.
resources:
  gcp-defaults:
    provider: pragma
    resource: config
    config:
      data:
        project_id: my-gcp-project
        region: us-central1
        tags:
          - production
          - primary

Behavior:

  • Create: Stores each key as a separate output for downstream references.
  • Update: Replaces the full output set with the new data keys and values.
  • Delete: No-op. Config state is held alongside the resource itself.

File

Platform-managed file storage. The actual file content is uploaded through the Pragmatiks API (POST /files/{name}/upload); this resource reads the uploaded metadata and exposes URLs, size, and checksum as outputs.

Config: none -- the resource tracks a file already uploaded through the Pragmatiks API under the resource's name.

Outputs:

  • url -- Internal pragma:// URL used for cross-resource references.
  • public_url -- Public HTTP URL for external download.
  • size -- File size in bytes.
  • content_type -- MIME type stored at upload time.
  • checksum -- SHA256 hash of the file content.
  • uploaded_at -- Timestamp the file was uploaded.
resources:
  onboarding-doc:
    provider: pragma
    resource: file
    config: {}

Behavior:

  • Create: Reads the uploaded file metadata and exposes URLs, size, and checksum as outputs. Fails with a clear error if the file content has not been uploaded yet.
  • Update: Re-reads the metadata from storage so outputs reflect the latest uploaded version.
  • Delete: Removes both the file content and its metadata from the underlying object store. Idempotent -- missing files are treated as already deleted.

Runtime Environment

The pragma/file resource reads storage configuration from environment variables populated by the Pragmatiks runtime. Standalone use is not supported.

Variable Purpose
PRAGMA_FILE_GCS_BUCKET Object-store bucket holding uploaded file content
PRAGMA_FILE_PUBLIC_URL Base URL used to compose public download URLs
PRAGMA_RUNTIME_ORGANIZATION_ID Identifies the organization's file prefix in the bucket

Development

# Run tests
task pragma:test

# Lint and type check
task pragma:check

# Format
task pragma:format

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pragmatiks_pragma_provider-5.0.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pragmatiks_pragma_provider-5.0.1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file pragmatiks_pragma_provider-5.0.1.tar.gz.

File metadata

File hashes

Hashes for pragmatiks_pragma_provider-5.0.1.tar.gz
Algorithm Hash digest
SHA256 248bbc99b4f17ea55918ae21ccb1a59bf1b9ec1b1fe2690640e38a6720a583a7
MD5 1daf44fa5f2187fb78881e48055f05ff
BLAKE2b-256 b91df3fa9321276643623589e31b9f54c596229d59c5534788d8e6b9edfd6024

See more details on using hashes here.

File details

Details for the file pragmatiks_pragma_provider-5.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pragmatiks_pragma_provider-5.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2bb93e9bbdcbf0744460ddda84c32f5ec44ccd0e1da90a41dddd7e4eba4ad18
MD5 85ac6c833a50fa257477dad150dccaf8
BLAKE2b-256 e3de84578fd070d3dbf0b0ce61ac84e35fc0dbaf59fc56c08aa7f64aa72ef4c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page