instructor-examples 0.2.2

Copy github examples to your local environment without needing to clone the entire repository.

Instructor Examples

Copy github examples to your local environment without needing to clone the entire repository.

• Created by Daniel Mouris
  • PyPI: https://pypi.org/user/dgmouris/
• PyPI package: https://pypi.org/project/instructor_examples/
• Free software: MIT License

Installation

Install with pip:

pip install instructor_examples

Usage

One off copying of a single example:

Specify the --repo and --out-folder flags to copy a specific folder from a GitHub repository to a local folder:

instructor_examples folder_in_repo_url --repo=https://github.com//somerepository/ --out-folder=./your_local_folder

The default of the --out-folder flag is the current working directory, so if you want to copy the folder to your current location, you can omit that flag.

Running a course with a public Repo

Get students to created a instructor_examples_settings.json file in the folder where they want the examples copied to, with the following content:

{
    "repo": "GITHUB_REPO_URL",
}

Then they can run the following command to copy the examples for each lesson:

instructor_examples example_folder_in_repo_url

Demo

Features

Copies files and folders from GitHub to a local environment.

Documentation

Documentation is built with Zensical and deployed to GitHub Pages.

• Live site: https://dgmouris.github.io/instructor_examples/
• Preview locally: just docs-serve (serves at http://localhost:8000)
• Build: just docs-build

API documentation is auto-generated from docstrings using mkdocstrings.

Docs deploy automatically on push to main via GitHub Actions. To enable this, go to your repo's Settings > Pages and set the source to GitHub Actions.

Development

To set up for local development:

# Clone your fork
git clone [e-mail]:your_username/instructor_examples.git
cd instructor_examples

# Install in editable mode with live updates
uv tool install --editable .

This installs the CLI globally but with live updates - any changes you make to the source code are immediately available when you run instructor_examples.

Run tests:

uv run pytest

Run quality checks (format, lint, type check, test):

just qa

Author

Instructor Examples was created in 2026 by Daniel Mouris.

Built with Cookiecutter and the audreyfeldroy/cookiecutter-pypackage project template.