pyQode

Welcome to the pyqode.core documentation!

pyQode is a flexible source code editor widget for PyQt/PySide applications.

pyQode is a library/widget, not an IDE. You can see it as an alternative to QScintilla.

pyQode is organised as a namespace package made up of the following official packages:

pyqode.core is the foundation package, it contains the base classes (CodeEdit, Mode, Panel) and a set of builtin modes and panels that are useful for any kind of code editor. With pyqode.core you can already create a generic code editor (similar to gedit, leafpad, notepad++, ...) with only a few lines of code.

This documentation will only cover the pyqode.core package.

Parts of the documentation:

  • What’s New?

    What’s new since the last release, and what is planned for the next one.

  • Download & Install

    Instructions on where and how to install pyQode.

  • Getting started

    A gentle introduction to pyQode, covering some basic principles.

  • Advanced topics

    A more in depth approach to pyQode, covering advanced features

  • Examples

    Practical examples demonstrating how to use the framework.

  • API Reference

    The api reference documentation

Meta information:

  • License

    pyQode license

  • Credits

    Credits to contributors and external libraries

Indices and tables: