InternalDevelopment - rentouch/cefpython GitHub Wiki

Track project updates

To track Git commits subscribe to this RSS feed or just watch the project and be notified via email or GitHub site.

Recommended software

Markdownd editor:

• You can easily edit markdown pages with Atom editor and the markdown-preview plugin. You can clone wiki locally using this url.

Git clients:

• GitHub Desktop - https://windows.github.com/ - easy "Sync" button, love it!
• Tortoise Git for Windows - https://code.google.com/p/tortoisegit/ - nice explorer context menu tools
• SourceTreeApp - http://www.sourcetreeapp.com/ - integrates good with bitbucket (upstream CEF)
• GIT GUI, Git Bash - included in explorer context menu with with Git for Windows

Python and Cython IDE:

• LiClipse (PyDev) - http://www.liclipse.com/ - it's awesome!
• For Submlime Text 3 editor use the Cython syntax highlighting and CTags plugins.

Build instructions

See build instructions on these wiki pages:

• BuildOnWindows
• BuildOnLinux
• BuildOnMac

Python/Cython style guidelines

• try to comply with the PEP 8 style guide
• use 4 spaces for indentation
• commit unix-style newlines (\n)
• limit all lines to a maximum of 79 characters (comments should be shorter, max 60-65 chars)
• do your best for the new code to be consistent with existing code base

Debug CEF stack trace

1. Install gdb with the command "sudo apt-get install gdb"
2. Type "gdb python"
3. Inside gdb type "run pyqt.py"
4. On segmentation fault to display stack trace type "bt"

Debug Cython

Debugging Cython is currently supported only on Linux.

Before you can debug you have to install the following packages:

python-dbg
python-wxgtk2.8-dbg

Install Cython with the debug version of Python:

cd Cython-0.19.2/
sudo python-dbg setup.py install

To debug CEF Python add the "debug" argument to the "compile.py" script:

python-dbg compile.py 99.99 --debug

After a while you should see a GDB console awaiting a command, to run the app type:

cy run

To get the stack trace type:

cy backtrace

The command for running and debugging script is:

cygdb . --args python-dbg wxpython.py

To run commands automatically in gdb add "-x gdb.cmds" flag. An example gdb.cmds file:

cy run
quit

The final command would look like:

cygdb . -x gdb.cmds --args python-dbg wxpython.py

For more commands see the "Using the debugger" section in the Cython documentation: http://docs.cython.org/src/userguide/debugging.html#using-the-debugger

Updating to a newer CEF version

To see changes in the CEF API compare "cefpython/cef3/include/" directory with the new CEF "include/" directory. When doing so compare the CEF header files downloaded directly from the CEF git repository, as the CEF "include/" directory obtained from binary build will not include platform specific header files.