CEF Python


CEF Python is an open source project founded by Czarek Tomczak in 2012 to provide Python bindings for the Chromium Embedded Framework (CEF). The Chromium project focuses mainly on Google Chrome application development while CEF focuses on facilitating embedded browser use cases in third-party applications. Lots of applications use CEF control, there are more than 100 million CEF instances installed around the world. There are numerous use cases for CEF:

  1. Use it as a modern HTML5 based rendering engine that can act as a replacement for classic desktop GUI frameworks. Think of it as Electron for Python.
  2. Embed a web browser widget in a classic Qt / GTK / wxPython desktop application
  3. Render web content off-screen in applications that use custom drawing frameworks
  4. Use it for automated testing of web applications with more advanced capabilities than Selenium web browser automation due to CEF low level programming APIs
  5. Use it for web scraping, as a web crawler or other kind of internet bots

CEF Python also provides examples of embedding CEF for many Python GUI frameworks such as PyQt, wxPython, PyGTK, PyGObject, Tkinter, Kivy, Panda3D, PyGame, PyOpenGL, PyWin32, PySide and PySDL2.

Install

You can install pypi/cefpython3 package using pip tool. On Linux pip 8.1+ is required. You can also download packages for offline installation available on the GitHub Releases pages. Command to install with pip:

pip install cefpython3==66.0

Tutorial

See the Tutorial.md document.

Examples

See the README-examples.md and README-snippets.md documents.

Support

Releases

Information on planned new and current releases, supported platforms, python versions, architectures and requirements. If you want to support old operating systems then choose the v31 release.

Next release

  • To see planned new features or bugs to be fixed in the near future in one of next releases, see the next release label in the tracker
  • To see planned new features or bugs to be fixed in further future, see the next release 2 label in the tracker

Latest release

OSPy2Py332bit64bitRequirements
Windows2.73.4 / 3.5 / 3.6 / 3.7 / 3.8 / 3.9YesYesWindows 7+ (Note that Python 3.9 supports Windows 8.1+)
Linux2.73.4 / 3.5 / 3.6 / 3.7YesYesDebian 8+, Ubuntu 14.04+,
Fedora 24+, openSUSE 13.3+
Mac2.73.4 / 3.5 / 3.6 / 3.7NoYesMacOS 10.9+

These platforms are not supported yet:

v49 release (WinXP/Vista)

OSPy2Py332bit64bitRequirements
Windows2.73.4YesYesWindows XP+
  • Install with command: pip --no-cache-dir install cefpython3==49.0.
  • Please note that if you were previously installing cefpython3 package it is required to use the --no-cache-dir flag, otherwise pip will end up with error message No matching distribution found for cefpython3==49.0. This happens because 49.0 release occured after 57.0 and 66.0 releases.
  • Downloads are available on GitHub Releases tagged v49.0.
  • See Migration guide document for changes in this release
  • Documentation is available in the docs/ directory in the cefpython49-winxp branch
  • API reference is available in the api/ directory in the cefpython49-winxp branch

v31 release (old systems)

OSPy2Py332bit64bitRequirements
Windows2.7NoYesYesWindows XP+
Linux2.7NoYesYesDebian 7+ / Ubuntu 12.04+
Mac2.7NoYesYesMacOS 10.7+

Additional information for v31.2 release:

  • On Windows/Mac you can install with command: pip install cefpython3==31.2
  • Downloads are available on the GitHub Releases page tagged v31.2.
  • API reference is available in revision 169a1b2
  • Other documentation can be downloaded by cloning the cefpython.wiki repository: git clone [email protected]:cztomczak/cefpython.wiki.git
GitHub - cztomczak/cefpython: Python bindings for the Chromium Embedded Framework (CEF)
Python bindings for the Chromium Embedded Framework (CEF) - GitHub - cztomczak/cefpython: Python bindings for the Chromium Embedded Framework (CEF)