nteract/papermill

Instructions on how to cite papermill in an academic paper.

Open

#881 opened on May 12, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5,381 stars) (402 forks)batch import
enhancementhelp wanted

Description

Addition to documentation

Instructions on how to cite papermill in an academic paper in either your README.md or documentation.

Motivation

I am writing an academic manuscript on BEAST_pype. I have used papermill extensively within that project and would like to give papermill's the authors full credit.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of academic citation conventions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Add a section to the README.md or documentation site (papermill.readthedocs.io) explaining how to cite Papermill in academic papers. Look at existing documentation for citation examples from similar projects (e.g., Jupyter, NumPy). The citation should include authors, title, year, version, and DOI. Check if the project has a CITATION.cff file or a Zenodo DOI; if not, suggest creating one. The contribution requires editing Markdown files in the repository, likely in the README or under docs/.