Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 3 KB

README.rst

File metadata and controls

107 lines (71 loc) · 3 KB

Bugfix maintenance only

https://raw.githubusercontent.com/pyQode/pyQode/master/media/pyqode-banner.png


Latest PyPI version Number of PyPI downloads

Travis-CI build status Coverage Status

About

pyqode.core is the core framework of the pyQode project.

It contains the base classes and a set of extensions (modes/panels/managers) needed to develop a specialised code editor.

It also provides a basic generic code editor that you can use as a fallback when there is no specialised editor for a given language.

Requirements

pyqode.core depends on the following libraries:

  • Python 2 (>=2.7) or Python 3 (>= 3.2)
  • PyQt5 or PyQt4 or PySide
  • pygments
  • pyqode.qt
  • future
  • qtawesome (optional)

Installation

You need to install PyQt or PySide by yourself. Note that you should prefer PyQt5 on Mac OSX (retina screen support, better integration).

Then you can install pyqode.core using pip:

$ pip install pyqode.core --upgrade

Testing

pyqode.core has a test suite and measure its coverage.

To run the tests, just run python setup.py test

To measure coverage, run:

python setup.py test -a "--cov pyqode"

To check for PEP8 warnings, install pytest-pep8 and run:

python setup.py test -a "--pep8 -m pep8"

To run a single test, use -a "-- test_file_path.py::test_function", e.g.:

python setup.py test -a "-- test/test_api/test_code_edit.py::test_set_plain_text"

Testing Matrix

We test the following combinations on Travis-CI:

  PyQt4 PyQt5
GNU/Linux - Python 2.7 yes no
GNU/Linux - Python 3.4 yes yes