Skip to content

Commit 3ca4678

Browse files
cztomczakcztomczak
committed
Update README.md
1 parent 3ffa695 commit 3ca4678

File tree

2 files changed

+169
-135
lines changed

2 files changed

+169
-135
lines changed

‎README.md‎

Lines changed: 166 additions & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -7,116 +7,74 @@ Table of contents:
77
* [Tutorial](#tutorial)
88
* [Examples](#examples)
99
* [Support](#support)
10-
* [Support development](#support-development)
11-
* [Thanks](#thanks)
1210
* [Releases](#releases)
1311
* [Next release](#next-release)
1412
* [Latest release](#latest-release)
1513
* [v49 release (WinXP/Vista)](#v49-release-winxpvista)
1614
* [v31 release (old systems)](#v31-release-old-systems)
15+
* [Support development](#support-development)
16+
* [Thanks to sponsors](#thanks-to-sponsors)
17+
* [Thanks to all](#thanks-to-all)
18+
* [Seeking new sponsors](#seeking-new-sponsors)
1719
* [Other READMEs](#other-readmes)
1820
* [Quick links](#quick-links)
1921

2022

2123
## Introduction
2224

23-
CEF Python is a BSD-licensed open source project founded by Czarek Tomczak (hire me! see my [resume](https://drive.google.com/file/d/17xmoT5Z_zTHkVclqPzrs2aAV64Uiu7fh/view)) in 2012 and is based on Google Chromium and the
24-
[CEF Framework](https://bitbucket.org/chromiumembedded/cef)
25-
projects. The Chromium project focuses mainly on Google Chrome application
25+
CEF Python is an open source project founded by [Czarek Tomczak](https://drive.google.com/file/d/17xmoT5Z_zTHkVclqPzrs2aAV64Uiu7fh/view)
26+
(available for contract work) in 2012 to provide Python bindings for the
27+
[Chromium Embedded Framework](https://bitbucket.org/chromiumembedded/cef) (CEF). The Chromium project focuses mainly on Google Chrome application
2628
development while CEF focuses on facilitating embedded browser use cases
2729
in third-party applications. Lots of applications use CEF control, there are
2830
more than [100 million CEF instances](http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF)
29-
installed around the world. [Examples of embedding](examples/README-examples.md)
30-
Chrome browser are available for many popular GUI toolkits including:
31-
wxPython, PyGTK, PyQt, PySide, Kivy, Panda3D and PyGame/PyOpenGL.
32-
33-
There are many use cases for CEF. You can embed a web browser control
34-
based on Chromium with great HTML 5 support. You can use it to create
35-
a HTML 5 based GUI in an application, this can act as a replacement for
36-
standard GUI toolkits such as wxWidgets, Qt or GTK. In such case to
37-
communicate between Python<>Javascript use [javascript bindings](docs/Tutorial.md#javascript-integration)
38-
or embed an internal web server and talk using http requests. You
39-
can render web content off-screen in applications that use custom
40-
drawing frameworks. You can use it for automated testing of existing
41-
applications. You can use it for web scraping or as a web crawler,
42-
or other kind of internet bots.
31+
installed around the world. There are numerous use cases for CEF:
32+
1. Use it as a modern HTML5 based rendering engine that can act as a replacement
33+
for classic desktop GUI frameworks. Think of it as Electron for Python.
34+
2. Embed a web browser widget in a classic Qt / GTK / wxPython desktop
35+
application
36+
3. Render web content off-screen in applications that use custom drawing frameworks
37+
4. Use it for automated testing of web applications with more advanced capabilities
38+
than Selenium web browser automation due to
39+
CEF low level programming APIs
40+
5. Use it for web scraping, as a web crawler or other kind of internet bots
41+
42+
CEF Python also provides examples of embedding CEF for many Python GUI
43+
frameworks such as PyQt, wxPython, PyGTK, PyGObject, Tkinter, Kivy, Panda3D,
44+
PyGame, PyOpenGL, PyWin32, PySide and PySDL2.
4345

4446

4547
## Sponsors
4648

47-
<table>
48-
<tr>
49-
<td>
50-
<div align="center">
51-
<a href="https://www.fivestars.com/">
52-
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/fivestars200.png">
53-
</a><br>
54-
<a href="https://www.fivestars.com/">www.fivestars.com</a>
55-
</div>
56-
</td>
57-
<td>
58-
<div align="center">
59-
<a href="https://lampix.com/">
60-
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/lampix200.png">
61-
</a><br>
62-
<a href="https://lampix.com/">www.lampix.com</a>
63-
</div>
64-
</td>
65-
<td>
66-
<div align="center">
67-
<a href="http://www.blueplanet.com/">
68-
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/cyan.png">
69-
</a><br>
70-
<a href="http://www.blueplanet.com/">www.blueplanet.com</a>
71-
</div>
72-
</td>
73-
</tr>
74-
<tr>
75-
<td>
76-
<div align="center">
77-
<a href="https://clearchat.com/">
78-
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/clearchat.png">
79-
</a><br>
80-
<a href="https://clearchat.com/">www.clearchat.com</a>
81-
<div align="center">
82-
</td>
83-
<td>
84-
<div align="center">
85-
<a href="http://www.rentouch.ch/">
86-
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/rentouch.png">
87-
</a><br>
88-
<a href="http://www.rentouch.ch/">www.rentouch.ch</a>
89-
</div>
90-
</td>
91-
<td>
92-
<div align="center">
93-
<a href="https://www.jetbrains.com/pycharm/">
94-
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/pycharm.png">
95-
</a><br>
96-
<a href="https://www.jetbrains.com/pycharm/">www.jetbrains.com</a>
97-
</div>
98-
</td>
99-
<tr>
100-
</table>
101-
102-
See the [Support development](#support-development) section for a list of
103-
all the individuals and companies supporting CEF Python.
49+
<table border="0"><tr>
50+
<td width="50%" valign="top">
10451

52+
<p align="center">
53+
<a href="https://lampix.com/">
54+
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/lampix360.png">
55+
</a>
56+
</p>
10557

106-
**Thanks to Lampix for the v66 release**
107-
108-
Many Thanks to Lampix for sponsoring the [v66 release](../../releases/tag/v66.0) of CEF Python.
58+
Many Thanks to Lampix for sponsoring the [v66 release](../../releases/tag/v66.0).
10959
Lampix is the first hardware and software solution that turns any surface
110-
into a smart, augmented reality or interactive surface. Please visit its
111-
website here: https://lampix.com/ .
60+
into a smart, augmented reality or interactive surface. Please visit their website:
61+
<a href="https://lampix.com/">Lampix.com</a>
62+
63+
</td><td width="50%" valign="top">
11264

65+
<p align="center">
66+
<a href="https://www.fivestars.com/">
67+
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/fivestars360.png">
68+
</a>
69+
</p>
11370

114-
**Thanks to Fivestars for the v49 release (WinXP/Vista)**
71+
Many thanks to Fivestars for sponsoring the
72+
[v49 legacy release](../../releases/tag/v49.0). Fivestars helps local
73+
communities thrive by empowering small
74+
businesses with cutting edge marketing technology. Please visit their website:
75+
<a href="https://www.fivestars.com/">Fivestars.com</a>
11576

116-
Thanks to Fivestars Loyalty, Inc. for sponsoring the
117-
[v49 release](../../releases/tag/v49.0) for legacy systems such
118-
as Windows XP and Vista. Please visit its website:
119-
https://www.fivestars.com/ .
77+
</tr></table>
12078

12179

12280
## Install
@@ -169,55 +127,6 @@ document.
169127
- Wiki pages are deprecated and for v31 only
170128

171129

172-
## Support development
173-
174-
If you would like to support general CEF Python development efforts
175-
by making a donation please click the Paypal Donate button:
176-
177-
<a href='https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V7LU7PD4N4GGG'>
178-
<img src='https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/donate.gif' />
179-
</a><br><br>
180-
181-
If you would like to see some feature implemented you can make
182-
a comment about that when making a donation. It will give it
183-
a higher priority.
184-
185-
If you are interested in sponsorship opportunities please contact Czarek
186-
directly - contact details are available in his [Resume](https://drive.google.com/file/d/17xmoT5Z_zTHkVclqPzrs2aAV64Uiu7fh/view).
187-
188-
If you would like to sponsor CEF Python development efforts and see your company
189-
logo with a link in README, please contact Czarek.
190-
This README page alone has 1,070 visitors and 2,402 views every two weeks,
191-
so your company logo and a website link will be visible to many Python developers.
192-
The statistics are from Mar 9, 2018. Complete statistics are available in this topic
193-
on the Forum: [[ANN] Call for sponsors](https://groups.google.com/d/topic/cefpython/CjkZF2P4rMk/discussion).
194-
195-
196-
### Thanks
197-
198-
* [2018] Thanks to [Fivestars](https://www.fivestars.com/) for sponsoring
199-
the v49 release for legacy systems (WinXP/Vista)
200-
* [2018] Many thanks to [Lampix](https://lampix.com/) for sponsoring the v66
201-
release for all platforms
202-
* [2017] Many thanks to [ClearChat Inc.](https://clearchat.com/) for sponsoring
203-
the v55/v56 releases for all platforms
204-
* [2016-2018] Thanks to JetBrains for providing an Open Source license for
205-
[PyCharm](https://www.jetbrains.com/pycharm/)
206-
* [2014] Thanks to Adam Duston for donating a Macbook to aid the development
207-
of Mac port
208-
* [2013-2015] Lots of thanks goes to [Cyan Inc.](http://www.blueplanet.com/)
209-
for sponsoring this project for a long time, making CEF Python 3 mature
210-
* [2013] Thanks to [Rentouch GmbH](http://www.rentouch.ch/) for sponsoring the
211-
development of the off-screen rendering support
212-
* [2013] Thanks to Thomas Wusatiuk for sponsoring the development of the web
213-
response reading features
214-
* [2012-2018] Thanks to those who have made a Paypal donation:
215-
[Rentouch GmbH](http://www.rentouch.ch/), Walter Purvis, Rokas Stupuras,
216-
Alex Rattray, Greg Kacy, Paul Korzhyk, Tomasz Tomanek.
217-
* [2012-2017] Thanks to those who have donated their time through code contributions,
218-
they are listed in the [Authors](Authors) file
219-
220-
221130
## Releases
222131

223132
Information on planned new and current releases, supported platforms,
@@ -286,6 +195,128 @@ Additional information for v31.2 release:
286195
- API reference is available in revision [169a1b2](../../tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api)
287196

288197

198+
## Support development
199+
200+
If you would like to support general CEF Python development efforts
201+
by making a donation then please click the Paypal Donate button below.
202+
If you would like to see a specific feature implemented then you can make
203+
a comment about that when making a donation and that will give it a higher
204+
priority.
205+
206+
<a href='https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V7LU7PD4N4GGG'>
207+
<img src='https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/donate.gif' />
208+
</a><br><br>
209+
210+
### Thanks to sponsors
211+
212+
<table>
213+
<tr>
214+
<td>
215+
<div align="center">
216+
<a href="https://www.fivestars.com/">
217+
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/fivestars200.png">
218+
</a><br>
219+
<a href="https://www.fivestars.com/">www.fivestars.com</a>
220+
</div>
221+
</td>
222+
<td>
223+
<div align="center">
224+
<a href="https://lampix.com/">
225+
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/lampix200.png">
226+
</a><br>
227+
<a href="https://lampix.com/">www.lampix.com</a>
228+
</div>
229+
</td>
230+
<td>
231+
<div align="center">
232+
<a href="http://www.blueplanet.com/">
233+
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/cyan.png">
234+
</a><br>
235+
<a href="http://www.blueplanet.com/">www.blueplanet.com</a>
236+
</div>
237+
</td>
238+
</tr>
239+
<tr>
240+
<td>
241+
<div align="center">
242+
<a href="https://clearchat.com/">
243+
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/clearchat.png">
244+
</a><br>
245+
<a href="https://clearchat.com/">www.clearchat.com</a>
246+
<div align="center">
247+
</td>
248+
<td>
249+
<div align="center">
250+
<a href="http://www.rentouch.ch/">
251+
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/rentouch.png">
252+
</a><br>
253+
<a href="http://www.rentouch.ch/">www.rentouch.ch</a>
254+
</div>
255+
</td>
256+
<td>
257+
<div align="center">
258+
<a href="https://www.jetbrains.com/pycharm/">
259+
<img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/pycharm.png">
260+
</a><br>
261+
<a href="https://www.jetbrains.com/pycharm/">www.jetbrains.com</a>
262+
</div>
263+
</td>
264+
<tr>
265+
</table>
266+
267+
268+
### Thanks to all
269+
270+
* [2018] Thanks to [Fivestars](https://www.fivestars.com/) for sponsoring
271+
the v49 release for legacy systems (WinXP/Vista)
272+
* [2018] Many thanks to [Lampix](https://lampix.com/) for sponsoring the v66
273+
release for all platforms
274+
* [2017] Many thanks to [ClearChat Inc.](https://clearchat.com/) for sponsoring
275+
the v55/v56 releases for all platforms
276+
* [2016-2018] Thanks to JetBrains for providing an Open Source license for
277+
[PyCharm](https://www.jetbrains.com/pycharm/)
278+
* [2014] Thanks to Adam Duston for donating a Macbook to aid the development
279+
of Mac port
280+
* [2013-2015] Lots of thanks goes to [Cyan Inc.](http://www.blueplanet.com/)
281+
for sponsoring this project for a long time, making CEF Python 3 mature
282+
* [2013] Thanks to [Rentouch GmbH](http://www.rentouch.ch/) for sponsoring the
283+
development of the off-screen rendering support
284+
* [2013] Thanks to Thomas Wusatiuk for sponsoring the development of the web
285+
response reading features
286+
* [2012-2018] Thanks to those who have made a Paypal donation:
287+
[Rentouch GmbH](http://www.rentouch.ch/), Walter Purvis, Rokas Stupuras,
288+
Alex Rattray, Greg Kacy, Paul Korzhyk, Tomasz Tomanek.
289+
* [2012-2017] Thanks to those who have donated their time through code
290+
contributions, they are listed in the [Authors](Authors) file
291+
292+
293+
## Seeking new sponsors
294+
295+
CEF Python is seeking companies to sponsor further development of the project.
296+
There are many proposals for new features submitted in the issue tracker. Most
297+
notable are:
298+
299+
* Monthly releases with latest Chromium
300+
* An automated build system similar to upstream CEF Spotify Automated Builds
301+
* ARM and Android support
302+
* Multi-threaded support for increased performance
303+
* Proprietary codecs support in build tools: H264, H265,AC3, EAC3, MPEG-4
304+
* More CEF API exposed, only about 50% is exposed so far
305+
* Hundreds of new settings and Chromium preferences not yet exposed
306+
* Easier integration with popular GUI toolkits in just a few lines of code
307+
and support for more third party GUI frameworks
308+
* More examples of implementing various advanced features and more snippets
309+
as well
310+
311+
If your company would like to sponsor CEF Python development efforts then
312+
please contact
313+
[Czarek](https://drive.google.com/file/d/17xmoT5Z_zTHkVclqPzrs2aAV64Uiu7fh/view).
314+
Long term sponsorships are welcome and Czarek is open to ideas about
315+
the project. He would love to spend more time on developing this project,
316+
but he can't afford doing so in his free time. Currently there is no company
317+
supporting this project actively on a daily basis.
318+
319+
289320
## Other READMEs
290321

291322
- [PyInstaller packager](examples/pyinstaller/README-pyinstaller.md)

‎api/Browser.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
# Browser (object)
55

6+
The methods of this object may be called on any thread unless otherwise
7+
indicated in the comments.
8+
69
Remember to free all browser references when closing app
710
for the browser to shut down cleanly.
811
Otherwise data such as cookies or other storage might not be flushed to disk

0 commit comments

Comments
 (0)