pixie-prompts 0.1.7__tar.gz → 0.1.8.dev6__tar.gz

pixie_prompts-0.1.8.dev6/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: pixie-prompts
+Version: 0.1.8.dev6
+Summary: Code-first, type-safe prompt management
+License: MIT
+License-File: LICENSE
+Author: Yiou Li
+Author-email: yol@gopixie.ai
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Provides-Extra: server
+Requires-Dist: brotli (>=1.2.0,<2.0.0) ; extra == "server"
+Requires-Dist: colorlog (>=6.10.1) ; extra == "server"
+Requires-Dist: dotenv (>=0.9.9) ; extra == "server"
+Requires-Dist: fastapi (>=0.128.0) ; extra == "server"
+Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
+Requires-Dist: jsonsubschema (>=0.0.7,<0.0.8)
+Requires-Dist: openai[server] (>=2.15.0,<3.0.0) ; extra == "server"
+Requires-Dist: pydantic (>=2.12.5,<3.0.0)
+Requires-Dist: pydantic-ai-slim (>=1.39.0) ; extra == "server"
+Requires-Dist: strawberry-graphql (>=0.288.1) ; extra == "server"
+Requires-Dist: uvicorn (>=0.40.0) ; extra == "server"
+Requires-Dist: watchdog (>=6.0.0) ; extra == "server"
+Requires-Dist: watchfiles[server] (>=1.1.1,<2.0.0) ; extra == "server"
+Project-URL: Changelog, https://github.com/yiouli/pixie-prompts/commits/main/
+Project-URL: Documentation, https://yiouli.github.io/pixie-prompts/
+Project-URL: Homepage, https://gopixie.ai
+Project-URL: Issues, https://github.com/yiouli/pixie-prompts/issues
+Project-URL: Repository, https://github.com/yiouli/pixie-prompts
+Description-Content-Type: text/markdown
+
+# pixie-prompts
+**Code-first, type-checked prompt management.**
+Manage prompt locally in your codebase, with Jinja rendering, variable type-hint and validations.
+
+[**Demo**](https://github.com/user-attachments/assets/aba55aca-1ad3-4f25-97f9-db0f8e67dbe6)
+
+[**Try it live**](https://gopixie.ai/?url=https%3A%2F%2Fpixie-prompts-examples.vercel.app%2Fgraphql)
+
+## Setup
+
+
+
+
+In your project folder, install **pixie-prompts[server]** Python package:
+```bash
+pip install pixie-prompts[server]
+```
+> Note: you can install **pixie-prompts** without the server extras for your production build.
+
+Start the local dev server and open the web UI by running:
+```bash
+pp
+```
+> Note: The web-browser would automatically open [http://localhost:8000](http://localhost:8000). You can also access the web UI at [gopixie.ai](https://gopixie.ai).
+
+To test prompts, create *.env* file with LLM API key(s):
+```ini
+# .env
+OPENAI_API_KEY=...
+GEMINI_API_KEY=...
+```
+
+## Register Prompt
+
+In your code, create a new prompt using `create_prompt`:
+```python
+# prompts.py
+from pixie.prompts import create_prompt
+
+simple_prompt = create_prompt('simple_prompt')
+```
+
+Your prompt would automatically appear in the web UI after your code is saved.
+
+
+## Manage Prompt
+
+You can create new version(s) of a prompt in the web UI.
+
+Once saved from web UI, it will be assigned a new version id, and the content would be saved in your codebase at */.pixie/prompts/<prompt_name>/<version_id>.jinja*.
+
+> Note: it's recommended to only edit your prompts via the web UI to get type-hint and validation.
+
+
+## Define Variables
+
+For prompt that has variable(s) in it, define a class extending `pixie.prompts.Variables` (which extends `pydantic.BaseModel`. Then use the class type when registering your prompt.
+
+```python
+# prompts.py
+from pixie.prompts import Variables, create_prompt
+
+class Person(Variables):
+    name: str
+    age: int
+
+# Create a prompt with variables
+typed_prompt = create_prompt('typed_prompt', Person)
+```
+
+Other than using dict, you can define your variable class in anyway that's permissible in Pydantic. I.e. you can define your field as basic types such as `str`, `int`, `bool`, you can have a `list` of permissible items, you can use `Union` type, and you can have nested `Variable` field.
+
+The web UI will parse your variable definitions and use it to decide input fields, type-hints and validations.
+
+
+## Use Prompt
+
+Compile your prompt into string with the `compile` function on the prompt object. Pass in the Variables object (if defined) for your prompt as argument.
+```python
+# demo.py
+
+from pixie.prompts import Variables, create_prompt
+
+simple_prompt = create_prompt('simple_prompt')
+
+class Person(Variables):
+    name: str
+    age: int
+
+# Create a prompt with variables
+typed_prompt = create_prompt('typed_prompt', Person)
+
+simple_prompt_str = simple_prompt.compile()
+typed_prompt_str = typed_prompt.compile(Person(name="Jane", age=30))
+
+```
+
+
+
+Check out more [examples](https://github.com/yiouli/pixie-prompts-examples/blob/main/examples/prompts.py).
+

pixie_prompts-0.1.8.dev6/README.md

@@ -0,0 +1,100 @@
+# pixie-prompts
+**Code-first, type-checked prompt management.**
+Manage prompt locally in your codebase, with Jinja rendering, variable type-hint and validations.
+
+[**Demo**](https://github.com/user-attachments/assets/aba55aca-1ad3-4f25-97f9-db0f8e67dbe6)
+
+[**Try it live**](https://gopixie.ai/?url=https%3A%2F%2Fpixie-prompts-examples.vercel.app%2Fgraphql)
+
+## Setup
+
+
+
+
+In your project folder, install **pixie-prompts[server]** Python package:
+```bash
+pip install pixie-prompts[server]
+```
+> Note: you can install **pixie-prompts** without the server extras for your production build.
+
+Start the local dev server and open the web UI by running:
+```bash
+pp
+```
+> Note: The web-browser would automatically open [http://localhost:8000](http://localhost:8000). You can also access the web UI at [gopixie.ai](https://gopixie.ai).
+
+To test prompts, create *.env* file with LLM API key(s):
+```ini
+# .env
+OPENAI_API_KEY=...
+GEMINI_API_KEY=...
+```
+
+## Register Prompt
+
+In your code, create a new prompt using `create_prompt`:
+```python
+# prompts.py
+from pixie.prompts import create_prompt
+
+simple_prompt = create_prompt('simple_prompt')
+```
+
+Your prompt would automatically appear in the web UI after your code is saved.
+
+
+## Manage Prompt
+
+You can create new version(s) of a prompt in the web UI.
+
+Once saved from web UI, it will be assigned a new version id, and the content would be saved in your codebase at */.pixie/prompts/<prompt_name>/<version_id>.jinja*.
+
+> Note: it's recommended to only edit your prompts via the web UI to get type-hint and validation.
+
+
+## Define Variables
+
+For prompt that has variable(s) in it, define a class extending `pixie.prompts.Variables` (which extends `pydantic.BaseModel`. Then use the class type when registering your prompt.
+
+```python
+# prompts.py
+from pixie.prompts import Variables, create_prompt
+
+class Person(Variables):
+    name: str
+    age: int
+
+# Create a prompt with variables
+typed_prompt = create_prompt('typed_prompt', Person)
+```
+
+Other than using dict, you can define your variable class in anyway that's permissible in Pydantic. I.e. you can define your field as basic types such as `str`, `int`, `bool`, you can have a `list` of permissible items, you can use `Union` type, and you can have nested `Variable` field.
+
+The web UI will parse your variable definitions and use it to decide input fields, type-hints and validations.
+
+
+## Use Prompt
+
+Compile your prompt into string with the `compile` function on the prompt object. Pass in the Variables object (if defined) for your prompt as argument.
+```python
+# demo.py
+
+from pixie.prompts import Variables, create_prompt
+
+simple_prompt = create_prompt('simple_prompt')
+
+class Person(Variables):
+    name: str
+    age: int
+
+# Create a prompt with variables
+typed_prompt = create_prompt('typed_prompt', Person)
+
+simple_prompt_str = simple_prompt.compile()
+typed_prompt_str = typed_prompt.compile(Person(name="Jane", age=30))
+
+```
+
+
+
+Check out more [examples](https://github.com/yiouli/pixie-prompts-examples/blob/main/examples/prompts.py).

{pixie_prompts-0.1.7 → pixie_prompts-0.1.8.dev6}/pixie/prompts/graphql.py

@@ -3,6 +3,7 @@
 from datetime import datetime
 import json
 import logging
+import os
 from typing import Any, Optional, cast, get_args
 
 from graphql import GraphQLError
@@ -94,6 +95,11 @@ class LlmCallResult:
     reasoning: str | None
 
 
+def is_demo_mode() -> bool:
+    is_demo_mode = os.getenv("IS_DEMO_MODE", "0") in ("1", "true", "True")
+    return is_demo_mode
+
+
 @strawberry.type
 class Query:
     """GraphQL queries."""
@@ -219,6 +225,8 @@ class Mutation:
             GraphQLError: If the LLM call fails.
         """
         try:
+            if is_demo_mode():
+                model = "openai:gpt-4o-mini"
             template = jinja2.Template(prompt_template)
             prompt = template.render(**(cast(dict[str, Any], variables) or {}))
             print(prompt)
@@ -243,7 +251,6 @@ class Mutation:
                     elif part.part_kind == "system-prompt":
                         part.content = part.content.replace(prompt_placeholder, prompt)
 
-            print(pydantic_messages)
             # Replace the placeholder in input messages
             response = await model_request(
                 model=model,
@@ -309,6 +316,8 @@ class Mutation:
         Returns:
             The updated BasePrompt object.
         """
+        if is_demo_mode():
+            raise GraphQLError("Modifications are not allowed in demo mode.")
         prompt_with_registration = get_prompt((str(prompt_id)))
         if prompt_with_registration is None:
             raise GraphQLError(f"Prompt with id '{prompt_id}' not found.")
@@ -338,6 +347,8 @@ class Mutation:
         Returns:
             True if the update was successful.
         """
+        if is_demo_mode():
+            raise GraphQLError("Modifications are not allowed in demo mode.")
         prompt_with_registration = get_prompt((str(prompt_id)))
         if prompt_with_registration is None:
             raise GraphQLError(f"Prompt with id '{prompt_id}' not found.")

{pixie_prompts-0.1.7 → pixie_prompts-0.1.8.dev6}/pyproject.toml

@@ -4,7 +4,7 @@ packages = [
     { include = "pixie" },
 ]
 
-version = "0.1.7"
+version = "0.1.8.dev6"
 description = "Code-first, type-safe prompt management"
 authors = ["Yiou Li <yol@gopixie.ai>"]
 license = "MIT"

pixie_prompts-0.1.7/PKG-INFO

@@ -1,40 +0,0 @@
-Metadata-Version: 2.4
-Name: pixie-prompts
-Version: 0.1.7
-Summary: Code-first, type-safe prompt management
-License: MIT
-License-File: LICENSE
-Author: Yiou Li
-Author-email: yol@gopixie.ai
-Requires-Python: >=3.10,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Provides-Extra: server
-Requires-Dist: brotli (>=1.2.0,<2.0.0) ; extra == "server"
-Requires-Dist: colorlog (>=6.10.1) ; extra == "server"
-Requires-Dist: dotenv (>=0.9.9) ; extra == "server"
-Requires-Dist: fastapi (>=0.128.0) ; extra == "server"
-Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
-Requires-Dist: jsonsubschema (>=0.0.7,<0.0.8)
-Requires-Dist: openai[server] (>=2.15.0,<3.0.0) ; extra == "server"
-Requires-Dist: pydantic (>=2.12.5,<3.0.0)
-Requires-Dist: pydantic-ai-slim (>=1.39.0) ; extra == "server"
-Requires-Dist: strawberry-graphql (>=0.288.1) ; extra == "server"
-Requires-Dist: uvicorn (>=0.40.0) ; extra == "server"
-Requires-Dist: watchdog (>=6.0.0) ; extra == "server"
-Requires-Dist: watchfiles[server] (>=1.1.1,<2.0.0) ; extra == "server"
-Project-URL: Changelog, https://github.com/yiouli/pixie-prompts/commits/main/
-Project-URL: Documentation, https://yiouli.github.io/pixie-prompts/
-Project-URL: Homepage, https://gopixie.ai
-Project-URL: Issues, https://github.com/yiouli/pixie-prompts/issues
-Project-URL: Repository, https://github.com/yiouli/pixie-prompts
-Description-Content-Type: text/markdown
-
-# pixie-prompts
-Code-first, type-checked prompt management.
-

pixie_prompts-0.1.7/README.md

@@ -1,2 +0,0 @@
-# pixie-prompts
-Code-first, type-checked prompt management.