Metadata-Version: 2.1
Name: biscuit-editor
Version: 2.99.15
Summary: A lightweight, fast, and extensible code editor with a growing community
License: MIT
Author: Billy
Author-email: billydevbusiness@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: GitPython (>=3.1.43,<4.0.0)
Requires-Dist: Pillow (>=10.3.0,<11.0.0)
Requires-Dist: Pygments (>=2.18.0,<3.0.0)
Requires-Dist: chardet (>=5.2.0,<6.0.0)
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: filetype (>=1.2.0,<2.0.0)
Requires-Dist: google-generativeai (>=0.7.0,<0.8.0)
Requires-Dist: hintedtext (>=0.6.0,<0.7.0)
Requires-Dist: mistune (>=3.0.2,<4.0.0)
Requires-Dist: psutil (>=5.9.8,<7.0.0)
Requires-Dist: ptyprocess (>=0.7.0,<0.8.0) ; sys_platform == "linux"
Requires-Dist: pyperclip (>=1.8.2,<2.0.0)
Requires-Dist: python-tkdnd (>=0.2.1,<0.3.0)
Requires-Dist: pywinpty (>=2.0.13,<3.0.0) ; sys_platform == "win32"
Requires-Dist: requests (>=2.32.2,<3.0.0)
Requires-Dist: sortedcontainers (>=2.4.0,<3.0.0)
Requires-Dist: sv-ttk (>=2.6.0,<3.0.0)
Requires-Dist: tarts (==0.13.3)
Requires-Dist: tkextrafont (>=0.6.3,<0.7.0) ; sys_platform == "win32"
Requires-Dist: tkinterweb (>=3.23.9,<4.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Requires-Dist: watchdog (>=4.0.1,<5.0.0)
Description-Content-Type: text/markdown

<h1 align="center">
    <img src="https://github.com/tomlin7/Biscuit/assets/70792552/0ea8e958-92de-4659-b1c9-ab5a72f05d7d" width=500><br>
    <a href=https://github.com/tomlin7/Biscuit/actions/workflows/nightly.yml> 
        <img src="https://img.shields.io/github/actions/workflow/status/tomlin7/biscuit/nightly.yml?style=for-the-badge"> 
    </a> 
    <img alt="Project License" src="https://img.shields.io/github/license/tomlin7/Biscuit?style=for-the-badge"> 
    <a href=https://github.com/tomlin7/Biscuit/releases> 
        <img alt="Download Latest" src="https://img.shields.io/github/v/release/tomlin7/biscuit?style=for-the-badge"> 
    </a>
    <img alt="GitHub closed pull requests" src="https://img.shields.io/github/issues-pr-closed-raw/tomlin7/Biscuit?style=for-the-badge">
</h1>

A lightweight, fast, and extensible code editor with wide range of language support, runs with very minimal system requirements. It implements the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) for code completions, refactoring, symbol references, and more. Features include breakpoint-based code debugging, AI assisted workflow, fast workspace search, and built-in Git support. Scroll down to see [biscuit in action](https://github.com/tomlin7/Biscuit/tree/main?tab=readme-ov-file#features).

![image](https://github.com/tomlin7/biscuit/assets/70792552/74118e72-e7de-48dd-a34f-a5abd6664e42)

- 🎀 Explore all community made extensions and their authors at the [Biscuit Extension Center](https://tomlin7.github.io/biscuit-extensions/)
- 🪛 For contributing/user guides or API reference, check the [documentation here](https://tomlin7.github.io/biscuit)
- 🌟 Scroll down to the [features section](https://github.com/tomlin7/biscuit?tab=readme-ov-file#features) for a list of all features

## Installing

You can install the latest release from PyPI by running:

```bash
pip install biscuit-editor
```

Try running `biscuit --version` in your terminal to check if the installation was successful.

### Standalone Builds

- Grab the latest stable build from [**releases page**](https://github.com/tomlin7/Biscuit/releases)
- Unstable nightly builds from [GitHub actions](https://github.com/tomlin7/Biscuit/actions)

For compiling from source code, please check the [installation guide](https://github.com/tomlin7/Biscuit/tree/main/scripts).

## Contributing ❤️

Your contributions are valuable and very much appreciated!
Have a peek at the [contributing guide](https://github.com/tomlin7/Biscuit/blob/main/CONTRIBUTING.md) for a quick tour on project structure and to setup the environment. To contribute a new extension, check the [extension docs](https://github.com/tomlin7/biscuit-extensions).

<a href="https://github.com/tomlin7/biscuit/graphs/contributors">
  <img src="https://opencollective.com/biscuit/contributors.svg" />
</a><br>

- For opening feature requests and bug reports, use the [issue tracker](https://github.com/tomlin7/Biscuit/issues)
- Community made extensions are published at the [extensions repository](https://github.com/tomlin7/biscuit-extensions)

## Features

- **Language Server Support** for code completions, refactoring, symbol references, and more

![peek](https://github.com/tomlin7/biscuit/assets/70792552/be132f5b-776c-4045-8a62-c9d29d463762)

<table>
    <tr>
        <img src=https://github.com/tomlin7/biscuit/assets/70792552/36589a2d-8f5f-4196-bc88-5b1800492076 height=270>
    </tr>
    <tr> 
        <img src=https://github.com/tomlin7/biscuit/assets/70792552/68a26ccb-b309-4c21-b75e-3e5cf5fa6500 height=270>
    </tr>
</table>

<hr>

- **Breakpoint-based Code Debugging** with variable inspection, call stack, and more

![peek](https://github.com/tomlin7/biscuit/assets/70792552/29541b9e-e084-42bc-85b2-4d7c54cd8d34)

<hr>

- **AI Assisted Workflow** for refactoring, code generation, and more

![peek](https://github.com/tomlin7/biscuit/assets/70792552/97913c12-5493-4783-b1f0-ee904f67ff2d)

<hr>

- **Fast Workspace Search** with regex support and file preview

![peek](https://github.com/tomlin7/biscuit/assets/70792552/de0540b2-2b34-4be6-aa86-97e17a20d47d)

<hr>

- **Built-in Git Support** for version control and diff viewer

![image](https://github.com/tomlin7/biscuit/assets/70792552/ad650048-7e74-420b-bd3a-d0c059ff69cd)

## License

Biscuit is released under the MIT License; for more information, see [LICENSE](https://github.com/tomlin7/Biscuit/blob/main/LICENSE.md).

