A Python Package for the Google Chrome Dev Protocol
Project description
# pychrome
[![Build Status](https://travis-ci.org/fate0/pychrome.svg?branch=master)](https://travis-ci.org/fate0/pychrome)
[![Codecov](https://img.shields.io/codecov/c/github/fate0/pychrome.svg)](https://codecov.io/gh/fate0/pychrome)
[![Updates](https://pyup.io/repos/github/fate0/pychrome/shield.svg)](https://pyup.io/repos/github/fate0/pychrome/)
[![PyPI](https://img.shields.io/pypi/v/pychrome.svg)](https://pypi.python.org/pypi/pychrome)
[![PyPI](https://img.shields.io/pypi/pyversions/pychrome.svg)](https://github.com/fate0/pychrome)
A Python Package for the Google Chrome Dev Protocol, [more document](https://fate0.github.io/pychrome/)
## Table of Contents
* [Installation](#installation)
* [Setup Chrome](#setup-chrome)
* [Getting Started](#getting-started)
* [Tab management](#tab-management)
* [Debug](#debug)
* [Examples](#examples)
* [Ref](#ref)
## Installation
To install pychrome, simply:
```
$ pip install -U pychrome
```
or from GitHub:
```
$ pip install -U git+https://github.com/fate0/pychrome.git
```
or from source:
```
$ python setup.py install
```
## Setup Chrome
simply:
```
$ google-chrome --remote-debugging-port=9222
```
or headless mode (chrome version >= 59):
```
$ google-chrome --headless --disable-gpu --remote-debugging-port=9222
```
or use docker:
```
$ docker pull fate0/headless-chrome
$ docker run -it --rm --cap-add=SYS_ADMIN -p9222:9222 fate0/headless-chrome
```
## Getting Started
``` python
# create a browser instance
browser = pychrome.Browser(url="http://127.0.0.1:9222")
# list all tabs (default has a blank tab)
tabs = browser.list_tab()
if not tabs:
tab = browser.new_tab()
else:
tab = tabs[0]
# register callback if you want
def request_will_be_sent(**kwargs):
print("loading: %s" % kwargs.get('request').get('url'))
tab.Network.requestWillBeSent = request_will_be_sent
# start the tab
tab.start()
# call method
tab.Network.enable()
# call method with timeout
tab.Page.navigate(url="https://github.com/fate0/pychrome", _timeout=5)
# wait for loading
tab.wait(5)
# stop the tab (stop handle events and stop recv message from chrome)
tab.stop()
# close tab
browser.close_tab(tab)
```
or (alternate syntax)
``` python
browser = pychrome.Browser(url="http://127.0.0.1:9222")
tabs = browser.list_tab()
if not tabs:
tab = browser.new_tab()
else:
tab = tabs[0]
def request_will_be_sent(**kwargs):
print("loading: %s" % kwargs.get('request').get('url'))
tab.set_listener("Network.requestWillBeSent", request_will_be_sent)
tab.start()
tab.call_method("Network.enable")
tab.call_method("Page.navigate", url="https://github.com/fate0/pychrome", _timeout=5)
tab.wait(5)
tab.stop()
browser.close_tab(tab)
```
more methods or events could be found in
[Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/tot/)
## Debug
set DEBUG env variable:
![pychrome_with_debug_env](https://raw.githubusercontent.com/fate0/pychrome/master/docs/images/pychrome_with_debug_env.png)
## Tab management
run `pychrome -h` for more info
example:
![pychrome_tab_management](https://raw.githubusercontent.com/fate0/pychrome/master/docs/images/pychrome_tab_management.png)
## Examples
please see the [examples](http://github.com/fate0/pychrome/blob/master/examples) directory for more examples
## Ref
* [chrome-remote-interface](https://github.com/cyrus-and/chrome-remote-interface/)
* [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/tot/)
[![Build Status](https://travis-ci.org/fate0/pychrome.svg?branch=master)](https://travis-ci.org/fate0/pychrome)
[![Codecov](https://img.shields.io/codecov/c/github/fate0/pychrome.svg)](https://codecov.io/gh/fate0/pychrome)
[![Updates](https://pyup.io/repos/github/fate0/pychrome/shield.svg)](https://pyup.io/repos/github/fate0/pychrome/)
[![PyPI](https://img.shields.io/pypi/v/pychrome.svg)](https://pypi.python.org/pypi/pychrome)
[![PyPI](https://img.shields.io/pypi/pyversions/pychrome.svg)](https://github.com/fate0/pychrome)
A Python Package for the Google Chrome Dev Protocol, [more document](https://fate0.github.io/pychrome/)
## Table of Contents
* [Installation](#installation)
* [Setup Chrome](#setup-chrome)
* [Getting Started](#getting-started)
* [Tab management](#tab-management)
* [Debug](#debug)
* [Examples](#examples)
* [Ref](#ref)
## Installation
To install pychrome, simply:
```
$ pip install -U pychrome
```
or from GitHub:
```
$ pip install -U git+https://github.com/fate0/pychrome.git
```
or from source:
```
$ python setup.py install
```
## Setup Chrome
simply:
```
$ google-chrome --remote-debugging-port=9222
```
or headless mode (chrome version >= 59):
```
$ google-chrome --headless --disable-gpu --remote-debugging-port=9222
```
or use docker:
```
$ docker pull fate0/headless-chrome
$ docker run -it --rm --cap-add=SYS_ADMIN -p9222:9222 fate0/headless-chrome
```
## Getting Started
``` python
# create a browser instance
browser = pychrome.Browser(url="http://127.0.0.1:9222")
# list all tabs (default has a blank tab)
tabs = browser.list_tab()
if not tabs:
tab = browser.new_tab()
else:
tab = tabs[0]
# register callback if you want
def request_will_be_sent(**kwargs):
print("loading: %s" % kwargs.get('request').get('url'))
tab.Network.requestWillBeSent = request_will_be_sent
# start the tab
tab.start()
# call method
tab.Network.enable()
# call method with timeout
tab.Page.navigate(url="https://github.com/fate0/pychrome", _timeout=5)
# wait for loading
tab.wait(5)
# stop the tab (stop handle events and stop recv message from chrome)
tab.stop()
# close tab
browser.close_tab(tab)
```
or (alternate syntax)
``` python
browser = pychrome.Browser(url="http://127.0.0.1:9222")
tabs = browser.list_tab()
if not tabs:
tab = browser.new_tab()
else:
tab = tabs[0]
def request_will_be_sent(**kwargs):
print("loading: %s" % kwargs.get('request').get('url'))
tab.set_listener("Network.requestWillBeSent", request_will_be_sent)
tab.start()
tab.call_method("Network.enable")
tab.call_method("Page.navigate", url="https://github.com/fate0/pychrome", _timeout=5)
tab.wait(5)
tab.stop()
browser.close_tab(tab)
```
more methods or events could be found in
[Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/tot/)
## Debug
set DEBUG env variable:
![pychrome_with_debug_env](https://raw.githubusercontent.com/fate0/pychrome/master/docs/images/pychrome_with_debug_env.png)
## Tab management
run `pychrome -h` for more info
example:
![pychrome_tab_management](https://raw.githubusercontent.com/fate0/pychrome/master/docs/images/pychrome_tab_management.png)
## Examples
please see the [examples](http://github.com/fate0/pychrome/blob/master/examples) directory for more examples
## Ref
* [chrome-remote-interface](https://github.com/cyrus-and/chrome-remote-interface/)
* [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/tot/)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pychrome-0.2.0.tar.gz
(9.8 kB
view hashes)
Built Distribution
Close
Hashes for pychrome-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9120c46778dcb57bc7253414c70c506a82dd77b68ad9f229b9d9e8d9475ee9e |
|
MD5 | 1c0ecfbe7aa0db75c1743ec44ad6769b |
|
BLAKE2b-256 | 526e67fc70a9907bef3d6339a3ab333f2436b9e0a34711df4bcc4023429aa4f4 |