Расширение JupyterLab, которое позволяет добавлять произвольные функции Python в палитру команд.
nteract/papermill
Инструмент на Python для параметризации, запуска и анализа Jupyter-ноутбуков через командную строку или Python API.
- Звёзды
- 6,498
- Форки
- 465
- Открытые issues
- 198
- Последний коммит
- в прошлом месяце
Что это?
Papermill запускает Jupyter-ноутбуки с параметрами, которые вы задаёте при выполнении. Чтобы определить значения по умолчанию, пометьте ячейку тегом `parameters`: Papermill добавит новую ячейку с переданными значениями. Благодаря этому один и тот же ноутбук можно использовать с разными входными данными и получать разные результаты — например, формировать ежемесячный отчёт за разные даты.
Запускать ноутбуки можно через Python API с помощью `execute_notebook` или из командной строки командой `papermill`. Параметры можно передавать в виде строк, типизированных значений, YAML-файлов или YAML в кодировке base64. Входные и выходные пути могут указывать на локальные файлы, URL HTTP(S), AWS S3, Azure Data Lake или Blob Storage, а также Google Cloud Storage.
Благодаря возможности запускать ноутбуки из скриптов papermill подходит для встраивания в конвейеры обработки данных, где результаты одного ноутбука определяют, какой ноутбук запустить следующим. Дополнительные опции, например `s3` или `azure`, устанавливают зависимости для работы с хранилищами, а опция `black` форматирует добавленные параметры.
Ключевые возможности
- 01Добавляет параметры в ячейку с тегом, позволяя запускать один ноутбук с разными входными данными.
- 02Запускает ноутбуки через Python API или командную строку papermill.
- 03Принимает параметры в виде типизированных значений, обычных строк, YAML-файлов или YAML-строк.
- 04Читает и записывает ноутбуки на локальном диске, по HTTP(S), в S3, Azure и Google Cloud Storage.
- 05Поддерживает форматирование добавленных параметров с помощью Black (опционально).
Сценарии использования
- Запуск одного и того же финансового или аналитического отчёта с разными датами или настройками.
- Создание цепочек ноутбуков в конвейере обработки данных, где результат одного определяет следующий шаг.
- Пакетный запуск ноутбуков из облачных объектных хранилищ в рамках запланированных заданий.
Быстрый старт
- 1
Установите papermill из PyPI
pip install papermill - 2
Добавьте к ячейке ноутбука тег «parameters» и запустите его с параметром через CLI
papermill local/input.ipynb local/output.ipynb -p alpha 0.6 -p l1_ratio 0.1
Что важно знать
- Поддерживается только Python 3.10 и новее.
Темы
Частые вопросы
- Что такое papermill?
- Инструмент на Python для параметризации, запуска и анализа Jupyter-ноутбуков через командную строку или Python API. Papermill запускает Jupyter-ноутбуки с параметрами, которые вы задаёте при выполнении. Чтобы определить значения по умолчанию, пометьте ячейку тегом `parameters`: Papermill добавит новую ячейку с переданными значениями. Благодаря этому один и тот же ноутбук можно использовать с разными входными данными и получать разные результаты — например, формировать ежемесячный отчёт за разные даты.
- papermill можно использовать бесплатно? Какая у него лицензия?
- papermill распространяется с открытым исходным кодом под лицензией BSD-3-Clause. Перед использованием в коммерческих продуктах проверьте условия лицензии.
- papermill всё ещё поддерживается?
- Обновлялся за последние 6 месяцев. Последний коммит в papermill — 5 окт. 2026 г..
- Для чего можно использовать papermill?
- Запуск одного и того же финансового или аналитического отчёта с разными датами или настройками. Создание цепочек ноутбуков в конвейере обработки данных, где результат одного определяет следующий шаг. Пакетный запуск ноутбуков из облачных объектных хранилищ в рамках запланированных заданий.
- Как установить papermill?
- Установите papermill из PyPI: pip install papermill Добавьте к ячейке ноутбука тег «parameters» и запустите его с параметром через CLI: papermill local/input.ipynb local/output.ipynb -p alpha 0.6 -p l1_ratio 0.1
- Где скачать papermill?
- Исходный код и инструкции по установке — на GitHub: https://github.com/nteract/papermill
Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.
Похожие проекты
Фреймворк на базе Nix для декларативных и воспроизводимых окружений JupyterLab с настраиваемыми ядрами и расширениями.
Хранит Jupyter notebooks в виде обычных файлов Markdown или скриптов Python, Julia и R, чтобы Git показывал наглядные diff.
Собирает git-репозиторий в Docker-образ с Jupyter на основе конфигурационных файлов репозитория.
Расширение JupyterLab и Python-пакет для написания модульных тестов отдельных ячеек ноутбуков с линейным выполнением, например ноутбуков для подготовки отчётов.
Реактивный Python-ноутбук, который автоматически перезапускает зависимые ячейки, хранит ноутбуки в виде обычных файлов .py и запускается как скрипт или приложение.