https://github.com/rdbende/chlorophyll
A Tkinter widget that fills your code with color
https://github.com/rdbende/chlorophyll
chlorophyll colors editor syntax-highlighter syntax-highlighting tkinter
Last synced: 4 months ago
JSON representation
A Tkinter widget that fills your code with color
- Host: GitHub
- URL: https://github.com/rdbende/chlorophyll
- Owner: rdbende
- License: mit
- Created: 2022-07-19T10:06:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-11T14:21:19.000Z (about 1 year ago)
- Last Synced: 2025-01-01T09:02:54.452Z (5 months ago)
- Topics: chlorophyll, colors, editor, syntax-highlighter, syntax-highlighting, tkinter
- Language: Python
- Homepage: https://pypi.org/project/chlorophyll/
- Size: 42 KB
- Stars: 43
- Watchers: 4
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Chlorophyll
> **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()
```