Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fate0/pychrome

A Python Package for the Google Chrome Dev Protocol [threading base]
https://github.com/fate0/pychrome

chrome chrome-debugging-protocol chrome-devtools headless headless-chrome pychrome python

Last synced: 2 days ago
JSON representation

A Python Package for the Google Chrome Dev Protocol [threading base]

Host: GitHub
URL: https://github.com/fate0/pychrome
Owner: fate0
License: other
Created: 2017-07-25T11:01:29.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-06-17T16:55:43.000Z (5 months ago)
Last Synced: 2024-10-04T02:11:39.827Z (about 1 month ago)
Topics: chrome, chrome-debugging-protocol, chrome-devtools, headless, headless-chrome, pychrome, python
Language: Python
Homepage:
Size: 914 KB
Stars: 609
Watchers: 13
Forks: 111
Open Issues: 31
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-chrome-devtools - pychrome - low level CDP transport handler (Alumni / Automation)

README

        # 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

import pychrome

# create a browser instance

browser = pychrome.Browser(url="http://127.0.0.1:9222")

# create a tab

tab = browser.new_tab()

# 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

import pychrome

browser = pychrome.Browser(url="http://127.0.0.1:9222")

tab = browser.new_tab()

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/)