https://github.com/difizen/libro

Libro: A Notebook Product Solution with Flexible Customization and Easy Integration.
https://github.com/difizen/libro

jupyter jupyter-notebook libro notebook python

Last synced: 1 day ago
JSON representation

Libro: A Notebook Product Solution with Flexible Customization and Easy Integration.

• Host: GitHub
• URL: https://github.com/difizen/libro
• Owner: difizen
• License: mit
• Created: 2023-09-14T07:40:42.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-29T18:18:46.000Z (about 2 months ago)
• Last Synced: 2024-10-29T20:25:33.438Z (about 2 months ago)
• Topics: jupyter, jupyter-notebook, libro, notebook, python
• Language: TypeScript
• Homepage: https://libro.difizen.net
• Size: 43.8 MB
• Stars: 219
• Watchers: 3
• Forks: 9
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Language: English | [简体中文](./README_zh.md)



A Notebook Product Solution with Flexible Customization and Easy Integration


















## Features

- 🚀 Provides comprehensive Notebook functionality with a rich set of auxiliary tools, allowing for quick adoption based on existing setups.

- 🌱 Supports kernel-level extensibility, enabling customization and further development at all layers.

- 🔮 Defines workflows for large models, with built-in capabilities for model interaction and AI-powered assistance.

![image](https://raw.githubusercontent.com/wiki/difizen/libro/assets/libro_homepage.png)

---

## Table of Contents

- [Quick Start](#quick-start)

  - [Install](#install)

  - [Run](#run)

- [New Features](#new-features)

  - [AI Capability](#ai-capability)

  - [Prompt Cell](#prompt-cell)

  - [Sql Cell](#sql-cell)

- [Technical Architecture](#technical-architecture)

- [Future Plans](#future-plans)

- [More](#more)

  - [Reporting Issues](#reporting-issues)

  - [Contributing](#contributing)

  - [Contributors](#contributors)

  - [Contact Us](#contact-us)

---

## Quick Start

### Install

```bash

pip install libro

```

> [!NOTE]

> The Python version used is 3.10-3.12. Higher versions of Python may encounter issues with unsupported dependencies.

### Run

Enter command `libro` in the terminal to start the web server, then the browser will automatically launch Libro.

```bash

libro

```

![image](https://raw.githubusercontent.com/wiki/difizen/libro/assets/libro_launch.png)

For more details, please refer to [quick start](./apps/docs/docs/quickstart/index.md)。

## New Features

### AI Capability

  

    

      

        

      

      
AI Comletion

    

    

      

        

      

      
Error Fixing

    

    

      

        

      

      
AI Chat

    

    

      

        

      

      
Code Explanation

    

    

      

        

      

      
Code Optimization

    

  


Click to enlarge

### Prompt Cell

- Enhances the ability to interact directly with large models, supporting text conversations, multimodal expressions, and more.

- Improves interaction capabilities for common output types, such as providing options to copy or run code when outputting it.

- Built-in OpenAI models are available, and you can also extend models in the following ways:

  - Define variables for LLMs, agents, and other dialogue objects based on Langchain, which can be directly used in Prompt Cells.

  - Extend your own models based on libro-ai.

For more details, please refer to [prompt cell manual](./apps/docs/docs/manual/prompt-cell.md)。



  



Click to enlarge

### Sql Cell

- Supports interaction capabilities for executing SQL commands.

- Connect to SQL databases to write SQL code directly in the notebook.

For more details, please refer to [sql cell manual](./apps/docs/docs/manual/sql-cell.md)。



  



Click to enlarge

## Technical Architecture

![image](https://raw.githubusercontent.com/wiki/difizen/libro/assets/technical_architecture.png)

## Future Plans

- AI Capability Integration

- Support for Prompt Notebook

- Execution of libro in the Browser

## More

### Reporting Issues

😊 We recommend submitting your questions through [github issue](https://github.com/difizen/libro/issues), and we typically respond within two days.

### Contributing

🤝 Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md)

### Contributors

💪 Thanks to all contributors



  



### Contact Us

💬 [Chat with us on Discord](https://discord.gg/GEx6pa3GaG)

🤗 [Join our DingTalk Q&A group](https://qr.dingtalk.com/action/joingroup?code=v1,k1,52f1gKWwsZBMrWjXHcQFlOJEQIbbrMO86Iulu3T3ePY=&_dt_no_comment=1&origin=11)

✏️ [Start a GitHub Discussion](https://github.com/difizen/libro/discussions)

🐦 [Follow us on Twitter](https://x.com/libro_project)

📧 [Subscribe to our Medium](https://medium.com/@libro.development)