Skip to main content

Python/Qt Code Editor widget

Project description

https://raw.githubusercontent.com/pyQode/pyqode.core/develop/doc/source/_static/pyqode-banner.png

About

Latest PyPI version Number of PyPI downloads Travis-CI build status Coverage Status

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: core package

  • pyqode.python: python support (code completion, …)

  • pyqode.designer: starts Qt designer with all pyqode plugins

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, notepad++) with only a few lines of code.

Features

Here are the core features:

  • support multiple frontend: PyQt5, PyQt4 and PySide

  • simple widget based on QPlainTextEdit

  • easily customisable (modes and panels)

  • native look and feel close to Qt creator

  • builtin modes and panels (line number, code completion, syntax highlighting,…)

  • Qt Designer plugin

  • client/server architecture for smooth, non-blocking UI.

License

pyQode is licensed under the MIT license.

Requirements

pyqode.core depends on the following libraries:

  • Python 3 (>= 3.2)

  • PyQt5 or PyQt4 or PySide

  • pygments

Installation

You need to install PyQt or PySide by yourself.

Then you can install pyqode.core using pip:

$ pip3 install pyqode.core

Testing

pyqode.core now have a test suite and measure its coverage.

To run the test, just run the following command (you don’t need to install anything):

$ python3 runtests.py

If you need coverage, install pytest-coverage and run:

$ python3 runtests.py --cov pyqode --cov-report term

If you want to test PEP8 compliance, install pytest-pep8 and run:

$ python3 runtests.py --pep8

Supported by

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