pycarlo 0.10.227__tar.gz → 0.12.33__tar.gz

{pycarlo-0.10.227 → pycarlo-0.12.33}/.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
-deploy_filter: &deploy_filter
-  # YAML reference for tag based filtering on deployments
+deploy_filter:
+  &deploy_filter # YAML reference for tag based filtering on deployments
   filters:
     tags:
       only: /^v.*/
@@ -15,18 +15,14 @@ test_steps: &test_steps
         name: Update pip
         command: pip install --upgrade pip
     - run:
-        name: Install dependencies
-        command: pip install virtualenv==20.26.1
-    - run:
-        name: Run unit tests
-        command: make install-with-tests
+        name: Run tests and checks
+        command: |
+          make install
+          make test
 
 sanity_check: &sanity_check_steps
   steps:
     - checkout
-    - run:
-        name: Install dependencies
-        command: pip install virtualenv==20.26.1
     - run:
         name: Make Sanity Check
         command: |
@@ -67,22 +63,17 @@ jobs:
       - image: python:3.9
     <<: *sanity_check_steps
 
-  deploy:
+  deploy: # cci-ignore
     docker:
       - image: python:3.8.6
 
     steps:
       - checkout
-      - run:
-          name: Install dependencies
-          command: pip install virtualenv==20.26.1
       - run:
           name: Deploy to PyPI
           command: make distribute
 
 workflows:
-  version: 2
-
   build:
     jobs:
       - run-test-3-8
@@ -91,9 +82,9 @@ workflows:
       - run-test-3-11
       - run-test-3-12
       - run-sanity-check:
-          context: mc-prod
+          context: mc-prod # cci-ignore
 
-  deploy:
+  deploy: # cci-ignore
     jobs:
       - run-test-3-8:
           <<: *deploy_filter
@@ -106,7 +97,7 @@ workflows:
       - run-test-3-12:
           <<: *deploy_filter
       - run-sanity-check:
-          context: mc-prod
+          context: mc-prod # cci-ignore
           <<: *deploy_filter
       - deploy:
           requires:

pycarlo-0.12.33/.circleci/scripts/clean-generated-types-prs.sh

@@ -0,0 +1,171 @@
+#!/bin/bash
+set -euo pipefail
+
+# Colors for output
+RED='\033[1;31m'
+GREEN='\033[1;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;36m'  # Light cyan/blue
+NC='\033[0m' # No Color
+
+# Print functions
+info() {
+    echo -e "${BLUE}$1${NC}" >&2
+}
+
+success() {
+    echo -e "${GREEN}$1${NC}" >&2
+}
+
+warn() {
+    echo -e "${YELLOW}[WARNING]${NC} $1" >&2
+}
+
+error() {
+    echo -e "${RED}[ERROR]${NC} $1" >&2
+}
+
+# Function to trigger type generation workflow for a given monolith PR
+rerun_generation() {
+    local monolith_pr=$1
+    info "Triggering type generation workflow for monolith PR #$monolith_pr..."
+
+    # Get the branch name for the monolith PR
+    local monolith_branch
+    monolith_branch=$(gh pr view "$monolith_pr" --repo monte-carlo-data/monolith-django --json headRefName --jq '.headRefName' 2>/dev/null)
+
+    if [ -z "$monolith_branch" ]; then
+        error "Failed to get branch name for monolith PR #$monolith_pr"
+        return 1
+    fi
+
+    info "Found monolith branch: $monolith_branch"
+
+    # Get the latest workflow run for this branch
+    local run_id
+    run_id=$(gh run list --repo monte-carlo-data/monolith-django \
+        --workflow handle-pycarlo-schema-changes.yml \
+        --branch "$monolith_branch" \
+        --limit 1 \
+        --json databaseId \
+        --jq '.[0].databaseId' 2>/dev/null)
+
+    if [ -z "$run_id" ]; then
+        error "No workflow runs found for monolith PR #$monolith_pr (branch: $monolith_branch)"
+        return 1
+    fi
+
+    info "Found workflow run ID: $run_id"
+
+    # Rerun the workflow
+    if gh run rerun "$run_id" --repo monte-carlo-data/monolith-django; then
+        success "Successfully triggered workflow rerun for monolith PR #$monolith_pr"
+        return 0
+    else
+        error "Failed to rerun workflow for monolith PR #$monolith_pr"
+        return 1
+    fi
+}
+
+info "Checking for existing PRs with same changes as main..."
+
+# Check for clean working directory
+if ! git diff --quiet || ! git diff --cached --quiet; then
+  error "Working directory has uncommitted changes. Please commit or stash them before running this script."
+  exit 1
+fi
+
+# Get all open PRs that match our branch naming pattern
+OPEN_PRS=$(gh pr list --base main --search "update-types-from-monolith- in:title is:open" --json number,headRefName,url --jq '.[]')
+
+git fetch -q origin main
+for pr in $(echo "${OPEN_PRS}" | jq -c '.'); do
+  PR_NUMBER=$(echo "$pr" | jq -r '.number')
+  PR_BRANCH=$(echo "$pr" | jq -r '.headRefName')
+  PR_URL=$(echo "$pr" | jq -r '.url')
+  MONOLITH_PR=$(echo "$PR_BRANCH" | sed -n 's/.*update-types-from-monolith-\([0-9]*\).*/\1/p')
+
+  info "Comparing current branch with PR #$PR_NUMBER (branch: $PR_BRANCH)..."
+
+  # Check if the related monolith PR is closed/merged
+  # If so, we will go ahead and close the SDK PR because
+  # it's more likely than not no longer needed and any changes
+  # should already be in main or will get into main via one of the open ones
+  if [ -n "$MONOLITH_PR" ]; then
+    info "Checking status of monolith PR #$MONOLITH_PR..."
+    MONOLITH_STATUS=$(gh pr view "$MONOLITH_PR" --repo monte-carlo-data/monolith-django --json state --jq '.state' 2>/dev/null || echo "NOT_FOUND")
+
+    if [ "$MONOLITH_STATUS" = "CLOSED" ] || [ "$MONOLITH_STATUS" = "MERGED" ]; then
+      warn "Monolith PR #$MONOLITH_PR is $MONOLITH_STATUS. Closing SDK PR #$PR_NUMBER..."
+      gh pr close "$PR_NUMBER" --delete-branch --comment "Closing this PR as the related monolith PR #$MONOLITH_PR has been $MONOLITH_STATUS."
+      echo
+      continue
+    elif [ "$MONOLITH_STATUS" = "NOT_FOUND" ]; then
+      warn "Could not find monolith PR #$MONOLITH_PR"
+    else
+      info "Monolith PR #$MONOLITH_PR is still open ($MONOLITH_STATUS)"
+    fi
+  fi
+
+  # Fetch the PR branch and main
+  git fetch -q origin "$PR_BRANCH"
+
+  # Track whether PR should be closed
+  is_same_as_main=false
+
+  # Fetch the PR branch
+  if ! git fetch -q origin "$PR_BRANCH"; then
+    error "Failed to fetch branch $PR_BRANCH for PR #$PR_NUMBER. Skipping..."
+    continue
+  fi
+
+  # Compare PR branch with main
+  if git diff --quiet origin/"$PR_BRANCH" origin/main; then
+    info "Existing PR #$PR_NUMBER is same as main: $PR_URL"
+    is_same_as_main=true
+  else
+    # Create a temporary branch from the PR branch
+    if ! git checkout -q -b temp_"$PR_BRANCH" origin/"$PR_BRANCH" 2>/dev/null; then
+      error "Failed to checkout branch $PR_BRANCH for PR #$PR_NUMBER. Skipping..."
+      continue
+    fi
+
+    # Attempt to merge latest from main into the temporary branch
+    if git merge --quiet origin/main --no-ff -m "Merging latest from main" > /dev/null 2>&1; then
+      # Now compare with main
+      if git diff --quiet origin/main; then
+        info "PR #$PR_NUMBER is now same as main after merging: $PR_URL"
+        is_same_as_main=true
+      else
+        info "PR #$PR_NUMBER still has changes compared to main: $PR_URL"
+      fi
+    else
+      warn "Merge conflict detected for PR #$PR_NUMBER. Closing to allow fresh regeneration..."
+      # Clean up: abort the merge
+      git merge --abort
+      # Switch back to original branch and delete the temporary branch
+      git checkout -q -
+      git branch -q -D temp_"$PR_BRANCH"
+      # Close the PR
+      info "API repo PR: https://github.com/monte-carlo-data/monolith-django/pull/$MONOLITH_PR"
+      gh pr close "$PR_NUMBER" --delete-branch --comment "Closing this PR due to merge conflicts with main. Types will be regenerated on the next update."
+
+      # Rerun the workflow for the monolith PR
+      rerun_generation "$MONOLITH_PR"
+
+      continue
+    fi
+
+    # Switch back to original branch and delete the temporary branch
+    git checkout -q -
+    git branch -q -D temp_"$PR_BRANCH"
+  fi
+
+  # Close PR if it's the same as main
+  if [ "$is_same_as_main" = true ]; then
+    info "API repo PR: https://github.com/monte-carlo-data/monolith-django/pull/$MONOLITH_PR"
+    warn "Closing PR #$PR_NUMBER..."
+    gh pr close "$PR_NUMBER" --delete-branch --comment "Closing this PR as there are no remaining changes compared to current main."
+  fi
+  echo
+done

{pycarlo-0.10.227 → pycarlo-0.12.33}/.gitignore

@@ -14,8 +14,9 @@ dist/
 downloads/
 eggs/
 .eggs/
-lib/
+/lib/
 !pycarlo/lib/
+!tests/lib/
 lib64/
 parts/
 sdist/
@@ -132,3 +133,8 @@ dmypy.json
 .idea/
 
 .DS_Store
+
+.ruff_cache/
+
+# used in tests/test_forgiving_enums_published.sh
+test-forgiving-enums-venv

{pycarlo-0.10.227 → pycarlo-0.12.33}/.pre-commit-config.yaml

@@ -8,6 +8,7 @@ repos:
         types: [python]
         pass_filenames: true
         args: [format]
+        exclude: ^(pycarlo/lib/schema\.py|tests/data/schema_original\.py)$
   - repo: local
     hooks:
       - id: ruff-check
@@ -17,6 +18,7 @@ repos:
         types: [python]
         pass_filenames: true
         args: [check, --fix, --exit-non-zero-on-fix]
+        exclude: ^(pycarlo/lib/schema\.py|tests/data/schema_original\.py)$
   - repo: local
     hooks:
       - id: pyright
@@ -26,3 +28,4 @@ repos:
         types: [python]
         pass_filenames: true
         args: [--level, error]
+        exclude: ^(pycarlo/lib/schema\.py|tests/data/schema_original\.py)$

pycarlo-0.12.33/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contribution Guidelines
+
+This is primarily for Monte Carlo developers. External contributions are welcome, but you may want
+to reach out though support first to discuss your proposed changes.
+
+## Setting up for development
+
+```sh
+make install-dev
+```
+
+This will create a virtual environment, install dependencies, and set up pre-commit hooks.
+
+## Updating Typed Schema to Match GraphQL API
+
+The schema is automatically kept up-to-date by our CI pipeline when changes are merged to the API
+repo. You typically don't need to run `make generate` unless you're testing or debugging an issue
+locally.
+
+If you do need to manually update the schema for testing on your development machine, use
+`make generate`. This will fetch the latest schema from the API and regenerate the Python types,
+including any customizations.
+
+## Schema Customizations
+
+The generated `schema.py` is automatically modified during the build process to apply the following
+customizations. See [pycarlo/lib/README.md](pycarlo/lib/README.md) for more details. If you need to
+make additional customizations, you need to do so through that process.
+
+## Testing
+
+`make test` can be used to run all tests locally. CircleCI manages testing for deployment.
+
+## Releases
+
+Our CI pipeline is configured to automatically update the schema and run tests when changes are
+merged to the default branch in our API repo. It will also automatically deploy a new versioned
+release.
+
+### Custom Releases
+
+If you need to make a custom release, create a PR against `main`.
+
+When ready to release after merging, create a new
+[Github release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)
+with a tag using semantic versioning (e.g. `v0.42.0`) and CircleCI will test and publish to PyPI.
+Note that an existing version will not be deployed.

pycarlo-0.12.33/Makefile

@@ -0,0 +1,135 @@
+.PHONY: default clean install install-dev pip-install generate generate-local retrieve-schema transform-schema format-schema update-test-schema customize-schema env-check-venv test sanity-check
+.SILENT: generate generate-local # Prevent echoing of any tokens
+
+PACKAGE_NAME=pycarlo
+ENVIRONMENT_NAME=venv
+MCD_URL=https://api.getmontecarlo.com/graphql
+
+# Schema generator util
+SCHEMA_GEN_UTIL=utils/generate.py
+SANITY_CHECK_UTIL=utils/sanity.py
+ENV_UTIL=utils/env.sh
+ENV_FILE=utils/.env
+SAMPLE_ENV_FILE=utils/sample.env
+
+# Generated schema destinations
+SCHEMA_FROM_INTROSPECTION=$(PACKAGE_NAME)/lib/schema.json
+SCHEMA_PY=$(PACKAGE_NAME)/lib/schema.py
+SCHEMA_TEST_DATA=tests/data/schema_original.py
+
+default:
+	@echo "Refer to CONTRIBUTING.md for details on common tasks."
+
+clean:
+	@echo "Cleaning up existing build artifacts..."; \
+	rm -rf $(ENVIRONMENT_NAME) build dist $(PACKAGE_NAME).egg-info .coverage nosetests.xml
+
+pip-install:
+	@echo "\nInstalling Python package in editable mode..."; \
+	pip install --editable .
+
+install: clean
+ifeq ("$(wildcard $(ENV_FILE))","")
+	@echo "\nCreating env file from sample..."; \
+	cp $(SAMPLE_ENV_FILE) $(ENV_FILE)
+endif
+	@echo "\nCreating virtual environment..."; \
+	python3 -m venv $(ENVIRONMENT_NAME);
+	@echo "\nInstalling dependencies..."; \
+	. $(ENVIRONMENT_NAME)/bin/activate; \
+	pip install -r requirements-dev.txt; \
+	$(MAKE) pip-install; \
+	pip show $(PACKAGE_NAME)
+
+# Full development setup = install + pre-commit hooks
+install-dev: install
+	@echo "\nInstalling pre-commit hooks..."; \
+	. $(ENVIRONMENT_NAME)/bin/activate; \
+	pre-commit install; \
+	echo ""; \
+	echo "\033[0;32m✅ Development environment ready!\033[0m"; \
+	echo "\nActivate with: . $(ENVIRONMENT_NAME)/bin/activate"
+
+sanity-check: env-check-venv
+	@echo "\nRunning sanity checks..."; \
+	. $(ENVIRONMENT_NAME)/bin/activate; \
+	sh $(ENV_UTIL) python $(SANITY_CHECK_UTIL); \
+
+# Requires .env or profile credentials setup before usage.
+retrieve-schema:
+	@echo "\nRetrieving latest schema..."; \
+	. $(ENVIRONMENT_NAME)/bin/activate; \
+	sh $(ENV_UTIL) python $(SCHEMA_GEN_UTIL) $(MCD_URL) $(SCHEMA_FROM_INTROSPECTION);
+
+# Expects $(SCHEMA_FROM_INTROSPECTION) to already exist.
+transform-schema:
+	@echo "\nGenerating Python types from schema.json..."; \
+	. $(ENVIRONMENT_NAME)/bin/activate; \
+	sgqlc-codegen schema --docstrings $(SCHEMA_FROM_INTROSPECTION) $(SCHEMA_PY);
+
+format-schema:
+	@echo "\nFormatting Python code..."; \
+	. $(ENVIRONMENT_NAME)/bin/activate; \
+	ruff format $(SCHEMA_PY);
+
+update-test-schema:
+	@echo "\nUpdating test data with original schema..."; \
+	mkdir -p tests/data; \
+	cp $(SCHEMA_PY) $(SCHEMA_TEST_DATA);
+
+customize-schema:
+	@echo "\nApplying schema customizations..."; \
+	if [ "$$(uname)" = "Darwin" ]; then \
+		sed -i '' 's/class Connection(sgqlc.types.relay.Connection):/class Connection(sgqlc.types.Type):/g' $(SCHEMA_PY); \
+		sed -i '' 's/import sgqlc.types$$/import sgqlc.types\nimport pycarlo.lib.types/g' $(SCHEMA_PY); \
+		sed -i '' 's/class \([A-Za-z0-9_]*\)(sgqlc.types.Enum):/class \1(pycarlo.lib.types.Enum):/g' $(SCHEMA_PY); \
+	else \
+		sed -i 's/class Connection(sgqlc.types.relay.Connection):/class Connection(sgqlc.types.Type):/g' $(SCHEMA_PY); \
+		sed -i 's/import sgqlc.types$$/import sgqlc.types\nimport pycarlo.lib.types/g' $(SCHEMA_PY); \
+		sed -i 's/class \([A-Za-z0-9_]*\)(sgqlc.types.Enum):/class \1(pycarlo.lib.types.Enum):/g' $(SCHEMA_PY); \
+	fi; \
+	echo "*************"; \
+	echo "The following schema customizations have been applied:"; \
+	echo "  1. Changed 'class Connection(sgqlc.types.relay.Connection)' to 'class Connection(sgqlc.types.Type)'"; \
+	echo "  2. Changed all Enum classes to use 'pycarlo.lib.types.Enum' for backward compatibility"; \
+	echo "*************"; \
+
+env-check-venv:
+	@if [ ! -d "$(ENVIRONMENT_NAME)" ]; then \
+		echo "\033[0;31m❌ Error: Virtual environment not found. Please run 'make install' first.\033[0m"; \
+		exit 1; \
+	fi
+
+# Generate schema from existing schema.json (skip retrieval).
+# Used by CI when schema.json is already provided.
+generate-local: env-check-venv transform-schema format-schema update-test-schema customize-schema
+	@echo "\n\033[0;32m✅ Schema generation complete!\033[0m";
+
+# Requires .env or profile credentials setup before usage.
+generate: env-check-venv retrieve-schema generate-local
+
+test: env-check-venv
+	@echo "\nRunning tests..."; \
+	. $(ENVIRONMENT_NAME)/bin/activate; \
+	export DEBUG=True; \
+	pytest --durations=5 ./tests; \
+	echo ""; \
+	echo "Linting and formatting..."; \
+	ruff check .; \
+	ruff format --check .; \
+	echo ""; \
+	echo "Type checking..."; \
+	pyright .
+	@echo "\n\033[0;32m✅ All tests and checks passed!\033[0m";
+
+# this is only used by CI. See circleci/config.yml:
+distribute: install
+	@echo "\nInstalling dependencies..."; \
+	. $(ENVIRONMENT_NAME)/bin/activate; \
+	pip install -r requirements-ci.txt; \
+	echo "\nRunning setup..."; \
+	python setup.py sdist bdist_wheel; \
+	echo "\nChecking distribution..."; \
+	twine check dist/*; \
+	echo "\nUploading distribution to PyPI..."; \
+	twine upload --non-interactive dist/*

{pycarlo-0.10.227 → pycarlo-0.12.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycarlo
-Version: 0.10.227
+Version: 0.12.33
 Summary: Monte Carlo's Python SDK
 Home-page: https://www.montecarlodata.com/
 Author: Monte Carlo Data, Inc
@@ -25,9 +25,7 @@ Requires-Dist: requests<3.0.0,>=2.0.0
 Requires-Dist: responses>=0.20.0
 Requires-Dist: sgqlc<17.0,>=14.1
 
-# Pycarlo
-
-Monte Carlo's Alpha Python SDK!
+# Pycarlo - Monte Carlo's Python SDK
 
 ## Installation
 
@@ -40,23 +38,22 @@ virtualenv venv
 pip install -U pycarlo
 ```
 
-Developers of the SDK can use:
-
-```shell
-make install-with-tests
-. venv/bin/activate
-pre-commit install
-```
-
 ## Overview
 
 Pycarlo comprises two components: `core` and `features`.
 
-All Monte Carlo API queries and mutations that you could execute via the API are supported via the `core` library. Operations can be executed as first class objects, using [sgqlc](https://github.com/profusion/sgqlc), or as raw GQL with variables. In both cases, a consistent object where fields can be referenced by dot notation and the more pythonic snake_case is returned for ease of use.
+All Monte Carlo API queries and mutations that you could execute via the API are supported via the
+`core` library. Operations can be executed as first class objects, using
+[sgqlc](https://github.com/profusion/sgqlc), or as raw GQL with variables. In both cases, a
+consistent object where fields can be referenced by dot notation and the more pythonic snake_case is
+returned for ease of use.
 
-The `features` library provides additional convenience for performing common operations like with dbt, circuit breaking, and pii filtering.
+The `features` library provides additional convenience for performing common operations like with
+dbt, circuit breaking, and pii filtering.
 
-Note that an API Key is required to use the SDK. See [here](https://docs.getmontecarlo.com/docs/developer-resources#creating-an-api-key) for details on how to generate one.
+Note that an API Key is required to use the SDK. See
+[our docs on generating API keys](https://docs.getmontecarlo.com/docs/developer-resources#creating-an-api-key)
+for details.
 
 ## Basic usage
 
@@ -144,13 +141,20 @@ print(client(mutation))
 # ]
 ```
 
-Note that you can find Monte Carlo's API reference [here](https://apidocs.getmontecarlo.com/).
+### Examples
+
+We have [a few examples here you can reference](./examples).
 
-For details and additional examples on how to map (convert) GraphQL queries to `sgqlc` operations please refer to the docs [here](https://sgqlc.readthedocs.io/en/latest/sgqlc.operation.html).
+See [Monte Carlo's API reference](https://apidocs.getmontecarlo.com/) for all supported queries and
+mutations.
+
+For details and additional examples on how to map (convert) GraphQL queries to `sgqlc` operations
+please refer to [the sgqlc docs](https://sgqlc.readthedocs.io/en/latest/sgqlc.operation.html).
 
 ### Features
 
-You can use [pydoc](https://docs.python.org/3.8/library/pydoc.html) to retrieve documentation on any feature packages (`pydoc pycarlo.features`).
+You can use [pydoc](https://docs.python.org/library/pydoc.html) to retrieve documentation on any
+feature packages (`pydoc pycarlo.features`).
 
 For instance for [circuit breakers](https://docs.getmontecarlo.com/docs/circuit-breakers):
 
@@ -160,9 +164,13 @@ pydoc pycarlo.features.circuit_breakers.service
 
 ## Session configuration
 
-By default, when creating a client the `default` profile from `~/.mcd/profiles.ini` is used. This file created via [montecarlo configure](https://docs.getmontecarlo.com/docs/using-the-cli#setting-up-the-cli) on the CLI. Note that you can find Monte Carlo's CLI reference [here](https://clidocs.getmontecarlo.com/).
+By default, when creating a client the `default` profile from `~/.mcd/profiles.ini` is used. This
+file created via
+[montecarlo configure](https://docs.getmontecarlo.com/docs/using-the-cli#setting-up-the-cli) on the
+CLI. See [Monte Carlo's CLI reference](https://clidocs.getmontecarlo.com/) for more details.
 
-You can override this usage by creating a custom `Session`. For instance, if you want to pass the ID and Token:
+You can override this usage by creating a custom `Session`. For instance, if you want to pass the ID
+and Token:
 
 ```python
 from pycarlo.core import Client, Session
@@ -174,7 +182,8 @@ Sessions support the following params:
 
 - `mcd_id`: API Key ID.
 - `mcd_token`: API secret.
-- `mcd_profile`: Named profile containing credentials. This is created via the CLI (e.g. `montecarlo configure --profile-name zeus`).
+- `mcd_profile`: Named profile containing credentials. This is created via the CLI (e.g.
+  `montecarlo configure --profile-name zeus`).
 - `mcd_config_path`: Path to file containing credentials. Defaults to `~/.mcd/`.
 
 You can also specify the API Key, secret or profile name using the following environment variables:
@@ -183,7 +192,8 @@ You can also specify the API Key, secret or profile name using the following env
 - `MCD_DEFAULT_API_TOKEN`
 - `MCD_DEFAULT_PROFILE`
 
-When creating a session any explicitly passed `mcd_id` and `mcd_token` params take precedence, followed by environmental variables and then any config-file options.
+When creating a session any explicitly passed `mcd_id` and `mcd_token` params take precedence,
+followed by environmental variables and then any config-file options.
 
 Environment variables can be mixed with passed credentials, but not the config-file profile.
 
@@ -191,9 +201,11 @@ Environment variables can be mixed with passed credentials, but not the config-f
 
 ## Integration Gateway API
 
-There are features that require the Integration Gateway API instead of the regular GraphQL Application API, for example Airflow Callbacks invoked by the `airflow-mcd` library.
+There are features that require the Integration Gateway API instead of the regular GraphQL
+Application API, for example Airflow Callbacks invoked by the `airflow-mcd` library.
 
-To use the Gateway you need to initialize the `Session` object passing a `scope` parameter and then use `make_request` to invoke Gateway endpoints:
+To use the Gateway you need to initialize the `Session` object passing a `scope` parameter and then
+use `make_request` to invoke Gateway endpoints:
 
 ```python
 from pycarlo.core import Client, Session
@@ -211,17 +223,22 @@ The following values also be set by the environment:
 - `MCD_VERBOSE_ERRORS`: Enable logging. This includes a trace ID for each session and request.
 - `MCD_API_ENDPOINT`: Customize the endpoint where queries and mutations are executed.
 
-## Tests and releases
+## Enum Backward Compatibility
+
+Unlike the baseline `sgqlc` behavior, this SDK is designed to maintain backward compatibility when
+new enum values are added to the Monte Carlo API. If the API returns an enum value that doesn't
+exist in your SDK version, it will be returned as a string with a warning logged, rather than
+raising an error. This allows older SDK versions to continue working when new features are added.
 
-To update queries and mutations via introspection, use `make generate`.
+To avoid warnings and ensure full feature support, keep your SDK updated to the latest version.
 
-`make test` can be used to run all tests locally. CircleCI manages all testing for deployment. When ready for a review, create a PR against `main`.
+## Contributing
 
-When ready to release, create a new [Github release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) with a tag using semantic versioning (e.g. `v0.42.0`) and CircleCI will test and publish to PyPI. Note that an existing version will not be deployed.
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
 
 ## References
 
-- Dashboard: <https://getmontecarlo.com>
+- Monte Carlo App: <https://getmontecarlo.com>
 - Product docs: <https://docs.getmontecarlo.com>
 - Status page: <https://status.getmontecarlo.com>
 - API (and SDK): <https://apidocs.getmontecarlo.com>
@@ -229,4 +246,4 @@ When ready to release, create a new [Github release](https://docs.github.com/en/
 
 ## License
 
-Apache 2.0 - See the [LICENSE](http://www.apache.org/licenses/LICENSE-2.0) for more information.
+Apache 2.0 - See the [LICENSE](./LICENSE) for more information.