policyengine-household-api 0.14.3__py3-none-any.whl

policyengine_household_api/ai_templates/__init__.py

@@ -0,0 +1 @@
+from .household_explainer import household_explainer_template

policyengine_household_api/ai_templates/household_explainer.py

@@ -0,0 +1,23 @@
+import anthropic
+
+household_explainer_template = f"""{anthropic.HUMAN_PROMPT} You are an AI assistant explaining US policy calculations. 
+  The user has run a simulation for the variable '{{variable}}'.
+  The below is a computation tree segment for the variable '{{variable}}' 
+  describing the variable and all its sub-variables, as well as each 
+  variable's entity group.
+  {{computation_tree_segment}}
+  Here's an ordered list of the entity groups in the simulation and their
+  individual entities:
+  {{entity_description}}
+  Note that the user is interested in the value of '{{variable}}' associated 
+  with entity '{{entity}}'.
+      
+  Please explain this result in simple terms. Your explanation should:
+  1. Briefly describe what {{variable}} is.
+  2. Explain the main factors that led to this result.
+  3. Mention any key thresholds or rules that affected the calculation.
+  4. If relevant, suggest how changes in input might affect this result.
+      
+  Keep your explanation concise but informative, suitable for a general audience. Do not start with phrases like "Certainly!" or "Here's an explanation. It will be rendered as markdown, so preface $ with \.
+  
+  {anthropic.AI_PROMPT}"""

policyengine_household_api/api.py

@@ -0,0 +1,93 @@
+"""
+This is the main Flask app for the PolicyEngine API.
+"""
+
+# Python imports
+import os
+from pathlib import Path
+
+# External imports
+from flask_cors import CORS
+import flask
+from flask_sqlalchemy import SQLAlchemy
+from sqlalchemy.orm import DeclarativeBase
+from dotenv import load_dotenv
+from flask_limiter import Limiter
+from flask_limiter.util import get_remote_address
+from policyengine_household_api.data.analytics_setup import (
+    initialize_analytics_db_if_enabled,
+)
+
+# Internal imports
+from .decorators.auth import create_auth_decorator
+from .constants import VERSION, REPO
+from policyengine_household_api.decorators.analytics import (
+    log_analytics_if_enabled,
+)
+
+# Endpoints
+from .endpoints import (
+    get_home,
+    get_calculate,
+    generate_ai_explainer,
+)
+
+# Create the authentication decorator (will be either Auth0 or no-op based on config)
+require_auth_if_enabled = create_auth_decorator()
+
+
+print("Initialising API...")
+
+app = application = flask.Flask(__name__)
+
+CORS(app)
+
+# Use in-memory storage for rate limiting
+# Note that this provides limits per-instance;
+# rate limits not shared if scaling more than 1 instance.
+limiter = Limiter(
+    app=app,
+    key_func=get_remote_address,
+    default_limits=[],
+    storage_uri="memory://",
+)
+
+initialize_analytics_db_if_enabled(app)
+
+app.route("/", methods=["GET"])(get_home)
+
+
+@app.route("/<country_id>/calculate", methods=["POST"])
+@require_auth_if_enabled()
+@log_analytics_if_enabled
+def calculate(country_id):
+    return get_calculate(country_id)
+
+
+@app.route("/<country_id>/ai-analysis", methods=["POST"])
+@require_auth_if_enabled()
+def ai_analysis(country_id: str):
+    return generate_ai_explainer(country_id)
+
+
+@app.route("/liveness_check", methods=["GET"])
+def liveness_check():
+    return flask.Response(
+        "OK", status=200, headers={"Content-Type": "text/plain"}
+    )
+
+
+@app.route("/readiness_check", methods=["GET"])
+def readiness_check():
+    return flask.Response(
+        "OK", status=200, headers={"Content-Type": "text/plain"}
+    )
+
+
+@app.route("/<country_id>/calculate_demo", methods=["POST"])
+@limiter.limit("1 per second")
+def calculate_demo(country_id):
+    return get_calculate(country_id)
+
+
+print("API initialised.")

policyengine_household_api/auth/validation.py

@@ -0,0 +1,18 @@
+import json
+from urllib.request import urlopen
+
+from authlib.oauth2.rfc7523 import JWTBearerTokenValidator
+from authlib.jose.rfc7517.jwk import JsonWebKey
+
+
+class Auth0JWTBearerTokenValidator(JWTBearerTokenValidator):
+    def __init__(self, domain, audience):
+        issuer = f"https://{domain}/"
+        jsonurl = urlopen(f"{issuer}.well-known/jwks.json")
+        public_key = JsonWebKey.import_key_set(json.loads(jsonurl.read()))
+        super(Auth0JWTBearerTokenValidator, self).__init__(public_key)
+        self.claims_options = {
+            "exp": {"essential": True},
+            "aud": {"essential": True, "value": audience},
+            "iss": {"essential": True, "value": issuer},
+        }

policyengine_household_api/constants.py

@@ -0,0 +1,44 @@
+import tomllib
+from pathlib import Path
+from importlib.metadata import PackageNotFoundError, version
+
+REPO = Path(__file__).parents[1]
+GET = "GET"
+POST = "POST"
+UPDATE = "UPDATE"
+LIST = "LIST"
+COUNTRIES = ("uk", "us", "ca", "ng", "il")
+COUNTRY_PACKAGE_NAMES = (
+    "policyengine_uk",
+    "policyengine_us",
+    "policyengine_canada",
+    "policyengine_ng",
+    "policyengine_il",
+)
+
+
+def get_package_version(package_name: str) -> str:
+    try:
+        return version(package_name)
+    except PackageNotFoundError:
+        return "0.0.0"
+
+
+def get_repo_version() -> str:
+    pyproject = REPO / "pyproject.toml"
+    try:
+        project = tomllib.loads(pyproject.read_text())["project"]
+        return project["version"]
+    except (FileNotFoundError, KeyError, tomllib.TOMLDecodeError):
+        try:
+            return version("policyengine-household-api")
+        except PackageNotFoundError:
+            return "0.0.0"
+
+
+VERSION = get_repo_version()
+COUNTRY_PACKAGE_VERSIONS = {
+    country: get_package_version(package_name)
+    for country, package_name in zip(COUNTRIES, COUNTRY_PACKAGE_NAMES)
+}
+__version__ = VERSION