CEF Python

Introduction

CEF Python is a BSD-licensed open source project founded by Czarek Tomczak in 2012 and is based on Google Chromium and the CEF Framework projects. 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. Examples of embedding Chrome browser are available for many popular GUI toolkits including: wxPython, PyGTK, PyQt, PySide, Kivy, Panda3D and PyGame/PyOpenGL.

There are many use cases for CEF. You can embed a web browser control based on Chromium with great HTML 5 support. You can use it to create a HTML 5 based GUI in an application, this can act as a replacement for standard GUI toolkits such as wxWidgets, Qt or GTK. In such case to communicate between Python<>Javascript use javascript bindings or embed an internal web server and talk using http requests. You can render web content off-screen in applications that use custom drawing frameworks. You can use it for automated testing of existing applications. You can use it for web scraping or as a web crawler, or other kind of internet bots.

Install

You can install with pip. On Linux pip 8.1+ is required. You can also download packages for offline installation available on the GitHub Releases pages.

pip install cefpython3==56.1

Tutorial

See the Tutorial.md file.

Examples

See the Examples-README.md file.

Support

• Ask questions, report problems and issues on the Forum
• Supported examples are listed in the Examples-README.md file
• Documentation is in the docs/ directory:
  • Build instructions
  • Knowledge base
  • Migration guide
  • Tutorial
• API reference is in the api/ directory:
  • API categories
  • API index
• Additional documentation is in issues labelled Knowledge Base
• To search documentation use GitHub "This repository" search at the top. To narrow results to documentation only select "Markdown" in the right pane.
• Wiki pages are deprecated and for v31 only

Releases

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

Latest release

OS	Py2	Py3	32bit	64bit	Requirements
Windows	2.7	3.4 / 3.5 / 3.6	Yes	Yes	Windows 7+
Linux	2.7	3.4 / 3.5 / 3.6	Yes	Yes	Debian 7+ / Ubuntu 12.04+
Mac	2.7	3.4 / 3.5 / 3.6	No	Yes	MacOS 10.9+

These platforms are not supported yet:

• ARM - see Issue #267
• Android - see Issue #307

v31 release

OS	Py2	Py3	32bit	64bit	Requirements
Windows	2.7	No	Yes	Yes	Windows XP+
Linux	2.7	No	Yes	Yes	Debian 7+ / Ubuntu 12.04+
Mac	2.7	No	Yes	Yes	MacOS 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 wiki pages and on GitHub Releases tagged v31.2.
• Documentation is on wiki pages
• API reference is available in revision 169a1b2