Metadata-Version: 2.4
Name: slidenotes
Version: 0.1.0
Summary: Link every slide of a PDF or PowerPoint to the notes that explain it: many-to-many, no screenshots.
Project-URL: Homepage, https://github.com/shubham10divakar/slidenotes
Project-URL: Documentation, https://github.com/shubham10divakar/slidenotes/blob/main/GUIDE.md
Project-URL: Repository, https://github.com/shubham10divakar/slidenotes
Project-URL: Issues, https://github.com/shubham10divakar/slidenotes/issues
Project-URL: Changelog, https://github.com/shubham10divakar/slidenotes/blob/main/CHANGELOG.md
Author-email: Subham Divakar <shubham.divakar@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: cli,docx,markdown,notes,obsidian,pdf,powerpoint,slides,study
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Education
Classifier: Topic :: Office/Business
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: lxml>=4.9
Requires-Dist: pypdf>=4
Requires-Dist: pyyaml>=6
Requires-Dist: rich>=13
Requires-Dist: typer>=0.12
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: python-pptx>=0.6.21; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: ppt
Requires-Dist: python-pptx>=0.6.21; extra == 'ppt'
Description-Content-Type: text/markdown

<div align="center">

# SlideNotes

**Link every slide to the notes that explain it. No screenshots.**

[![PyPI](https://img.shields.io/pypi/v/slidenotes.svg)](https://pypi.org/project/slidenotes/)
[![Downloads](https://static.pepy.tech/badge/slidenotes)](https://pepy.tech/project/slidenotes)
[![Downloads/month](https://static.pepy.tech/badge/slidenotes/month)](https://pepy.tech/project/slidenotes)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/shubham10divakar/slidenotes/blob/main/LICENSE)
![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)

</div>

---

Your lecture notes are probably 90% pasted slide screenshots. One real set of notes weighs **10.6 MB for 2,600 words**, because of 14 screenshots, and none of those links between slide and explanation can be searched or checked.

SlideNotes replaces the screenshots with real links. Point any slide of a PDF or PowerPoint at any section of your Word, Markdown or text notes, and jump between them from your terminal.

```bash
sn add lecture1.pdf --notes lecture1.docx
sn link lecture1.pdf 4-6 "One-Hot Representation"
sn show lecture1.pdf 4
```

## Why SlideNotes

- **Many-to-many.** One slide → many sections across many files. One section → many slides.
- **Your files stay yours.** Slides are never modified. Word notes only gain invisible bookmarks.
- **Plain text all the way down.** Links live in a readable `.links.md` file next to your slides. Uninstall the tool and every link still works.
- **Links that don't rot.** Anchored to headings and bookmarks, not page numbers. `sn check` catches anything that breaks, and `sn check --fix` repairs it.
- **Use the editor you already like.** Word, VS Code, Obsidian, Notepad.

## Install

```bash
pip install slidenotes
```

Python 3.10+. Optional: [LibreOffice](https://www.libreoffice.org/) for PowerPoint decks, [pandoc](https://pandoc.org/) for `sn convert`.

## Learn more

- [Guide](https://github.com/shubham10divakar/slidenotes/blob/main/GUIDE.md): every command, option and file format
- [Design](https://github.com/shubham10divakar/slidenotes/blob/main/v1/DESIGN.md) · [Features](https://github.com/shubham10divakar/slidenotes/blob/main/v1/FEATURES.md) · [Roadmap](https://github.com/shubham10divakar/slidenotes/blob/main/v1/ROADMAP.md) · [Changelog](https://github.com/shubham10divakar/slidenotes/blob/main/CHANGELOG.md)

<div align="center">
<sub>MIT licensed · Built by Subham Divakar</sub>
</div>
