Metadata-Version: 2.4
Name: notewise
Version: 1.4.0
Summary: Convert YouTube videos into AI-powered study notes with chapter support
Project-URL: Homepage, https://github.com/whoisjayd/notewise
Project-URL: Repository, https://github.com/whoisjayd/notewise
Project-URL: Issues, https://github.com/whoisjayd/notewise/issues
Project-URL: Documentation, https://github.com/whoisjayd/notewise
Author-email: whoisjayd <contactjaydeepsolanki@gmail.com>
License: MIT License with Attribution Requirement
        
        Copyright (c) 2026 whoisjayd (https://github.com/whoisjayd)
        Repository: https://github.com/whoisjayd/notewise
        
        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:
        
        1.  ATTRIBUTION REQUIREMENT — If you use, distribute, embed, or build upon
            this Software (or any substantial portion of it) in a project, product,
            service, publication, or derivative work, you MUST:
        
            a) Retain this copyright notice and license in all copies or substantial
            portions of the Software.
        
            b) Provide clear, visible credit to the original project in your
            documentation, README, about page, or wherever attribution is
            customarily given. The credit must include: - The project name: NoteWise - The author: whoisjayd - A direct link to: https://github.com/whoisjayd/notewise
        
            Example attribution (adapt the format to your context):
        
                 "Powered by NoteWise (https://github.com/whoisjayd/notewise)
                  by whoisjayd, used under the MIT License with Attribution."
        
            c) Not misrepresent the origin of the Software or claim authorship
            of the original work.
        
        2.  The above copyright notice, this permission notice, and the attribution
            requirement 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.
        
        ───────────────────────────────────────────────────────────────────────────────
        
        SUMMARY (not a substitute for the full license above):
        
        ✅ Free to use personally, commercially, and in open-source projects
        ✅ Free to modify and distribute
        ✅ Free to sublicense
        ✅ Free for private/internal, non-distributed use
        ❗ Must credit NoteWise + link to repo when distributing or publishing
        ❗ Must include this license in copies or substantial portions
        ❌ Cannot claim original authorship
        ❌ No warranty provided
        
        ───────────────────────────────────────────────────────────────────────────────
License-File: LICENSE
Keywords: ai,education,llm,notes,study,transcript,youtube
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
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: Topic :: Education
Classifier: Topic :: Multimedia :: Video
Requires-Python: >=3.10
Requires-Dist: aiolimiter>=1.2.1
Requires-Dist: fpdf2>=2.8.7
Requires-Dist: html2docx>=1.6.0
Requires-Dist: litellm==1.83.13
Requires-Dist: markdown>=3.10.2
Requires-Dist: pydantic-settings>=2.6.0
Requires-Dist: pydantic>=2.9.0
Requires-Dist: python-docx>=1.2.0
Requires-Dist: rich>=13.9.4
Requires-Dist: sqlalchemy>=2.0.0
Requires-Dist: structlog>=24.4.0
Requires-Dist: typer>=0.21.1
Description-Content-Type: text/markdown

<div align="center">

# 🎓 NoteWise

**Convert YouTube videos and playlists into local study notes from your terminal.**

<br />

<img src="https://img.shields.io/pypi/v/notewise?style=flat-square&label=version" alt="version" /> <img src="https://img.shields.io/badge/status-beta-f59e0b?style=flat-square" alt="status" /> <img src="https://img.shields.io/badge/license-MIT--Attribution-10b981?style=flat-square" alt="license" /> <img src="https://img.shields.io/badge/python-3.10%20|%203.11%20|%203.12%20|%203.13-3776AB?style=flat-square&logo=python&logoColor=white" alt="python versions" /> <img src="https://img.shields.io/github/actions/workflow/status/whoisjayd/notewise/ci-main.yml?branch=main&style=flat-square&label=CI&logo=github" alt="CI" /> <img src="https://img.shields.io/badge/LiteLLM-powered-ff6b35?style=flat-square" alt="litellm" />

<br /><br />

[Website](https://notewise.click) · [Docs](https://docs.notewise.click) · [Install](https://notewise.click/install) · [Quickstart](https://docs.notewise.click/docs/start/quickstart) · [Contributing](CONTRIBUTING.md)

</div>

## 💡 Why NoteWise?

YouTube has become one of the richest learning platforms on the planet — university lectures, conference talks, technical deep-dives, language lessons, and entire courses are all freely available. But video is a passive medium. You watch, you nod, and two days later the details are gone.

**NoteWise was built to fix that gap.**

The idea is simple: your time watching a video is valuable. The notes that _should_ come from it — the structured, searchable, reviewable kind — should not require an extra hour of your day. NoteWise automates that step. Point it at a YouTube URL and walk away with local Markdown study notes that are deeper and more useful than most people would write by hand.

**Where it shines:**

- 📚 **Students** catching up on lecture recordings or supplementing textbooks with YouTube explanations
- 🧑‍💻 **Developers** staying on top of conference talks, tutorials, and technical deep-dives without watching at 3x speed
- 🌍 **Language learners** extracting structured notes from native-language content
- 📋 **Researchers** quickly distilling hours of talks into organized, searchable reference material
- 🏢 **Teams** turning internal video presentations into shareable written documentation

The output is not just a transcript summary. It is structured, hierarchical Markdown with headers, sub-topics, definitions, examples, and concepts explained in depth. Chapter-aware videos can be split into per-chapter files, and long courses can be processed into organized local notes. Everything lands in your filesystem: portable, searchable, and permanently yours.

## Quick start

```bash
uv tool install notewise
notewise setup
notewise process "https://youtu.be/VIDEO_ID"
```

Generated notes land in `./output` by default.

Prefer another install method?

```bash
# Try without installing
uvx notewise --help

# Standalone binary installer
curl -fsSL https://notewise.click/install | sh
```

Windows PowerShell:

```powershell
irm https://notewise.click/install | iex
```

See the full [installation guide](https://docs.notewise.click/docs/start/install) for `uv`, `uvx`, `pipx`, `pip`, Docker, and standalone binaries.

## Demo

<p align="center">
  <img src="demo/notewise.gif" alt="NoteWise CLI demo" />
</p>

<p align="center">
  <sub>Watch the full demo: <a href="demo/notewise.mp4">demo/notewise.mp4</a></sub>
</p>

## Documentation

| Need                         | Go here                                                                       |
| ---------------------------- | ----------------------------------------------------------------------------- |
| Install choices              | [Install NoteWise](https://docs.notewise.click/docs/start/install)            |
| First successful run         | [Quickstart](https://docs.notewise.click/docs/start/quickstart)               |
| Processing flags and formats | [Process videos](https://docs.notewise.click/docs/use/process)                |
| Provider/model setup         | [Providers](https://docs.notewise.click/docs/config/providers)                |
| OAuth providers              | [OAuth](https://docs.notewise.click/docs/config/oauth)                        |
| Playlists and batches        | [Playlists & batches](https://docs.notewise.click/docs/use/playlists-batches) |
| Troubleshooting              | [Troubleshooting](https://docs.notewise.click/docs/operate/troubleshooting)   |
| CLI command reference        | [Commands](https://docs.notewise.click/docs/operate/commands)                 |

## Common commands

```bash
notewise process "https://youtu.be/VIDEO_ID" --format md,docx --quiz
notewise process "https://youtube.com/playlist?list=PLAYLIST_ID"
notewise doctor
notewise update
```

`notewise update` checks the latest release and prints the right upgrade command group for standalone binary or Python package installs. Run `notewise --help` or open the [command reference](https://docs.notewise.click/docs/operate/commands) for the full CLI surface.

## Development

```bash
git clone https://github.com/whoisjayd/notewise
cd notewise
uv sync --dev
make test
```

Website work uses Bun from `website/`:

```bash
bun install --frozen-lockfile
bun run lint
bunx tsc --noEmit
bun run build
```

Docs live in `docs/`. Do not run Prettier on Mintlify MDX; validate docs config with:

```bash
python -m json.tool docs/docs.json
node --check docs/umami.js
```

Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a PR.

## License

[MIT with Attribution](LICENSE). If you use NoteWise in a project or build on top of it, include credit and a link back to this repository.

## Thanks

NoteWise is built on a great open-source ecosystem. See [GRATITUDE.md](GRATITUDE.md) for acknowledgements.

Found a bug? [Open an issue](https://github.com/whoisjayd/notewise/issues/new/choose). Security concern? See [SECURITY.md](SECURITY.md).
