X Tutup
Skip to content

Commit 2fed321

Browse files
committed
Rewrite whole README.md, make it brief and less confusing...
Information on versions: v50+ vs v31. Add Support development section. Thanks to ClearChat Inc for sponsoring v55/56 releases. Also update TOCs in API docs.
1 parent 8ffac63 commit 2fed321

File tree

3 files changed

+77
-113
lines changed

3 files changed

+77
-113
lines changed

README.md

Lines changed: 76 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -1,132 +1,96 @@
11
# CEF Python
22

3-
[![](https://img.shields.io/badge/python-2.7-yellow.png "Python versions supported")](https://github.com/cztomczak/cefpython#cef-python)
4-
[![](https://img.shields.io/badge/release-v31.2-orange.png "GitHub latest release")](https://github.com/cztomczak/cefpython/releases/latest)
5-
[![](https://img.shields.io/badge/pypi-v31.2-blue.png "PyPI latest release")](https://pypi.python.org/pypi/cefpython3/)
6-
[![](https://img.shields.io/badge/commits%20since-v31.2-lightgray.png "Commits since v31.2 release")](https://github.com/cztomczak/cefpython/compare/05366f2...master)
7-
83
Table of contents:
9-
* [Important notes](#important-notes)
104
* [Introduction](#introduction)
11-
* [Compatibility](#compatibility)
12-
* [Downloads](#downloads)
5+
* [Information on versions](#information-on-versions)
6+
* [v50+ releases](#v50-releases)
7+
* [v31 release](#v31-release)
138
* [Support](#support)
14-
* [Notifications on new releases](#notifications-on-new-releases)
15-
* [Changes in API during updates](#changes-in-api-during-updates)
16-
* [Donate](#donate)
17-
18-
19-
## Important notes
20-
21-
* Branches cefpython51/52/53+ with latest Chrome are tested and work only
22-
on Linux currently. Instructions for building these are
23-
in docs/[Build-instructions.md](docs/Build-instructions.md).
24-
Beta downloads are available on the [Github Releases](../../releases) page.
25-
Pre-releases are also available on PyPI.
26-
* The last stable release that works on all platforms is in the cefpython31
27-
branch. Downloads for this branch are available on wiki pages. Up-to-date
28-
API docs for the cefpython31 branch can be viewed in commit
29-
[169a1b2](https://github.com/cztomczak/cefpython/tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api).
30-
* Repository rewritten on 2016-02-15 to reduce its size. Please clone it again.
9+
* [Support development](#support-development)
10+
* [Thanks](#thanks)
3111

3212

3313
## Introduction
3414

35-
CEF Python is an open source project founded by
36-
[Czarek Tomczak](http://www.linkedin.com/in/czarektomczak)
37-
in 2012 to provide python bindings for the
38-
[Chromium Embedded Framework](https://bitbucket.org/chromiumembedded/cef).
39-
See the growing list of
40-
[applications using CEF](http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF)
41-
on wikipedia. Examples of embedding CEF browser are available for many popular
42-
GUI toolkits including: [wxPython](../../wiki/wxPython),
43-
[PyGTK](../../wiki/PyGTK), [PyQt](../../wiki/PyQt),
44-
[PySide](../../wiki/PySide), [Kivy](../../wiki/Kivy),
45-
[Panda3D](../../wiki/Panda3D)
46-
and [PyWin32](src/windows/binaries_32bit/pywin32.py).
47-
48-
Some use cases for CEF:
15+
CEF Python is an open source project founded by [Czarek Tomczak](http://www.linkedin.com/in/czarektomczak)
16+
in 2012 to provide python bindings for the [Chromium Embedded Framework](https://bitbucket.org/chromiumembedded/cef).
17+
See the growing list of [applications using CEF](http://en.wikipedia.org/wiki/Chromium_Embedded_Framework#Applications_using_CEF)
18+
on wikipedia. Examples of embedding CEF browser are available for many
19+
popular GUI toolkits including: wxPython, PyGTK, PyQt, PySide, Kivy,
20+
Panda3D, PyWin32 and PyGame/PyOpenGL.
4921

50-
* Embed a web browser control with great HTML5 support (based on Chromium)
51-
* Use it to create a HTML5 based GUI in an application. This can act as a
52-
replacement for GUI toolkits like wxWidgets/Qt/Gtk. For native communication
53-
between javascript and python use
54-
[javascript bindings](api/JavascriptBindings.md).
55-
Another option is to run an internal python web server and use
56-
websockets/XMLHttpRequest for js<>python communication. This way you
57-
can write a desktop app in the same way you write web apps.
58-
* Render web content off-screen in applications that use custom drawing
59-
frameworks. See the [Kivy](../../wiki/Kivy)
60-
and [Panda3D](../../wiki/Panda3D) examples.
61-
* Use it for automated testing of existing web applications. Use it for web
62-
scraping, or as a web crawler or other kind of internet bots.
22+
There are many use cases for CEF. You can embed a web browser control
23+
based on Chromium with great HTML 5 support. You can use it to create
24+
a HTML 5 based GUI in an application, this can act as a replacement for
25+
standard GUI toolkits like wxWidgets, Qt or GTK. You can render web
26+
content off-screen in application that use custom drawing frameworks.
27+
You can use it for automated testing of existing applications. You can
28+
use it for web scraping or as a web crawler, or other kind of internet
29+
bots.
6330

6431

65-
## Compatibility
32+
## Information on versions
6633

67-
* Supported Python versions: 2.7
68-
(for Python 3.4 / 3.5 support see [Issue #121](../../issues/121)).
69-
* Supported platforms: Windows, Linux, Mac.<br>
70-
Both 32-bit and 64-bit binaries are available for all platforms.
34+
### v50+ releases
7135

36+
1. Can be installed on all platforms using `pip install` command
37+
2. Downloads are available on [GitHub Releases](../../releases) pages
38+
2. Windows support: 32-bit, Python 2.7
39+
3. Linux support: 64-bit, Python 2.7 / 3.4 / 3.5 / 3.6
40+
4. Mac support: 64-bit, Python 2.7
41+
5. Documentation is in the [docs/](docs) directory
42+
6. API reference is in the [api/](api) directory
7243

73-
## Downloads
44+
### v31 release
7445

75-
On Win/Mac you can install from PyPI using this command:
76-
`pip install cefpython3`.
77-
78-
* For Windows: see the
79-
[Download_CEF3_Windows](../../wiki/Download_CEF3_Windows) wiki page.
80-
* For Linux: see the
81-
[Download_CEF3_Linux](../../wiki/Download_CEF3_Linux) wiki page.
82-
* For Mac: see the
83-
[Download_CEF3_Mac](../../wiki/Download_CEF3_Mac) wiki page.
84-
85-
To be notified when new downloads are available see the
86-
[Notifications on new releases](#notifications-on-new-releases) section.
46+
1. Downloads are available on [wiki pages](../../wiki#downloads)
47+
2. Supports only Python 2.7
48+
3. Windows support: 32-bit and 64-bit
49+
4. Linux support: 32-bit and 64-bit
50+
5. Mac support: 32-bit and 64-bit
51+
6. Documentation is on [wiki pages](../../wiki)
52+
7. API reference is available in commit [169a1b2](../../tree/169a1b20d3cd09879070d41aab28cfa195d2a7d5/docs/api)
8753

8854

8955
## Support
9056

91-
* Documentation:
92-
* See [API docs](api/) in the api/ directory
93-
* See [Wiki Pages](../../wiki)
94-
* See issues with the
95-
[Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
96-
label
97-
* Ask questions and report problems on the
98-
[Forum](https://groups.google.com/group/cefpython)
99-
* Please do not ask questions in the Issue Tracker
100-
101-
102-
## Notifications on new releases
103-
104-
To be notified of new releases subscribe to this
105-
[RSS/Atom feed](https://github.com/cztomczak/cefpython/releases.atom).
106-
107-
Announcements are also made on the
108-
[Forum](https://groups.google.com/d/forum/cefpython).
109-
To be notified of these via email set your Membership and Email settings
110-
and change delivery preference to Daily summaries.
111-
112-
113-
## Changes in API during updates
114-
115-
CEF Python depends on CEF and API breaks are inevitable when updating
116-
to a newer CEF. When updating cefpython to a new version go to the
117-
[GitHub Releases](https://github.com/cztomczak/cefpython/releases) page
118-
and check release notes for all the releases that appeared between
119-
your old version and the new version. Look for lists named
120-
"Changes in API that break backward compatibility".
121-
122-
Due to unavoidable changes in API it is recommended for your setup scripts
123-
that use for example PIP to install the cefpython3 package, to hardcode
124-
the cefpython version string. If for example using PIP's requirements.txt
125-
file then list the cefpython3 package in the following format:
126-
`cefpython3 == 31.2`.
127-
128-
129-
## Donate
130-
131-
If you would like to support general CEF Python development efforts by
132-
making a donation see the [Donations](../../wiki/Donations) wiki page.
57+
- Ask questions and report problems on the [Forum](https://groups.google.com/group/cefpython)
58+
- Documentation is in the [docs/](docs) directory
59+
- API reference is in the [api/](api) directory
60+
- See issues labelled [Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
61+
- Wiki pages are deprecated and for v31 only
62+
63+
64+
## Support development
65+
66+
If you would like to support general CEF Python development efforts
67+
by making a donation please click the Paypal Donate button:
68+
69+
<a href='https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V7LU7PD4N4GGG'><img src='https://raw.githubusercontent.com/wiki/cztomczak/cefpython/images/donate.gif' /></a>
70+
71+
At this time CEF Python is unable to accept donations that sponsor the
72+
development of specific features. However you can make a donation with
73+
a comment that you would like to see some feature implemented and it will
74+
give it a higher priority.
75+
76+
If you are interested in sponsorship opportunities please contact Czarek
77+
directly.
78+
79+
### Thanks
80+
81+
* Many thanks to [ClearChat Inc.](https://clearchat.com) for sponsoring
82+
the v55/v56 releases for all platforms
83+
* Thanks to JetBrains for providing an Open Source license for
84+
[PyCharm](https://www.jetbrains.com/pycharm/)
85+
* Thanks to those who have made a Paypal donation: [Rentouch GmbH](http://www.rentouch.ch/),
86+
Walter Purvis, Rokas Stupuras, Alex Rattray, Greg Kacy, Paul Korzhyk
87+
* Lots of thanks goes to [Cyan Inc.](http://www.blueplanet.com/) for
88+
sponsoring this project for a long time, making CEF Python 3 mature
89+
* Thanks to those who have donated their time through code contributions,
90+
they are listed in the [Authors](Authors) file
91+
* Thanks to Adam Duston for donating a Macbook to aid the development
92+
of Mac port
93+
* Thanks to [Rentouch GmbH](http://www.rentouch.ch/) for sponsoring the
94+
development of the off-screen rendering support
95+
* Thanks to Thomas Wusatiuk for sponsoring the development of the web
96+
response reading features

api/ApplicationSettings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Table of contents:
1616
* [context_menu](#context_menu)
1717
* [downloads_enabled](#downloads_enabled)
1818
* [external_message_pump](#external_message_pump)
19+
* [framework_dir_path](#framework_dir_path)
1920
* [ignore_certificate_errors](#ignore_certificate_errors)
2021
* [javascript_flags](#javascript_flags)
2122
* [locale](#locale)

api/BrowserSettings.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Table of contents:
1111
* [accept_language_list](#accept_language_list)
1212
* [application_cache_disabled](#application_cache_disabled)
1313
* [background_color](#background_color)
14-
* [caret_browsing_enabled](#caret_browsing_enabled)
1514
* [databases_disabled](#databases_disabled)
1615
* [default_encoding](#default_encoding)
1716
* [dom_paste_disabled](#dom_paste_disabled)

0 commit comments

Comments
 (0)
X Tutup