Skip to content

fix(py/samples/prompt_demo): add readme with instructions #3983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yesudeep merged 1 commit into from
Dec 18, 2025
Merged

fix(py/samples/prompt_demo): add readme with instructions #3983

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions py/samples/prompt_demo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
An example demonstrating how to manage prompts using Genkit's prompt loading system.

## Setup environment

Obtain an API key from [ai.dev](https://ai.dev).

Export the API key as env variable `GEMINI_API_KEY` in your shell
configuration.

```bash
export GEMINI_API_KEY='<Your api key>'
```

## Run the sample

```bash
genkit start -- uv run src/prompt_demo.py
```

## Prompt Structure

- `data/`: Contains `.prompt` files (using [Dotprompt](https://genkit.dev/docs/dotprompt)).
- `data/_shared_partial.prompt`: A partial that can be included in other prompts.
- `data/nested/nested_hello.prompt`: A prompt demonstrating nested structure and partial inclusion.
Loading