[![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url]
Logo

Open Notebook

An open source, privacy-focused alternative to Google's Notebook LM!
Checkout our website Β»

Setup Β· Usage Β· Transformations Β· Podcasts

Table of Contents
  1. About The Project
  2. Setting Up
  3. Usage
  4. Features
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments
## About The Project ![New Notebook](docs/assets/asset_list.png) An open source, privacy-focused alternative to Google's Notebook LM. Why give Google more of our data when we can take control of our own research workflows? In a world dominated by Artificial Intelligence, having the ability to think 🧠 and acquire new knowledge πŸ’‘, is a skill that should not be a privilege for a few, nor restricted to a single provider. Open Notebook empowers you to manage your research, generate AI-assisted notes, and interact with your contentβ€”on your terms. Learn more about our project at [https://www.open-notebook.ai](https://www.open-notebook.ai)

(back to top)

### Built With [![Python][Python]][Python-url] [![SurrealDB][SurrealDB]][SurrealDB-url] [![LangChain][LangChain]][LangChain-url] [![Streamlit][Streamlit]][Streamlit-url]

(back to top)

## βš™οΈ Setting Up Go to the [Setup Guide](docs/SETUP.md) to learn how to set up the tool in details. To setup with Docker/Portainer: ```yaml version: '3' services: surrealdb: image: surrealdb/surrealdb:v2 ports: - "8000:8000" volumes: - surreal_data:/mydata command: start --log trace --user root --pass root rocksdb:/mydata/mydatabase.db pull_policy: always user: root open_notebook: image: lfnovo/open_notebook:latest ports: - "8080:8502" env_file: - ./docker.env depends_on: - surrealdb pull_policy: always volumes: surreal_data: ``` Take a look at the [Open Notebook Boilerplate](https://github.com/lfnovo/open-notebook-boilerplate) repo with a sample of how to set it up for maximum feature usability.

(back to top)

## Usage Go to the [Usage](docs/USAGE.md) page to learn how to use all features.

(back to top)

## Features - **Multi-Notebook Support**: Organize your research across multiple notebooks effortlessly. - **Multi-model support**: Open AI, Anthropic, Gemini, Vertex AI, Open Router, Ollama. - **Podcast Generator**: Automatically convert your notes into a podcast format. - **Broad Content Integration**: Works with links, PDFs, EPUB, Office, TXT, Markdown files, YouTube videos, Audio files, Video files and pasted text. - **AI-Powered Notes**: Write notes yourself or let the AI assist you in generating insights. - **Integrated Search Engines**: Built-in full-text and vector search for faster information retrieval. - **Fine-Grained Context Management**: Choose exactly what to share with the AI to maintain control.

(back to top)

## πŸš€ New Features ### v0.0.10 - Gemini podcast model - Added the Gemini model for generating much more fluid and engaging podcasts ### v0.0.9 - Ask your Documents and Citations ❓ - Ask questions about your documents and get answers with citations ### v0.0.7 - Model Management πŸ—‚οΈ - Manage your AI models and providers in a single interface - Define default models for several tasks such as chat, transformation, embedding, etc - Enabled support for Embedding models from Gemini, Vertex and Ollama ### v0.0.6 - ePub and Office files support πŸ“„ You can now process ePub and Office files (Word, Excel, PowerPoint), extracting text and insights from them. Perfect for books, reports, presentations, and more. ### v0.0.5 - Audio and Video support πŸ“½οΈ You can now process audio and video files, extracting transcripts and insights from them. Perfect for podcasts, interviews, lectures, and more. ### v0.0.4 - Podcasts πŸŽ™οΈ You can now build amazing custom podcasts based on your own data. Customize your speakers, episode structure, cadence, voices, etc. Check out a sample using my own voice created on Eleven Labs and a interview format. [![Check out our podcast sample](https://img.youtube.com/vi/D-760MlGwaI/0.jpg)](https://www.youtube.com/watch?v=D-760MlGwaI) You can generate your podcast in dozens of languages. Head to the [Podcasts](docs/PODCASTS.md) page for more info ### v0.0.3 - Transformations ✨ We just release a much more powerful way to create more value from your sources. Transformations enable you do extract an unlimited amount of insights from your content. It's 100% customizable and you can extend it to your own needs, like Paper Analysis, Article Writing, etc. Head to the [Transformations](docs/TRANSFORMATIONS.md) page for more info ### v0.0.2 - Several new providers are supported now: - OpenAI - Anthropic - Open Router - LiteLLM - Vertex AI - Ollama ### πŸ“ Notebook Page Three intuitive columns to streamline your work: 1. **Sources**: Manage all research materials. 2. **Notes**: Create or AI-generate notes. 3. **Chat**: Chat with the AI, leveraging your content. ### βš™οΈ Context Configuration Take control of your data. Decide what gets sent to the AI with three context options: - No context - Summary only - Full content Plus, you can add your project description to help the AI provide more accurate and helpful responses. ### πŸ” Integrated Search for Your Items Locate anything across your research with ease using full-text and vector-based search. ### πŸ’¬ Powerful open prompts Jinja based prompts that are easy to customize to your own preferences.

(back to top)

## Roadmap - [ ] **Live Front-End Updates**: Real-time UI updates for a smoother experience. - [ ] **Async Processing**: Faster UI through asynchronous content processing. - [ ] **Cross-Notebook Sources and Notes**: Reuse research notes across projects. - [ ] **Bookmark Integration**: Integrate with your favorite bookmarking app. - βœ… **Multi-model support**: Open AI, Anthropic, Vertex AI, Open Router, Ollama, etc. - βœ… **Insight Generation**: New tools for creating insights - [transformations](docs/TRANSFORMATIONS.md) - βœ… **Podcast Generator**: Automatically convert your notes into a podcast format. - βœ… **Multiple Chat Sessions**: Juggle different discussions within the same notebook. - βœ… **Enhanced Citations**: Improved layout and finer control for citations. - βœ… **Better Embeddings & Summarization**: Smarter ways to distill information. See the [open issues](https://github.com/lfnovo/open-notebook/issues) for a full list of proposed features (and known issues).

(back to top)

## Contributing We would love your contributions! Specifically, we're looking for help with: - **Front-End Development**: Improve the UI/UX by moving beyond Streamlit. - **Testing & Bug Fixes**: Help make Open Notebook more robust. - **Feature Development**: Let’s make the coolest note-taking tool together! See more at [CONTRIBUTING](CONTRIBUTING.md)

(back to top)

## License Open Notebook is MIT licensed. See the [LICENSE](LICENSE) file for details.

(back to top)

## Contact Luis Novo - [@lfnovo](https://twitter.com/lfnovo)

(back to top)

## Acknowledgments This project uses some amazing third-party libraries * [Podcastfy](https://github.com/souzatharsis/podcastfy) - Licensed under the Apache License 2.0

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/lfnovo/open-notebook.svg?style=for-the-badge [contributors-url]: https://github.com/lfnovo/open-notebook/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/lfnovo/open-notebook.svg?style=for-the-badge [forks-url]: https://github.com/lfnovo/open-notebook/network/members [stars-shield]: https://img.shields.io/github/stars/lfnovo/open-notebook.svg?style=for-the-badge [stars-url]: https://github.com/lfnovo/open-notebook/stargazers [issues-shield]: https://img.shields.io/github/issues/lfnovo/open-notebook.svg?style=for-the-badge [issues-url]: https://github.com/lfnovo/open-notebook/issues [license-shield]: https://img.shields.io/github/license/lfnovo/open-notebook.svg?style=for-the-badge [license-url]: https://github.com/lfnovo/open-notebook/blob/master/LICENSE.txt [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://linkedin.com/in/lfnovo [product-screenshot]: images/screenshot.png [Streamlit]: https://img.shields.io/badge/Streamlit-FF4B4B?style=for-the-badge&logo=streamlit&logoColor=white [Streamlit-url]: https://streamlit.io/ [Python]: https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white [Python-url]: https://www.python.org/ [LangChain]: https://img.shields.io/badge/LangChain-3A3A3A?style=for-the-badge&logo=chainlink&logoColor=white [LangChain-url]: https://www.langchain.com/ [SurrealDB]: https://img.shields.io/badge/SurrealDB-FF5E00?style=for-the-badge&logo=databricks&logoColor=white [SurrealDB-url]: https://surrealdb.com/