Skip to content

Latest commit

 

History

History
828 lines (746 loc) · 40.7 KB

README.md

File metadata and controls

828 lines (746 loc) · 40.7 KB
Raw

CEF Python

Table of contents:

Introduction

CEF Python is a BSD-licensed open source project founded by Czarek Tomczak (hire me! see my resume) 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.

Sponsors

See the Support development section for a list of all the individuals and companies supporting CEF Python.

Thanks to Lampix for the v66 release

Many Thanks to Lampix for sponsoring the v66 release of CEF Python. Lampix is the first hardware and software solution that turns any surface into a smart, augmented reality or interactive surface. Please visit its website here: https://lampix.com/ .

Thanks to Fivestars for the v49 release (WinXP/Vista)

Thanks to Fivestars Loyalty, Inc. for sponsoring the v49 release for legacy systems such as Windows XP and Vista. Please visit its website: https://www.fivestars.com/ .

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

For small and easy to understand code snippets that show various CEF features see the README-snippets.md document.

Support

Support development

If you would like to support general CEF Python development efforts by making a donation please click the Paypal Donate button:



If you would like to see some feature implemented you can make a comment about that when making a donation. It will give it a higher priority.

If you are interested in sponsorship opportunities please contact Czarek directly - contact details are available in his Resume.

If you would like to sponsor CEF Python development efforts and see your company logo with a link in README, please contact Czarek. This README page alone has 1,070 visitors and 2,402 views every two weeks, so your company logo and a website link will be visible to many Python developers. The statistics are from Mar 9, 2018. Complete statistics are available in this topic on the Forum: [ANN] Call for sponsors.

Thanks

  • [2018] Thanks to Fivestars for sponsoring the v49 release for legacy systems (WinXP/Vista)
  • [2018] Many thanks to Lampix for sponsoring the v66 release for all platforms
  • [2017] Many thanks to ClearChat Inc. for sponsoring the v55/v56 releases for all platforms
  • [2016-2018] Thanks to JetBrains for providing an Open Source license for PyCharm
  • [2014] Thanks to Adam Duston for donating a Macbook to aid the development of Mac port
  • [2013-2015] Lots of thanks goes to Cyan Inc. for sponsoring this project for a long time, making CEF Python 3 mature
  • [2013] Thanks to Rentouch GmbH for sponsoring the development of the off-screen rendering support
  • [2013] Thanks to Thomas Wusatiuk for sponsoring the development of the web response reading features
  • [2012-2018] Thanks to those who have made a Paypal donation: Rentouch GmbH, Walter Purvis, Rokas Stupuras, Alex Rattray, Greg Kacy, Paul Korzhyk, Tomasz Tomanek.
  • [2012-2017] Thanks to those who have donated their time through code contributions, they are listed in the Authors file

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 next release, see the next release label in the tracker
  • To see planned new features or bugs to be fixed in the in one of next releases, see the next release 2 label in the tracker

Latest release

OS Py2 Py3 32bit 64bit Requirements
Windows 2.7 3.4 / 3.5 / 3.6 / 3.7 / 3.8 Yes Yes Windows 7+
Linux 2.7 3.4 / 3.5 / 3.6 / 3.7 / 3.8 Yes Yes Debian 8+, Ubuntu 14.04+, Fedora 24+, openSUSE 13.3+
Mac 2.7 3.4 / 3.5 / 3.6 / 3.7 / 3.8 No Yes MacOS 10.9+

These platforms are not supported yet:

v49 release (WinXP/Vista)

OS Py2 Py3 32bit 64bit Requirements
Windows 2.7 3.4 Yes Yes Windows 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)

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

Other READMEs

Quick links

Docs

API categories

Modules

Settings

Classes and objects

Client handlers (interfaces)

Other interfaces

API index