Skip to main content

pyside6-scintilla

CI PyPI Downloads License: MIT Python versions

Permissively-licensed PySide6 bindings for the Scintilla code editor component.

View on PyPI · View on GitHub

Status

See GitHub Issues for what's done and what's next.

Why this exists

The standard way to use Scintilla from Python + Qt is QScintilla (Riverbank Computing) — but it's a PyQt6 binding, with no PySide6 equivalent. Like PyQt6, it's also GPLv3 or commercially licensed.

Scintilla itself is licensed under the Historical Permission Notice and Disclaimer — a permissive license with no copyleft. This project aims to expose that permissive core directly to PySide6 users.

Goals

pyside6-scintilla aims to be:

  • MIT licensed — usable in open-source or closed-source projects freely
  • PySide6 native — built with shiboken6, integrating naturally with PySide6 widgets
  • A faithful, low-level binding of Scintilla's ScintillaEditBase widget — not a reimplementation of QScintilla's higher-level API
  • Available as pre-built wheels for Linux (x86_64, aarch64), Windows (x86_64), and macOS (arm64, x86_64)
  • Not affiliated with Riverbank Computing or the QScintilla project

Installation

Install from PyPI:

pip install pyside6-scintilla

PySide6-Essentials 6.10+ is installed automatically as a dependency; the wheels bundle everything else ScintillaEditBase needs at runtime. Essentials provides the whole PySide6 import namespace — only QtCore, QtGui and QtWidgets are used here, so the ~175 MB of PySide6-Addons (Qt WebEngine, Qt3D, QtCharts …) is left out. Install PySide6 yourself if you want them.

To build from source instead (e.g. for development), see docs/build.md for prerequisites (Qt 6.10+ with Qt6Core5Compat, a C++17 compiler) and platform-specific setup.

examples/highlighting/lexilla_highlighting/ uses lexilla as a dev dependency, installed from PyPI like any other package.

Usage

from PySide6.QtWidgets import QApplication
from pyside6_scintilla import ScintillaEdit

app = QApplication([])
editor = ScintillaEdit()
editor.setText("hello, world")
editor.show()
app.exec()

ScintillaEdit exposes a typed method per Scintilla message (e.g. setText(), textLength(), gotoLine()) on top of ScintillaEditBase's raw .send()/.sends() message API — the same SCI_* messages as the C interface, not a QScintilla-style high-level API. See examples/simple_scintilla_edit/ for a complete example (line-number margin, "Go to Line", block selection/editing), or examples/simple_scintilla_base_edit/ for the lower-level send/sends API.

Versioning

Version numbers follow <Scintilla version>.<binding revision> — e.g. 5.6.3.0 is binding revision 0 for Scintilla 5.6.3. The binding revision increments for releases of this package that don't correspond to a new Scintilla version (bug fixes, new API surface, CI changes, etc.), and resets to 0 when Scintilla itself releases a new version.

Documentation

Doc Contents
docs/alternatives.md How this compares to Monaco-based Qt bindings and other line-numbers + block-edit widgets
docs/auditing.md How to verify the vendored Scintilla source matches upstream
docs/bindings.md How the shiboken6 bindings are built, generated files, and the Scintilla-update procedure
docs/build.md Build prerequisites, local build/rebuild, wheels, and publishing
docs/documenting.md How the docs site is built, and how to add or update a page
docs/specs/ Design specifications and action plans for in-progress and planned work
docs/specs/mission.md Project background, goals, and design decisions
docs/testpypi.md Setting up TestPyPI trusted publishing
examples/ Standalone example apps, including ones showing lexilla-py in use
GitHub Issues Planned and in-progress work
Project board Joint roadmap for pyside6-scintilla and lexilla-py; issues/PRs from both repos are auto-added

Development tools

tools/ holds development scripts, run with uv run python tools/<script>.py:

Script Purpose
generate_pyi.py Regenerates the .pyi type stub for _pyside6_scintilla
check_docs_sync.py Verifies shared content blocks stay in sync between README.md and docs/index.md
clean_window_corners.py One-off cleanup for Windows window screenshots used in docs

License

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyside6_scintilla-5.6.3.7.tar.gz (2.3 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

pyside6_scintilla-5.6.3.7-cp311-abi3-win_amd64.whl (1.4 MB view details)

Uploaded CPython 3.11+Windows x86-64

pyside6_scintilla-5.6.3.7-cp311-abi3-manylinux_2_38_aarch64.manylinux_2_39_aarch64.whl (1.3 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.38+ ARM64manylinux: glibc 2.39+ ARM64

pyside6_scintilla-5.6.3.7-cp311-abi3-manylinux_2_34_x86_64.whl (1.4 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.34+ x86-64

pyside6_scintilla-5.6.3.7-cp311-abi3-macosx_13_0_x86_64.whl (2.8 MB view details)

Uploaded CPython 3.11+macOS 13.0+ x86-64

pyside6_scintilla-5.6.3.7-cp311-abi3-macosx_13_0_arm64.whl (2.8 MB view details)

Uploaded CPython 3.11+macOS 13.0+ ARM64

File details

Details for the file pyside6_scintilla-5.6.3.7.tar.gz.

File metadata

  • Download URL: pyside6_scintilla-5.6.3.7.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for pyside6_scintilla-5.6.3.7.tar.gz
Algorithm Hash digest
SHA256 1e29e06e2039378a3f9bd502505f6f0ab20f12ab8e5f2c919786a5d81cf30211
MD5 4e92a6249515dc8a03cb817e96faff56
BLAKE2b-256 a7c16a7b1a2a214d4fa718424743d50fa55b150aff446baae7365b3b76c0d62d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyside6_scintilla-5.6.3.7.tar.gz:

Publisher: publish.yml on borco/pyside6-scintilla

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyside6_scintilla-5.6.3.7-cp311-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for pyside6_scintilla-5.6.3.7-cp311-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 8c15893362b1608d9dc26983477e327359a9a90b560e693be6076493fcc9f3c7
MD5 a8d876c1e7b69bf39574c8473a65c95d
BLAKE2b-256 de98f77f4bf8e74c9331d857b707d71ed556c4435498b83397c34713c7e63e5c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyside6_scintilla-5.6.3.7-cp311-abi3-win_amd64.whl:

Publisher: publish.yml on borco/pyside6-scintilla

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyside6_scintilla-5.6.3.7-cp311-abi3-manylinux_2_38_aarch64.manylinux_2_39_aarch64.whl.

File metadata

File hashes

Hashes for pyside6_scintilla-5.6.3.7-cp311-abi3-manylinux_2_38_aarch64.manylinux_2_39_aarch64.whl
Algorithm Hash digest
SHA256 0fe5ae9c760a678b2aae24e4bb31e699f021f2d013ab0d6e10dcab3334799eeb
MD5 ec58df80e212265c4b05a4d8a3471c2e
BLAKE2b-256 bd2042512f6c9ffde689691ae5e6e03ca0a5365e42d6fd349bc1f7fec9f377ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyside6_scintilla-5.6.3.7-cp311-abi3-manylinux_2_38_aarch64.manylinux_2_39_aarch64.whl:

Publisher: publish.yml on borco/pyside6-scintilla

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyside6_scintilla-5.6.3.7-cp311-abi3-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for pyside6_scintilla-5.6.3.7-cp311-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 a99dc97d15ddac3cc2502209bb3bc6f4c0712b99f2526559aa07b09af9904f4b
MD5 39d7f4add997d8fb0c3d269589b69fdc
BLAKE2b-256 3959bf5a394bfb5ac640d844fe07180de479727d222f995d325b664ce55dae82

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyside6_scintilla-5.6.3.7-cp311-abi3-manylinux_2_34_x86_64.whl:

Publisher: publish.yml on borco/pyside6-scintilla

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyside6_scintilla-5.6.3.7-cp311-abi3-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for pyside6_scintilla-5.6.3.7-cp311-abi3-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 52c72012f8cc99f2e774a07dd3771502408775350f35a397093135c9a2bc52e2
MD5 ddf9fb32f47f52da2a7d7eafa5d16ca9
BLAKE2b-256 5c115c50a90517cf0a8e5f2ec450e54ad1b416f75284a9d127a7e1e73172eb57

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyside6_scintilla-5.6.3.7-cp311-abi3-macosx_13_0_x86_64.whl:

Publisher: publish.yml on borco/pyside6-scintilla

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyside6_scintilla-5.6.3.7-cp311-abi3-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for pyside6_scintilla-5.6.3.7-cp311-abi3-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 856d9f7d67e3795934bac111e75ca242189300eb6cec49eb88fbe98340846b16
MD5 7e54194728b5a2b1876c243a93947bd1
BLAKE2b-256 201e449b29a531687a8aeeb121054a3d69ff36143fc395ac6b530474bf490653

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyside6_scintilla-5.6.3.7-cp311-abi3-macosx_13_0_arm64.whl:

Publisher: publish.yml on borco/pyside6-scintilla

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page