|
1 | 1 | # CEF Python |
2 | 2 |
|
3 | | -[](https://github.com/cztomczak/cefpython#cef-python) |
4 | | -[](https://github.com/cztomczak/cefpython/releases/latest) |
5 | | -[](https://pypi.python.org/pypi/cefpython3/) |
6 | | -[](https://github.com/cztomczak/cefpython/compare/05366f2...master) |
7 | | - |
8 | | -__IMPORTANT NOTES__: |
9 | | -* Master branch is a work in progress. The last stable release |
10 | | - is in the cefpython31 branch. Up-to-date API docs for the cefpython31 |
11 | | - branch can be viewed in commit [169a1b2](https://github.com/cztomczak/cefpython/tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api). |
12 | | -* Repository rewritten on 2016-02-15 to reduce its size. |
13 | | - Please clone it again. |
14 | | - |
15 | 3 | Table of contents: |
16 | 4 | * [Introduction](#introduction) |
17 | | -* [Compatibility](#compatibility) |
18 | | -* [Downloads](#downloads) |
| 5 | +* [Versions](#versions) |
| 6 | + * [v50+ releases](#v50-releases) |
| 7 | + * [v31 release](#v31-release) |
19 | 8 | * [Support](#support) |
20 | | -* [Changes in API during updates](#changes-in-api-during-updates) |
21 | | -* [Donate](#donate) |
| 9 | +* [Support development](#support-development) |
| 10 | + * [Thanks](#thanks) |
22 | 11 |
|
23 | 12 |
|
24 | 13 | ## Introduction |
25 | 14 |
|
26 | | -CEF Python is an open source project founded by [Czarek Tomczak](http://www.linkedin.com/in/czarektomczak) in 2012 to provide python bindings for the [Chromium Embedded Framework](https://bitbucket.org/chromiumembedded/cef). See the growing list of [applications using CEF](http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF) on wikipedia. Examples of embedding CEF browser are available for many popular GUI toolkits including: [wxPython](../../wiki/wxPython), [PyGTK](../../wiki/PyGTK), [PyQt](../../wiki/PyQt), [PySide](../../wiki/PySide), [Kivy](../../wiki/Kivy), [Panda3D](../../wiki/Panda3D) and [PyWin32](src/windows/binaries_32bit/pywin32.py). |
27 | | - |
28 | | -Some use cases for CEF: |
29 | | - |
30 | | -* Embed a web browser control with great HTML5 support (based on Chromium) |
31 | | -* Use it to create a HTML5 based GUI in an application. This can act as a replacement for GUI toolkits like wxWidgets/Qt/Gtk. For native communication between javascript and python use [javascript bindings](../../wiki/JavascriptBindings). Another option is to run an internal python web server and use websockets/XMLHttpRequest for js<>python communication. This way you can write a desktop app in the same way you write web apps. |
32 | | -* Render web content off-screen in applications that use custom drawing frameworks. See the [Kivy](../../wiki/Kivy) and [Panda3D](../../wiki/Panda3D) examples. |
33 | | -* Use it for automated testing of existing web applications. Use it for web scraping, or as a web crawler or other kind of internet bots. |
34 | | - |
35 | | - |
36 | | -## Compatibility |
37 | | - |
38 | | -* Supported Python versions: 2.7. For Python 3.4 / 3.5 support see [Issue #121](../../issues/121). |
39 | | -* Supported platforms: Windows, Linux, Mac. Both 32bit and 64bit binaries are available for all platforms. |
40 | | - |
41 | | - |
42 | | -## Downloads |
43 | | - |
44 | | -On Win/Mac you can install from PyPI using this command: |
45 | | -`pip install cefpython3`. |
46 | | - |
47 | | -* For Windows: see the [Download_CEF3_Windows](../../wiki/Download_CEF3_Windows) wiki page. |
48 | | -* For Linux: see the [Download_CEF3_Linux](../../wiki/Download_CEF3_Linux) wiki page. |
49 | | -* For Mac: see the [Download_CEF3_Mac](../../wiki/Download_CEF3_Mac) wiki page. |
50 | | - |
51 | | -__New releases RSS/Atom feed__<br> |
52 | | -To be notified of new releases subscribe to this [Atom feed](https://github.com/cztomczak/cefpython/releases.atom). |
| 15 | +CEF Python is an open source project founded by [Czarek Tomczak] |
| 16 | +(http://www.linkedin.com/in/czarektomczak) |
| 17 | +in 2012 to provide python bindings for the [Chromium Embedded Framework] |
| 18 | +(https://bitbucket.org/chromiumembedded/cef). |
| 19 | +See the growing list of [applications using CEF] |
| 20 | +(http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF) |
| 21 | +on wikipedia. Examples of embedding CEF browser are available for many |
| 22 | +popular GUI toolkits including: wxPython, PyGTK, PyQt, PySide, Kivy, |
| 23 | +Panda3D, PyWin32 and PyGame/PyOpenGL. |
| 24 | + |
| 25 | +There are many use cases for CEF. You can embed a web browser control |
| 26 | +based on Chromium with great HTML 5 support. You can use it to create |
| 27 | +a HTML 5 based GUI in an application, this can act as a replacement for |
| 28 | +standard GUI toolkits like wxWidgets, Qt or GTK. You can render web |
| 29 | +content off-screen in application that use custom drawing frameworks. |
| 30 | +You can use it for automated testing of existing applications. You can |
| 31 | +use it for web scraping or as a web crawler, or other kind of internet |
| 32 | +bots. |
| 33 | + |
| 34 | + |
| 35 | +## Versions |
| 36 | + |
| 37 | +### v50+ releases |
| 38 | + |
| 39 | +1. Can be installed on all platforms using `pip install` command |
| 40 | +2. Downloads are available on [GitHub Releases](../../releases) pages |
| 41 | +2. Windows support: 32-bit, Python 2.7 |
| 42 | +3. Linux support: 64-bit, Python 2.7 / 3.4 / 3.5 / 3.6 |
| 43 | +4. Mac support: 64-bit, Python 2.7 / 3.4 / 3.5 / 3.6 |
| 44 | +5. Documentation is in the [docs/](docs) directory |
| 45 | +6. API reference is in the [api/](api) directory |
| 46 | +7. Additional documentation is in issues labelled [Knowledge Base] |
| 47 | + (../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22) |
| 48 | + |
| 49 | +### v31 release |
| 50 | + |
| 51 | +1. Downloads are available on [wiki pages](../../wiki#downloads) |
| 52 | + and on GH Releases tagged [v31.2](../../releases/tag/v31.2) |
| 53 | +2. Supports only Python 2.7 |
| 54 | +3. Windows support: 32-bit and 64-bit |
| 55 | +4. Linux support: 32-bit and 64-bit |
| 56 | +5. Mac support: 32-bit and 64-bit |
| 57 | +6. Documentation is on [wiki pages](../../wiki) |
| 58 | +7. API reference is available in revision [169a1b2] |
| 59 | + (../../tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api) |
53 | 60 |
|
54 | 61 |
|
55 | 62 | ## Support |
56 | 63 |
|
57 | | -* Documentation: |
58 | | - * See [API docs](api/) in the api/ directory |
59 | | - * See [Wiki Pages](../../wiki) |
60 | | - * See issues with the [Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22) |
61 | | - label |
62 | | -* Ask questions and report problems on the |
63 | | - [Forum](https://groups.google.com/group/cefpython) |
64 | | -* Please do not ask questions in the Issue Tracker |
65 | | - |
66 | | - |
67 | | -## Changes in API during updates |
68 | | - |
69 | | -CEF Python depends on CEF and API breaks are inevitable when updating |
70 | | -to a newer CEF. When updating cefpython to a new version go to the |
71 | | -[GitHub Releases](https://github.com/cztomczak/cefpython/releases) page |
72 | | -and check release notes for all the releases that appeared between |
73 | | -your old version and the new version. Look for lists named |
74 | | -"Changes in API that break backward compatibility". |
75 | | - |
76 | | - |
77 | | -## Donate |
78 | | - |
79 | | -If you would like to support general CEF Python development efforts by making a donation see the [Donations](../../wiki/Donations) wiki page. |
| 64 | +- Ask questions and report problems on the [Forum] |
| 65 | + (https://groups.google.com/group/cefpython) |
| 66 | +- Documentation is in the [docs/](docs) directory |
| 67 | +- API reference is in the [api/](api) directory |
| 68 | +- Additional documentation is in issues labelled [Knowledge Base] |
| 69 | + (../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22) |
| 70 | +- Wiki pages are deprecated and for v31 only |
| 71 | + |
| 72 | + |
| 73 | +## Support development |
| 74 | + |
| 75 | +If you would like to support general CEF Python development efforts |
| 76 | +by making a donation please click the Paypal Donate button: |
| 77 | + |
| 78 | +<a href='https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V7LU7PD4N4GGG'> |
| 79 | +<img src='https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/donate.gif' /> |
| 80 | +</a> |
| 81 | + |
| 82 | +At this time CEF Python is unable to accept donations that sponsor the |
| 83 | +development of specific features. However you can make a donation with |
| 84 | +a comment that you would like to see some feature implemented and it will |
| 85 | +give it a higher priority. |
| 86 | + |
| 87 | +If you are interested in sponsorship opportunities please contact Czarek |
| 88 | +directly. |
| 89 | + |
| 90 | +### Thanks |
| 91 | + |
| 92 | +* Many thanks to [ClearChat Inc.](https://clearchat.com) for sponsoring |
| 93 | + the v55/v56 releases for all platforms |
| 94 | +* Thanks to JetBrains for providing an Open Source license for |
| 95 | + [PyCharm](https://www.jetbrains.com/pycharm/) |
| 96 | +* Thanks to those who have made a Paypal donation: [Rentouch GmbH] |
| 97 | + (http://www.rentouch.ch/), Walter Purvis, Rokas Stupuras, Alex Rattray, |
| 98 | + Greg Kacy, Paul Korzhyk |
| 99 | +* Lots of thanks goes to [Cyan Inc.](http://www.blueplanet.com/) for |
| 100 | + sponsoring this project for a long time, making CEF Python 3 mature |
| 101 | +* Thanks to those who have donated their time through code contributions, |
| 102 | + they are listed in the [Authors](Authors) file |
| 103 | +* Thanks to Adam Duston for donating a Macbook to aid the development |
| 104 | + of Mac port |
| 105 | +* Thanks to [Rentouch GmbH](http://www.rentouch.ch/) for sponsoring the |
| 106 | + development of the off-screen rendering support |
| 107 | +* Thanks to Thomas Wusatiuk for sponsoring the development of the web |
| 108 | + response reading features |
0 commit comments