pyppeteer
==========
[](https://pypi.python.org/pypi/pyppeteer)
[](https://pypi.python.org/pypi/pyppeteer)
[](https://pyppeteer.github.io/pyppeteer/)
[](https://circleci.com/gh/pyppeteer/pyppeteer)
[](https://codecov.io/gh/pyppeteer/pyppeteer)
_Note: this is a continuation of the [pyppeteer project](https://github.com/miyakogi/pyppeteer)_
Unofficial Python port of [puppeteer](https://github.com/GoogleChrome/puppeteer) JavaScript (headless) chrome/chromium browser automation library.
* Free software: MIT license (including the work distributed under the Apache 2.0 license)
* Documentation: https://pyppeteer.github.io/pyppeteer/
## Installation
pyppeteer requires Python >= 3.8
Install with `pip` from PyPI:
```
pip install pyppeteer
```
Or install the latest version from [this github repo](https://github.com/pyppeteer/pyppeteer/):
```
pip install -U git+https://github.com/pyppeteer/pyppeteer@dev
```
## Usage
> **Note**: When you run pyppeteer for the first time, it downloads the latest version of Chromium (~150MB) if it is not found on your system. If you don't prefer this behavior, ensure that a suitable Chrome binary is installed. One way to do this is to run `pyppeteer-install` command before prior to using this library.
Full documentation can be found [here](https://pyppeteer.github.io/pyppeteer/reference.html). [Puppeteer's documentation](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#) and [its troubleshooting guide](https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md) are also great resources for pyppeteer users.
### Examples
Open web page and take a screenshot:
```py
import asyncio
from pyppeteer import launch
async def main():
browser = await launch()
page = await browser.newPage()
await page.goto('https://example.com')
await page.screenshot({'path': 'example.png'})
await browser.close()
asyncio.get_event_loop().run_until_complete(main())
```
Evaluate javascript on a page:
```py
import asyncio
from pyppeteer import launch
async def main():
browser = await launch()
page = await browser.newPage()
await page.goto('https://example.com')
await page.screenshot({'path': 'example.png'})
dimensions = await page.evaluate('''() => {
return {
width: document.documentElement.clientWidth,
height: document.documentElement.clientHeight,
deviceScaleFactor: window.devicePixelRatio,
}
}''')
print(dimensions)
# >>> {'width': 800, 'height': 600, 'deviceScaleFactor': 1}
await browser.close()
asyncio.get_event_loop().run_until_complete(main())
```
## Differences between puppeteer and pyppeteer
pyppeteer strives to replicate the puppeteer API as close as possible, however, fundamental differences between Javascript and Python make this difficult to do precisely. More information on specifics can be found in the [documentation](https://pyppeteer.github.io/pyppeteer/reference.html).
### Keyword arguments for options
puppeteer uses an object for passing options to functions/methods. pyppeteer methods/functions accept both dictionary (python equivalent to JavaScript's objects) and keyword arguments for options.
Dictionary style options (similar to puppeteer):
```python
browser = await launch({'headless': True})
```
Keyword argument style options (more pythonic, isn't it?):
```python
browser = await launch(headless=True)
```
### Element selector method names
In python, `$` is not a valid identifier. The equivalent methods to Puppeteer's `$`, `$$`, and `$x` methods are listed below, along with some shorthand methods for your convenience:
| puppeteer | pyppeteer | pyppeteer shorthand |
|-----------|-------------------------|----------------------|
| Page.$() | Page.querySelector() | Page.J() |
| Page.$$() | Page.querySelectorAll() | Page.JJ() |
| Page.$x() | Page.xpath() | Page.Jx() |
### Arguments of `Page.evaluate()` and `Page.querySelectorEval()`
puppeteer's version of `evaluate()` takes a JavaScript function or a string representation of a JavaScript expression. pyppeteer takes string representation of JavaScript expression or function. pyppeteer will try to automatically detect if the string is function or expression, but it will fail sometimes. If an expression is erroneously treated as function and an error is raised, try setting `force_expr` to `True`, to force pyppeteer to treat the string as expression.
### Examples:
Get a page's `textContent`:
```python
content = await page.evaluate('document.body.textContent', force_expr=True)
```
Get an element's `textContent`:
```python
element = await page.querySelector('h1')
title = await page.evaluate('(element) => element.textContent', element)
```
## Roadmap
See [projects](https://github.com/pyppeteer/pyppeteer/projects)
## Credits
###### This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.
Raw data
{
"_id": null,
"home_page": "https://github.com/pyppeteer/pyppeteer",
"name": "pyppeteer-ng",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "pyppeteer,puppeteer,chrome,chromium",
"author": "granitosaurus",
"author_email": "bernardas.alisauskas@pm.me",
"download_url": "https://files.pythonhosted.org/packages/82/f3/afea1a2315901fd65406fd060f12e8ddd2cf67eca51bba591184319bb5c4/pyppeteer_ng-2.0.0rc5.tar.gz",
"platform": null,
"description": "pyppeteer\n==========\n\n[](https://pypi.python.org/pypi/pyppeteer)\n[](https://pypi.python.org/pypi/pyppeteer)\n[](https://pyppeteer.github.io/pyppeteer/)\n[](https://circleci.com/gh/pyppeteer/pyppeteer)\n[](https://codecov.io/gh/pyppeteer/pyppeteer)\n\n_Note: this is a continuation of the [pyppeteer project](https://github.com/miyakogi/pyppeteer)_\n\nUnofficial Python port of [puppeteer](https://github.com/GoogleChrome/puppeteer) JavaScript (headless) chrome/chromium browser automation library.\n\n* Free software: MIT license (including the work distributed under the Apache 2.0 license)\n* Documentation: https://pyppeteer.github.io/pyppeteer/\n\n## Installation\n\npyppeteer requires Python >= 3.8\n\nInstall with `pip` from PyPI:\n\n```\npip install pyppeteer\n```\n\nOr install the latest version from [this github repo](https://github.com/pyppeteer/pyppeteer/):\n\n```\npip install -U git+https://github.com/pyppeteer/pyppeteer@dev\n```\n\n## Usage\n\n> **Note**: When you run pyppeteer for the first time, it downloads the latest version of Chromium (~150MB) if it is not found on your system. If you don't prefer this behavior, ensure that a suitable Chrome binary is installed. One way to do this is to run `pyppeteer-install` command before prior to using this library.\n\nFull documentation can be found [here](https://pyppeteer.github.io/pyppeteer/reference.html). [Puppeteer's documentation](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#) and [its troubleshooting guide](https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md) are also great resources for pyppeteer users.\n\n### Examples\n\nOpen web page and take a screenshot:\n```py\nimport asyncio\nfrom pyppeteer import launch\n\nasync def main():\n browser = await launch()\n page = await browser.newPage()\n await page.goto('https://example.com')\n await page.screenshot({'path': 'example.png'})\n await browser.close()\n\nasyncio.get_event_loop().run_until_complete(main())\n```\n\nEvaluate javascript on a page:\n```py\nimport asyncio\nfrom pyppeteer import launch\n\nasync def main():\n browser = await launch()\n page = await browser.newPage()\n await page.goto('https://example.com')\n await page.screenshot({'path': 'example.png'})\n\n dimensions = await page.evaluate('''() => {\n return {\n width: document.documentElement.clientWidth,\n height: document.documentElement.clientHeight,\n deviceScaleFactor: window.devicePixelRatio,\n }\n }''')\n\n print(dimensions)\n # >>> {'width': 800, 'height': 600, 'deviceScaleFactor': 1}\n await browser.close()\n\nasyncio.get_event_loop().run_until_complete(main())\n```\n\n## Differences between puppeteer and pyppeteer\n\npyppeteer strives to replicate the puppeteer API as close as possible, however, fundamental differences between Javascript and Python make this difficult to do precisely. More information on specifics can be found in the [documentation](https://pyppeteer.github.io/pyppeteer/reference.html).\n\n### Keyword arguments for options\n\npuppeteer uses an object for passing options to functions/methods. pyppeteer methods/functions accept both dictionary (python equivalent to JavaScript's objects) and keyword arguments for options.\n\nDictionary style options (similar to puppeteer):\n\n```python\nbrowser = await launch({'headless': True})\n```\n\nKeyword argument style options (more pythonic, isn't it?):\n\n```python\nbrowser = await launch(headless=True)\n```\n\n### Element selector method names\n\nIn python, `$` is not a valid identifier. The equivalent methods to Puppeteer's `$`, `$$`, and `$x` methods are listed below, along with some shorthand methods for your convenience:\n\n| puppeteer | pyppeteer | pyppeteer shorthand |\n|-----------|-------------------------|----------------------|\n| Page.$() | Page.querySelector() | Page.J() |\n| Page.$$() | Page.querySelectorAll() | Page.JJ() |\n| Page.$x() | Page.xpath() | Page.Jx() |\n\n### Arguments of `Page.evaluate()` and `Page.querySelectorEval()`\n\npuppeteer's version of `evaluate()` takes a JavaScript function or a string representation of a JavaScript expression. pyppeteer takes string representation of JavaScript expression or function. pyppeteer will try to automatically detect if the string is function or expression, but it will fail sometimes. If an expression is erroneously treated as function and an error is raised, try setting `force_expr` to `True`, to force pyppeteer to treat the string as expression.\n\n### Examples:\n\nGet a page's `textContent`:\n\n```python\ncontent = await page.evaluate('document.body.textContent', force_expr=True)\n```\n\nGet an element's `textContent`:\n\n```python\nelement = await page.querySelector('h1')\ntitle = await page.evaluate('(element) => element.textContent', element)\n```\n\n## Roadmap\n\nSee [projects](https://github.com/pyppeteer/pyppeteer/projects)\n\n## Credits\n\n###### This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Headless chrome/chromium automation library (unofficial port of puppeteer)",
"version": "2.0.0rc5",
"project_urls": {
"Bug Tracker": "https://github.com/pyppeteer/pyppeteer/issues",
"Homepage": "https://github.com/pyppeteer/pyppeteer",
"Repository": "https://github.com/pyppeteer/pyppeteer"
},
"split_keywords": [
"pyppeteer",
"puppeteer",
"chrome",
"chromium"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c09cf9340e96b6ea5865ada9695b9c063a1f00dd772e18a039be0f52e4d80c0b",
"md5": "838fd0671ef19cd178f095df401391f1",
"sha256": "bd0e64d98649b75a89a5c28934f6ad439357dc207cebed4a3a49a2c4abb7c67d"
},
"downloads": -1,
"filename": "pyppeteer_ng-2.0.0rc5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "838fd0671ef19cd178f095df401391f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 201825,
"upload_time": "2024-03-08T22:35:11",
"upload_time_iso_8601": "2024-03-08T22:35:11.317257Z",
"url": "https://files.pythonhosted.org/packages/c0/9c/f9340e96b6ea5865ada9695b9c063a1f00dd772e18a039be0f52e4d80c0b/pyppeteer_ng-2.0.0rc5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "82f3afea1a2315901fd65406fd060f12e8ddd2cf67eca51bba591184319bb5c4",
"md5": "d83bf1b7c365a47840d999c23454b4b9",
"sha256": "11c4d6c53fb04b3efa596b874ff7bb178fcc4509576faa6237d90f58dc625bfa"
},
"downloads": -1,
"filename": "pyppeteer_ng-2.0.0rc5.tar.gz",
"has_sig": false,
"md5_digest": "d83bf1b7c365a47840d999c23454b4b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 183464,
"upload_time": "2024-03-08T22:35:12",
"upload_time_iso_8601": "2024-03-08T22:35:12.804762Z",
"url": "https://files.pythonhosted.org/packages/82/f3/afea1a2315901fd65406fd060f12e8ddd2cf67eca51bba591184319bb5c4/pyppeteer_ng-2.0.0rc5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-08 22:35:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyppeteer",
"github_project": "pyppeteer",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "pyppeteer-ng"
}
JSON
