Home

Awesome

CEF Python

Table of contents:

Introduction

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.

Latest releases sponsored by

<table border="0"><tr> <td width="50%" valign="top"> <p align="center"> <a href="https://www.fivestars.com/"> <img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/fivestars360.png"> </a> </p>

Thank you to Fivestars for sponsoring the v66.1 release with Python 3.8 / 3.9 support. Fivestars helps local communities thrive by empowering small businesses with cutting edge marketing technology. Please visit their website: <a href="https://www.fivestars.com/">Fivestars.com</a>

</td><td width="50%" valign="top"> <p align="center"> <a href="https://lampix.com/"> <img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/lampix360.png"> </a> </p>

Thank you to Lampix for sponsoring the v66 release. Lampix is the first hardware and software solution that turns any surface into a smart, augmented reality or interactive surface. Please visit their website: <a href="https://lampix.com/">Lampix.com</a>

</tr></table>

Thanks to all sponsors

<table> <tr> <td> <div align="center"> <a href="https://www.fivestars.com/"> <img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/fivestars200.png"> </a><br> <a href="https://www.fivestars.com/">www.fivestars.com</a> </div> </td> <td> <div align="center"> <a href="https://lampix.com/"> <img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/lampix200.png"> </a><br> <a href="https://lampix.com/">www.lampix.com</a> </div> </td> <td> <div align="center"> <a href="http://www.blueplanet.com/"> <img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/cyan_new_logo_200x48.png"> </a><br> <a href="http://www.blueplanet.com/">www.blueplanet.com</a> </div> </td> </tr> <tr> <td> <div align="center"> <a href="https://highside.io/"> <img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/highside-onlight-200x48.png"> </a><br> <a href="https://highside.io/">www.highside.io</a> <div align="center"> </td> <td> <div align="center"> <a href="http://www.rentouch.ch/"> <img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/rentouch.png"> </a><br> <a href="http://www.rentouch.ch/">www.rentouch.ch</a> </div> </td> <td> <div align="center"> <a href="https://www.jetbrains.com/pycharm/"> <img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/pycharm.png"> </a><br> <a href="https://www.jetbrains.com/pycharm/">www.jetbrains.com</a> </div> </td> <tr> </table>

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.1

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

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+,<br> 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+

v31 release (old systems)

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

Additional information for v31.2 release:

Support development

If you would like to support general CEF Python development efforts by making a donation then please click the Paypal Donate button below. If you would like to see a specific feature implemented then you can make a comment about that when making a donation and that will give it a higher priority.

<a href='https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V7LU7PD4N4GGG'> <img src='https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/donate.gif' /> </a><br><br>

Thanks to all

Seeking new sponsors

CEF Python is seeking companies to sponsor further development of the project. There are many proposals for new features submitted in the issue tracker. Most notable are:

If your company would like to sponsor CEF Python development efforts then please contact Czarek. Long term sponsorships are welcome and Czarek is open to ideas about the project. He would love to spend more time on developing this project, but he can't afford doing so in his free time. Currently there is no company supporting this project actively on a daily basis.

Other READMEs

Quick links

Docs

API categories

Modules

Settings

Classes and objects

Client handlers (interfaces)

Other interfaces

API index