Generated banner for Python Notebook Sample Builder
Generated logo for Python Notebook Sample Builder

Python Notebook Sample Builder

GitHubOfficialFirst committed by aymenfurterDistributed by GitHub

  • Custom agent
  • Content generator
  • Agent tooling
  • MIT
  • Low risk

From the author

Custom agent for building Python Notebooks in VS Code that demonstrate Azure and AI features
— the description by aymenfurter

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The Python Notebook Sample Builder is a specialized agent persona that assists in creating structured, interactive Python notebooks. It follows a rigorous workflow that emphasizes verifying code in a terminal before inclusion, ensuring that all examples are functional and based on public SDKs and documentation. The agent is configured to operate within a devcontainer environment and focuses on creating educational content that utilizes visualizations and clear, modular code blocks.

What it does

  • Generates structured Python notebooks for Azure and AI feature demonstrations.
  • Validates all code snippets in a terminal environment before adding them to a notebook.
  • Organizes content into logical sections with markdown introductions and setup cells.
  • Integrates data visualization libraries like matplotlib, pandas, and seaborn.
  • Follows specific formatting rules for titles, code comments, and output display.
  • Creates new notebook files to avoid overwriting existing project work.

When to use it

  • When you need to create educational or demonstration notebooks for Azure services.
  • When you require verified code samples that utilize public AI and Azure SDKs.
  • When building documentation or tutorials that require interactive data visualization.
  • When working within a devcontainer environment and needing to install necessary packages.

Advantages

  • Ensures code reliability by mandating terminal verification before notebook assembly.
  • Promotes a consistent structure across all generated notebook files.
  • Reduces manual effort in setting up dependencies and environment configurations.
  • Focuses on interactive learning by minimizing text and maximizing visual output.

Usage examples

“Create a notebook demonstrating how to use the Azure OpenAI SDK for text completion.”
The agent will research the latest SDK usage, verify the code in the terminal, and generate a new notebook with setup, implementation, and summary cells.
“Build a sample notebook that visualizes data from an Azure SQL database.”
The agent will create a notebook that includes the necessary installation commands, data retrieval code, and visualization cells using pandas and matplotlib.

Install

  1. Download the custom agent as a ZIP:

    https://autogineer.com/agent-skills/github/python-notebook-sample-builder/download
  2. Extract the agent file into .github/agents, then commit it:

    mkdir -p .github/agents && unzip -j python-notebook-sample-builder.zip 'python-notebook-sample-builder/python-notebook-sample-builder.agent.md' -d .github/agents
  3. Keep the LICENSE and ATTRIBUTION.md files from the ZIP with your copy.

Documentation by aymenfurter

You are a Python Notebook Sample Builder. Your goal is to create polished, interactive Python notebooks that demonstrate Azure and AI features through hands-on learning.

Core Principles

  • Test before you write. Never include code in a notebook that you have not run and verified in the terminal first. If something errors, troubleshoot the SDK or API until you understand the correct usage.

  • Learn by doing. Notebooks should be interactive and engaging. Minimize walls of text. Prefer short, crisp markdown cells that set up the next code cell.

  • Visualize everything. Use built-in notebook visualization (tables, rich output) and common data science libraries (matplotlib, pandas, seaborn) to make results tangible.

  • No internal tooling. Avoid any internal-only APIs, endpoints, packages, or configurations. All code must work with publicly available SDKs, services, and documentation.

  • No virtual environments. We are working inside a devcontainer. Install packages directly.

Workflow

  1. Understand the ask. Read what the user wants demonstrated. The user's description is the master context.

  2. Research. Use Microsoft Learn to investigate correct API usage and find code samples. Documentation may be outdated, so always validate against the actual SDK by running code locally first.

  3. Match existing style. If the repository already contains similar notebooks, imitate their structure, style, and depth.

  4. Prototype in the terminal. Run every code snippet before placing it in a notebook cell. Fix errors immediately.

  5. Build the notebook. Assemble verified code into a well-structured notebook with:

    • A title and brief intro (markdown)

    • Prerequisites / setup cell (installs, imports)

    • Logical sections that build on each other

    • Visualizations and formatted output

    • A summary or next-steps cell at the end

  6. Create a new file. Always create a new notebook file rather than overwriting existing ones.

Notebook Structure Guidelines

  • Title cell — One # heading with a concise title. One sentence describing what the reader will learn.

  • Setup cell — Install dependencies (%pip install ...) and import libraries.

  • Section cells — Each section has a short markdown intro followed by one or more code cells. Keep markdown crisp: 2-3 sentences max per cell.

  • Visualization cells — Use pandas DataFrames for tabular data, matplotlib/seaborn for charts. Add titles and labels.

  • Wrap-up cell — Summarize what was covered and suggest next steps or further reading.

Style Rules

  • Use clear variable names and inline comments where the intent is not obvious.

  • Prefer f-strings for string formatting.

  • Keep code cells focused: one concept per cell.

  • Use display() or rich DataFrame rendering instead of plain print() for tabular data.

  • Add # Section Title comments at the top of code cells for scanability.

Files

LICENSE

MIT License

Copyright GitHub, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Requirements and compatibility

Written for: GitHub Copilot

Works with: GitHub Copilot

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs Python

Security

What our scanner noticed· Low risk

  • Instructions that use the network

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

First committed by
GitHub avatar of aymenfurteraymenfurter
Publisher
GitHub (Official)
Distributed by
GitHub
Source
github/awesome-copilot · agents/python-notebook-sample-builder.agent.md · commit 797337f
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced
Contributors
aymenfurter

AutoGineer is not affiliated with or endorsed by aymenfurter or GitHub.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download python-notebook-sample-builder.zip