https://github.com/whois-api-llc/screenshot-py

Screenshot API client library for Python
https://github.com/whois-api-llc/screenshot-py

python screenshot screenshot-api website-screenshot whoisxmlapi

Last synced: 10 months ago
JSON representation

Screenshot API client library for Python

• Host: GitHub
• URL: https://github.com/whois-api-llc/screenshot-py
• Owner: whois-api-llc
• License: mit
• Created: 2021-12-16T15:21:46.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-23T02:33:53.000Z (about 3 years ago)
• Last Synced: 2025-02-26T09:46:06.629Z (over 1 year ago)
• Topics: python, screenshot, screenshot-api, website-screenshot, whoisxmlapi
• Language: Python
• Homepage: https://website-screenshot.whoisxmlapi.com/
• Size: 12.7 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          
.. image:: https://img.shields.io/badge/License-MIT-green.svg

    :alt: screenshot-py license

    :target: https://opensource.org/licenses/MIT

.. image:: https://img.shields.io/pypi/v/screenshot-api.svg

    :alt: screenshot-py release

    :target: https://pypi.org/project/screenshot-api

.. image:: https://github.com/whois-api-llc/screenshot-py/workflows/Build/badge.svg

    :alt: screenshot-py build

    :target: https://github.com/whois-api-llc/screenshot-py/actions

========

Overview

========

The client library for

`Screenshot API `_

in Python language.

The minimum Python version is 3.6.

Installation

============

.. code-block:: shell

    pip install screenshot-api

Examples

========

Full API documentation available `here `_

Create a new client

-------------------

.. code-block:: python

    from screenshotapi import *

    client = Client('Your API key')

Capture screenshots

-------------------

.. code-block:: python

    client.get(filename='screen.jpg',url='example.com')

Extras

-------------------

.. code-block:: python

    cookies = {

        'name1': 'value1',

        'name2': 'value2'

    }

    # Pass cookies, emulate mobile device, disable JS, wait for network idle

    # event, output API errors in XML, capture PDF screenshot in full page

    # mode and get image data in base64.

    response = client.get_raw(

        url='example.com',

        type=ImageFormat.PDF,

        mode=Client.SLOW_MODE,

        full_page=True,

        mobile=True,

        output_format=Client.XML_FORMAT,

        image_output_format=Client.BASE64_FORMAT,

        no_js=True,

        cookies=cookies

    )