|
2 | 2 |
|
3 | 3 | Table of contents: |
4 | 4 | * [Introduction](#introduction) |
5 | | -* [Latest releases sponsored by](#latest-releases-sponsored-by) |
6 | | - * [Thanks to all sponsors](#thanks-to-all-sponsors) |
7 | 5 | * [Install](#install) |
8 | | -* [Tutorial](#tutorial) |
9 | 6 | * [Examples](#examples) |
10 | 7 | * [Support](#support) |
11 | | -* [Releases](#releases) |
12 | | - * [Next release](#next-release) |
13 | | - * [Latest release](#latest-release) |
14 | | - * [v49 release (WinXP/Vista)](#v49-release-winxpvista) |
15 | | - * [v31 release (old systems)](#v31-release-old-systems) |
16 | 8 | * [Support development](#support-development) |
17 | | - * [Thanks to all](#thanks-to-all) |
18 | | -* [Seeking new sponsors](#seeking-new-sponsors) |
19 | | -* [Other READMEs](#other-readmes) |
20 | | -* [Quick links](#quick-links) |
| 9 | +* [Seeking sponsors](#seeking-sponsors) |
| 10 | +* [API](#api) |
21 | 11 |
|
22 | 12 |
|
23 | 13 | ## Introduction |
@@ -49,39 +39,82 @@ frameworks such as PyQt, wxPython, PyGTK, PyGObject, Tkinter, Kivy, Panda3D, |
49 | 39 | PyGame, PyOpenGL, PyWin32, PySide and PySDL2. |
50 | 40 |
|
51 | 41 |
|
52 | | -## Latest releases sponsored by |
| 42 | +## Install |
53 | 43 |
|
54 | | -<table border="0"><tr> |
55 | | -<td width="50%" valign="top"> |
| 44 | +You can install [pypi/cefpython3](https://pypi.python.org/pypi/cefpython3) |
| 45 | +package using pip tool. On Linux pip 8.1+ is required. You can |
| 46 | +also download packages for offline installation available on the |
| 47 | +[GitHub Releases](../../releases) pages. Command to install with pip: |
56 | 48 |
|
57 | | -<p align="center"> |
58 | | - <a href="https://www.fivestars.com/"> |
59 | | - <img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/fivestars360.png"> |
60 | | - </a> |
61 | | -</p> |
| 49 | +``` |
| 50 | +pip install cefpython3==66.1 |
| 51 | +``` |
62 | 52 |
|
63 | | -Thank you to Fivestars for sponsoring the [v66.1 release](../../releases/tag/v66.1) |
64 | | -with Python 3.8 / 3.9 support. Fivestars helps local communities thrive by empowering |
65 | | -small businesses with cutting edge marketing technology. Please visit their website: |
66 | | -<a href="https://www.fivestars.com/">Fivestars.com</a> |
| 53 | +Below is a table with supported platforms, python versions and architectures. |
67 | 54 |
|
68 | | -</td><td width="50%" valign="top"> |
| 55 | +OS | Py2 | Py3 | 32bit | 64bit | Requirements |
| 56 | +--- | --- | --- | --- | --- | --- |
| 57 | +Windows | 2.7 | 3.4 / 3.5 / 3.6 / 3.7 / 3.8 / 3.9 | Yes | Yes | Windows 7+ (Note that Python 3.9 supports Windows 8.1+) |
| 58 | +Linux | 2.7 | 3.4 / 3.5 / 3.6 / 3.7 | Yes | Yes | Debian 8+, Ubuntu 14.04+,<br> Fedora 24+, openSUSE 13.3+ |
| 59 | +Mac | 2.7 | 3.4 / 3.5 / 3.6 / 3.7 | No | Yes | MacOS 10.9+ |
69 | 60 |
|
70 | | -<p align="center"> |
71 | | - <a href="https://lampix.com/"> |
72 | | - <img src="https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/lampix360.png"> |
73 | | - </a> |
74 | | -</p> |
75 | 61 |
|
76 | | -Thank you to Lampix for sponsoring the |
77 | | -[v66 release](../../releases/tag/v66.0). Lampix is the first hardware |
78 | | -and software solution that turns any surface into a smart, augmented reality |
79 | | -or interactive surface. Please visit their website: |
80 | | -<a href="https://lampix.com/">Lampix.com</a> |
| 62 | +## Examples |
| 63 | + |
| 64 | +- [Tutorial](docs/Tutorial.md) |
| 65 | +- [All examples](examples/README-examples.md). |
| 66 | +- [Snippets](examples/snippets/README-snippets.md). |
| 67 | +- [PyInstaller packager](examples/pyinstaller/README-pyinstaller.md). |
81 | 68 |
|
82 | | -</tr></table> |
83 | 69 |
|
84 | | -### Thanks to all sponsors |
| 70 | +## Support |
| 71 | + |
| 72 | +- Ask questions and report problems on the |
| 73 | + [Forum](https://groups.google.com/group/cefpython) |
| 74 | +- Supported examples are listed in the |
| 75 | + [README-examples.md](examples/README-examples.md) file |
| 76 | +- Documentation is in the [docs/](docs) directory: |
| 77 | + - [Build instructions](docs/Build-instructions.md) |
| 78 | + - [Contributing code](docs/Contributing-code.md) |
| 79 | + - [Knowledge Base](docs/Knowledge-Base.md) |
| 80 | + - [Migration guide](docs/Migration-guide.md) |
| 81 | + - [Tutorial](docs/Tutorial.md) |
| 82 | +- API reference is in the [api/](api) directory: |
| 83 | + - [API categories](api/API-categories.md#api-categories) |
| 84 | + - [API index](api/API-index.md#api-index) |
| 85 | +- Additional documentation is available in |
| 86 | + [Issues labelled Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22) |
| 87 | +- To search documentation use GitHub "This repository" search |
| 88 | + at the top. To narrow results to documentation only select |
| 89 | + "Markdown" in the right pane. |
| 90 | +- You can vote on issues in the tracker to let us know which issues are |
| 91 | + important to you. To do that add a +1 thumb up reaction to the first post |
| 92 | + in the issue. See |
| 93 | + [Most popular issues](../../issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) |
| 94 | + sorted by reactions. |
| 95 | + |
| 96 | + |
| 97 | +## Support development |
| 98 | + |
| 99 | +If you would like to support general CEF Python development efforts |
| 100 | +by making a donation then please click the Paypal Donate button below. |
| 101 | + |
| 102 | +<a href='https://www.paypal.com/donate/?hosted_button_id=V7LU7PD4N4GGG'> |
| 103 | +<img src='https://raw.githubusercontent.com/wiki/cztomczak/phpdesktop/donate.gif' /> |
| 104 | +</a><br><br> |
| 105 | + |
| 106 | + |
| 107 | +## Seeking sponsors |
| 108 | + |
| 109 | +CEF Python is seeking companies to sponsor development of this project. Most important |
| 110 | +thing would be to have continuous monthly releases with updates to latest Chromium. There is |
| 111 | +also lots of cool features and new settings that would be nice to implement. We have not yet |
| 112 | +exposed all of upstream CEF APIs. If your company would like to sponsor CEF Python development efforts |
| 113 | +then please contact [Czarek](https://www.linkedin.com/in/czarektomczak/). There are no active sponsors |
| 114 | +at this moment. |
| 115 | + |
| 116 | + |
| 117 | +### Previous sponsors |
85 | 118 |
|
86 | 119 | <table> |
87 | 120 | <tr> |
@@ -139,209 +172,7 @@ or interactive surface. Please visit their website: |
139 | 172 | </table> |
140 | 173 |
|
141 | 174 |
|
142 | | -## Install |
143 | | - |
144 | | -You can install [pypi/cefpython3](https://pypi.python.org/pypi/cefpython3) |
145 | | -package using pip tool. On Linux pip 8.1+ is required. You can |
146 | | -also download packages for offline installation available on the |
147 | | -[GitHub Releases](../../releases) pages. Command to install with pip: |
148 | | - |
149 | | -``` |
150 | | -pip install cefpython3==66.1 |
151 | | -``` |
152 | | - |
153 | | - |
154 | | -## Tutorial |
155 | | - |
156 | | -See the [Tutorial.md](docs/Tutorial.md) document. |
157 | | - |
158 | | - |
159 | | -## Examples |
160 | | - |
161 | | -See the [README-examples.md](examples/README-examples.md) and |
162 | | -[README-snippets.md](examples/snippets/README-snippets.md) documents. |
163 | | - |
164 | | - |
165 | | -## Support |
166 | | - |
167 | | -- Ask questions and report problems on the |
168 | | - [Forum](https://groups.google.com/group/cefpython) |
169 | | -- Supported examples are listed in the |
170 | | - [README-examples.md](examples/README-examples.md) file |
171 | | -- Documentation is in the [docs/](docs) directory: |
172 | | - - [Build instructions](docs/Build-instructions.md) |
173 | | - - [Contributing code](docs/Contributing-code.md) |
174 | | - - [Knowledge Base](docs/Knowledge-Base.md) |
175 | | - - [Migration guide](docs/Migration-guide.md) |
176 | | - - [Tutorial](docs/Tutorial.md) |
177 | | -- API reference is in the [api/](api) directory: |
178 | | - - [API categories](api/API-categories.md#api-categories) |
179 | | - - [API index](api/API-index.md#api-index) |
180 | | -- Additional documentation is available in |
181 | | - [Issues labelled Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22) |
182 | | -- To search documentation use GitHub "This repository" search |
183 | | - at the top. To narrow results to documentation only select |
184 | | - "Markdown" in the right pane. |
185 | | -- You can vote on issues in the tracker to let us know which issues are |
186 | | - important to you. To do that add a +1 thumb up reaction to the first post |
187 | | - in the issue. See |
188 | | - [Most popular issues](../../issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) |
189 | | - sorted by reactions. |
190 | | - |
191 | | - |
192 | | -## Releases |
193 | | - |
194 | | -Information on planned new and current releases, supported platforms, |
195 | | -python versions, architectures and requirements. If you want to |
196 | | -support old operating systems then choose the v31 release. |
197 | | - |
198 | | -### Next release |
199 | | - |
200 | | -- To see planned new features or bugs to be fixed in the near future in one of |
201 | | - next releases, see the |
202 | | - [next release](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22next+release%22) |
203 | | - label in the tracker |
204 | | -- To see planned new features or bugs to be fixed in further future, see the |
205 | | - [next release 2](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22next+release+2%22) |
206 | | - label in the tracker |
207 | | - |
208 | | -### Latest release |
209 | | - |
210 | | -OS | Py2 | Py3 | 32bit | 64bit | Requirements |
211 | | ---- | --- | --- | --- | --- | --- |
212 | | -Windows | 2.7 | 3.4 / 3.5 / 3.6 / 3.7 / 3.8 / 3.9 | Yes | Yes | Windows 7+ (Note that Python 3.9 supports Windows 8.1+) |
213 | | -Linux | 2.7 | 3.4 / 3.5 / 3.6 / 3.7 | Yes | Yes | Debian 8+, Ubuntu 14.04+,<br> Fedora 24+, openSUSE 13.3+ |
214 | | -Mac | 2.7 | 3.4 / 3.5 / 3.6 / 3.7 | No | Yes | MacOS 10.9+ |
215 | | - |
216 | | -These platforms are not supported yet: |
217 | | -- ARM - see [Issue #267](../../issues/267) |
218 | | -- Android - see [Issue #307](../../issues/307) |
219 | | - |
220 | | - |
221 | | -### v49 release (WinXP/Vista) |
222 | | - |
223 | | -OS | Py2 | Py3 | 32bit | 64bit | Requirements |
224 | | ---- | --- | --- | --- | --- | --- |
225 | | -Windows | 2.7 | 3.4 | Yes | Yes | Windows XP+ |
226 | | - |
227 | | -- Install with command: `pip --no-cache-dir install cefpython3==49.0`. |
228 | | - - Please note that if you were previously installing cefpython3 |
229 | | - package it is required to use the `--no-cache-dir` flag, |
230 | | - otherwise pip will end up with error message |
231 | | - `No matching distribution found for cefpython3==49.0`. |
232 | | - This happens because 49.0 release occured after 57.0 and 66.0 |
233 | | - releases. |
234 | | -- Downloads are available on GitHub Releases tagged |
235 | | - [v49.0](../../releases/tag/v49.0). |
236 | | -- See [Migration guide](docs/Migration-guide.md) document for changes |
237 | | - in this release |
238 | | -- Documentation is available in the [docs/](../../tree/cefpython49-winxp/docs) |
239 | | - directory in the `cefpython49-winxp` branch |
240 | | -- API reference is available in the [api/](../../tree/cefpython49-winxp/api) |
241 | | - directory in the `cefpython49-winxp` branch |
242 | | - |
243 | | - |
244 | | -### v31 release (old systems) |
245 | | - |
246 | | -OS | Py2 | Py3 | 32bit | 64bit | Requirements |
247 | | ---- | --- | --- | --- | --- | --- |
248 | | -Windows | 2.7 | No | Yes | Yes | Windows XP+ |
249 | | -Linux | 2.7 | No | Yes | Yes | Debian 7+ / Ubuntu 12.04+ |
250 | | -Mac | 2.7 | No | Yes | Yes | MacOS 10.7+ |
251 | | - |
252 | | -Additional information for v31.2 release: |
253 | | -- On Windows/Mac you can install with command: `pip install cefpython3==31.2` |
254 | | -- Downloads are available on the GitHub Releases page tagged |
255 | | - [v31.2](../../releases/tag/v31.2). |
256 | | -- API reference is available in revision [169a1b2](../../tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api) |
257 | | -- Other documentation can be downloaded by cloning the |
258 | | - cefpython.wiki repository: `git clone git@github.com:cztomczak/cefpython.wiki.git` |
259 | | - |
260 | | - |
261 | | -## Support development |
262 | | - |
263 | | -If you would like to support general CEF Python development efforts |
264 | | -by making a donation then please click the Paypal Donate button below. |
265 | | -If you would like to see a specific feature implemented then you can make |
266 | | -a comment about that when making a donation and that will give it a higher |
267 | | -priority. |
268 | | - |
269 | | -<a href='https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V7LU7PD4N4GGG'> |
270 | | -<img src='https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/donate.gif' /> |
271 | | -</a><br><br> |
272 | | - |
273 | | - |
274 | | -### Thanks to all |
275 | | - |
276 | | -* [2021] Thank you to [Fivestars](https://www.fivestars.com/) for sponsoring |
277 | | - the v66.1 release with Python 3.8 / 3.9 support |
278 | | -* [2018] Thanks to [Fivestars](https://www.fivestars.com/) for sponsoring |
279 | | - the v49 release for legacy systems (WinXP/Vista) |
280 | | -* [2018] Many thanks to [Lampix](https://lampix.com/) for sponsoring the v66 |
281 | | - release for all platforms |
282 | | -* [2017] Many thanks to [HighSide Inc.](https://highside.io/) for sponsoring |
283 | | - the v55/v56 releases for all platforms |
284 | | -* [2016-2018] Thanks to JetBrains for providing an Open Source license for |
285 | | - [PyCharm](https://www.jetbrains.com/pycharm/) |
286 | | -* [2014] Thanks to Adam Duston for donating a Macbook to aid the development |
287 | | - of Mac port |
288 | | -* [2013-2015] Lots of thanks goes to [Cyan Inc.](http://www.blueplanet.com/) |
289 | | - for sponsoring this project for a long time, making CEF Python 3 mature |
290 | | -* [2013] Thanks to [Rentouch GmbH](http://www.rentouch.ch/) for sponsoring the |
291 | | - development of the off-screen rendering support |
292 | | -* [2013] Thanks to Thomas Wusatiuk for sponsoring the development of the web |
293 | | - response reading features |
294 | | -* [2012-2018] Thanks to those who have made a Paypal donation: |
295 | | - [Rentouch GmbH](http://www.rentouch.ch/), Walter Purvis, Rokas Stupuras, |
296 | | - Alex Rattray, Greg Kacy, Paul Korzhyk, Tomasz Tomanek. |
297 | | -* [2012-2017] Thanks to those who have donated their time through code |
298 | | - contributions, they are listed in the [Authors](Authors) file |
299 | | - |
300 | | - |
301 | | -## Seeking new sponsors |
302 | | - |
303 | | -CEF Python is seeking companies to sponsor further development of the project. |
304 | | -There are many proposals for new features submitted in the issue tracker. Most |
305 | | -notable are: |
306 | | - |
307 | | -* Monthly releases with latest Chromium |
308 | | -* An automated build system similar to upstream CEF Spotify Automated Builds |
309 | | -* ARM and Android support |
310 | | -* Multi-threaded support for increased performance |
311 | | -* Proprietary codecs support in build tools: H264, H265,AC3, EAC3, MPEG-4 |
312 | | -* More CEF API exposed, only about 50% is exposed so far |
313 | | -* Hundreds of new settings and Chromium preferences not yet exposed |
314 | | -* Easier integration with popular GUI toolkits in just a few lines of code |
315 | | - and support for more third party GUI frameworks |
316 | | -* More examples of implementing various advanced features and more snippets |
317 | | - as well |
318 | | - |
319 | | -If your company would like to sponsor CEF Python development efforts then |
320 | | -please contact |
321 | | -[Czarek](https://www.linkedin.com/in/czarektomczak/). |
322 | | -Long term sponsorships are welcome and Czarek is open to ideas about |
323 | | -the project. He would love to spend more time on developing this project, |
324 | | -but he can't afford doing so in his free time. Currently there is no company |
325 | | -supporting this project actively on a daily basis. |
326 | | - |
327 | | - |
328 | | -## Other READMEs |
329 | | - |
330 | | -- [PyInstaller packager](examples/pyinstaller/README-pyinstaller.md) |
331 | | - |
332 | | - |
333 | | - |
334 | | -## Quick links |
335 | | - |
336 | | -### Docs |
337 | | - |
338 | | -- [Build instructions](docs/Build-instructions.md) |
339 | | -- [Knowledge Base](docs/Knowledge-Base.md) |
340 | | -- [Migration guide](docs/Migration-guide.md) |
341 | | -- [Tutorial](docs/Tutorial.md) |
342 | | - |
343 | | - |
344 | | -### API categories |
| 175 | +## API |
345 | 176 |
|
346 | 177 | #### Modules |
347 | 178 |
|
|
0 commit comments