Skip to content

A simple Python Qt syntax highlighting widget

License

Notifications You must be signed in to change notification settings

davidwinter/syntaxedit

Repository files navigation

syntaxedit

test PyPI

A simple Python Qt syntax highlighting widget

syntaxedit

Features

  • Extensive syntax and theme support - powered by Pygments
  • Set font and font size
  • Set indentation size

Usage

  1. Install package

    pip install syntaxedit

    Or

    poetry add syntaxedit
  2. In your app, include the package, and create a SyntaxEdit widget:

    from syntaxedit.core import SyntaxEdit
    
    code = """# Todo list
    
    - [ ] Go shopping
    - [x] Walk the dog"""
    
    widget = SyntaxEdit(code)

Available options

  • content: the initial content for the widget. Default: ""
  • parent: parent Qt widget for SyntaxEdit. Default: None
  • font: the font family for the widget. Default: "Courier New"
  • font_size: size to use for the font. Default: 13
  • syntax: the code syntax to use. Default: "Markdown"
  • theme: the syntax theme to use. Default: "solarized-light"
  • indentation_size: the size for indentation. Default: 4
  • use_theme_background: whether to use the background colour from the theme or to not set one. Default: True

Authors

By David Winter

License

MIT