Metadata-Version: 2.1
Name: chlorophyll
Version: 0.4.2
Summary: A module that fills your code with color - syntax highlighted text box widget for Tkinter.
Home-page: https://github.com/rdbende/chlorophyll
Author: rdbende
Author-email: rdbende@gmail.com
License: MIT license
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Typing :: Typed
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

<h1 align="center">Chlorophyll</h1>

> **Note**
> This module is the successor to [`tkcode`](https://github.com/rdbende/tkcode), as it is deprecated - please do not use it any more.

## Description
Chlorophyll provides the `CodeView` widget for tkinter, which is a `Text` widget with syntax highlighting, line numbers, and works as a simple code editor. It is written in Python and uses the [`pygments`](https://pygments.org/) library for syntax highlighting and the [`TkLineNums`](https://www.github.com/Moosems/TkLineNums) module for line numbers.

## Installation
`pip install chlorophyll`

## Development install
First, fork the repo, then run these commands in your terminal
```console
git clone https://github.com/your-username/chlorophyll
cd chlorophyll
python3 -m venv env
source env/bin/activate
pip install -e .
```

# Documentation

### `CodeView` Widget
|Options             |Description                     |Input                                         |
|--------------------|--------------------------------|----------------------------------------------|
|master              |The parent widget               |Tkinter widget                                |
|lexer               |The Language lexer              |Pygments lexer                                |
|color_scheme        |A color scheme for the code     |Dict, string, or toml file                    |
|tab_width           |The width of a tab (`\t`)       |Int                                           |
|autohide_scrollbar  |Auto hide scrollbars            |Bool                                          |
|linenums_border     |Border width of the line numbers|Int                                           |
|default_context_menu|Enable context menus in CodeView|Bool                                          |
|**kwargs            |Keyword arguments for the widget|Any keyword arguments given to a `Text` widget|

#### Basic Usage:
```python
from tkinter import Tk

import pygments.lexers
from chlorophyll import CodeView

root = Tk()

codeview = CodeView(root, lexer=pygments.lexers.RustLexer, color_scheme="monokai")
codeview.pack(fill="both", expand=True)

root.mainloop()
```


