{"id":13488600,"url":"https://github.com/scrapy-plugins/scrapy-splash","last_synced_at":"2025-12-17T17:28:31.954Z","repository":{"id":8447660,"uuid":"10040793","full_name":"scrapy-plugins/scrapy-splash","owner":"scrapy-plugins","description":"Scrapy+Splash for JavaScript integration","archived":false,"fork":false,"pushed_at":"2025-02-11T17:03:30.000Z","size":339,"stargazers_count":3206,"open_issues_count":68,"forks_count":458,"subscribers_count":124,"default_branch":"master","last_synced_at":"2025-05-11T13:59:05.605Z","etag":null,"topics":["headless-browsers","scrapy"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scrapy-plugins.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2013-05-13T20:40:11.000Z","updated_at":"2025-05-09T02:57:39.000Z","dependencies_parsed_at":"2025-04-10T18:14:39.807Z","dependency_job_id":"b21cbb40-27c5-45fd-b19e-aa61f33537e4","html_url":"https://github.com/scrapy-plugins/scrapy-splash","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrapy-plugins%2Fscrapy-splash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrapy-plugins%2Fscrapy-splash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrapy-plugins%2Fscrapy-splash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scrapy-plugins%2Fscrapy-splash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scrapy-plugins","download_url":"https://codeload.github.com/scrapy-plugins/scrapy-splash/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253576262,"owners_count":21930169,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["headless-browsers","scrapy"],"created_at":"2024-07-31T18:01:18.681Z","updated_at":"2025-12-17T17:28:31.896Z","avatar_url":"https://github.com/scrapy-plugins.png","language":"Python","funding_links":[],"categories":["Apps","Python","Tools"],"sub_categories":["Process Javascript"],"readme":"==============================================\nScrapy \u0026 JavaScript integration through Splash\n==============================================\n\n.. image:: https://img.shields.io/pypi/v/scrapy-splash.svg\n   :target: https://pypi.python.org/pypi/scrapy-splash\n   :alt: PyPI Version\n\n.. image:: https://github.com/scrapy-plugins/scrapy-splash/workflows/Tests/badge.svg\n   :target: https://github.com/scrapy-plugins/scrapy-splash/actions/workflows/tests.yml\n   :alt: Test Status\n\n.. image:: http://codecov.io/github/scrapy-plugins/scrapy-splash/coverage.svg?branch=master\n   :target: http://codecov.io/github/scrapy-plugins/scrapy-splash?branch=master\n   :alt: Code Coverage\n\nThis library provides Scrapy_ and JavaScript integration using Splash_.\nThe license is BSD 3-clause.\n\n.. _Scrapy: https://github.com/scrapy/scrapy\n.. _Splash: https://github.com/scrapinghub/splash\n\nInstallation\n============\n\nInstall scrapy-splash using pip::\n\n    $ pip install scrapy-splash\n\nScrapy-Splash uses Splash_ HTTP API, so you also need a Splash instance.\nUsually to install \u0026 run Splash, something like this is enough::\n\n    $ docker run -p 8050:8050 scrapinghub/splash\n\nCheck Splash `install docs`_ for more info.\n\n.. _install docs: http://splash.readthedocs.org/en/latest/install.html\n\n\nConfiguration\n=============\n\n1. Add the Splash server address to ``settings.py`` of your Scrapy project\n   like this::\n\n      SPLASH_URL = 'http://192.168.59.103:8050'\n\n2. Enable the Splash middleware by adding it to ``DOWNLOADER_MIDDLEWARES``\n   in your ``settings.py`` file and changing HttpCompressionMiddleware\n   priority:\n\n   .. code:: python\n\n      DOWNLOADER_MIDDLEWARES = {\n          'scrapy_splash.SplashCookiesMiddleware': 723,\n          'scrapy_splash.SplashMiddleware': 725,\n          'scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware': 810,\n      }\n\n   Order `723` is just before `HttpProxyMiddleware` (750) in default\n   scrapy settings.\n\n   HttpCompressionMiddleware priority should be changed in order to allow\n   advanced response processing; see https://github.com/scrapy/scrapy/issues/1895\n   for details.\n\n3. Enable ``SplashDeduplicateArgsMiddleware`` by adding it to\n   ``SPIDER_MIDDLEWARES`` in your ``settings.py``:\n\n   .. code:: python\n\n      SPIDER_MIDDLEWARES = {\n          'scrapy_splash.SplashDeduplicateArgsMiddleware': 100,\n      }\n\n   This middleware is needed to support ``cache_args`` feature; it allows\n   to save disk space by not storing duplicate Splash arguments multiple\n   times in a disk request queue. If Splash 2.1+ is used the middleware\n   also allows to save network traffic by not sending these duplicate\n   arguments to Splash server multiple times.\n\n4. Set a custom ``REQUEST_FINGERPRINTER_CLASS``:\n\n   .. code:: python\n\n      REQUEST_FINGERPRINTER_CLASS = 'scrapy_splash.SplashRequestFingerprinter'\n\n\nThere are also some additional options available.\nPut them into your ``settings.py`` if you want to change the defaults:\n\n* ``SPLASH_COOKIES_DEBUG`` is ``False`` by default.\n  Set to ``True`` to enable debugging cookies in the ``SplashCookiesMiddleware``.\n  This option is similar to ``COOKIES_DEBUG``\n  for the built-in Scrapy cookies middleware: it logs sent and received cookies\n  for all requests.\n* ``SPLASH_LOG_400`` is ``True`` by default - it instructs to log all 400 errors\n  from Splash. They are important because they show errors occurred\n  when executing the Splash script. Set it to ``False`` to disable this logging.\n* ``SPLASH_SLOT_POLICY`` is ``scrapy_splash.SlotPolicy.PER_DOMAIN`` (as object, not just a string) by default.\n  It specifies how concurrency \u0026 politeness are maintained for Splash requests,\n  and specify the default value for ``slot_policy`` argument for\n  ``SplashRequest``, which is described below.\n* ``SCRAPY_SPLASH_REQUEST_FINGERPRINTER_BASE_CLASS`` is ``scrapy.settings.default_settings.REQUEST_FINGERPRINTER_CLASS`` by default. This changes the base class the Fingerprinter uses to get a fingerprint.\n\n\nUsage\n=====\n\nRequests\n--------\n\nThe easiest way to render requests with Splash is to\nuse ``scrapy_splash.SplashRequest``:\n\n.. code:: python\n\n    yield SplashRequest(url, self.parse_result,\n        args={\n            # optional; parameters passed to Splash HTTP API\n            'wait': 0.5,\n\n            # 'url' is prefilled from request url\n            # 'http_method' is set to 'POST' for POST requests\n            # 'body' is set to request body for POST requests\n        },\n        endpoint='render.json', # optional; default is render.html\n        splash_url='\u003curl\u003e',     # optional; overrides SPLASH_URL\n        slot_policy=scrapy_splash.SlotPolicy.PER_DOMAIN,  # optional\n    )\n\nAlternatively, you can use regular scrapy.Request and\n``'splash'`` Request `meta` key:\n\n.. code:: python\n\n    yield scrapy.Request(url, self.parse_result, meta={\n        'splash': {\n            'args': {\n                # set rendering arguments here\n                'html': 1,\n                'png': 1,\n\n                # 'url' is prefilled from request url\n                # 'http_method' is set to 'POST' for POST requests\n                # 'body' is set to request body for POST requests\n            },\n\n            # optional parameters\n            'endpoint': 'render.json',  # optional; default is render.json\n            'splash_url': '\u003curl\u003e',      # optional; overrides SPLASH_URL\n            'slot_policy': scrapy_splash.SlotPolicy.PER_DOMAIN,\n            'splash_headers': {},       # optional; a dict with headers sent to Splash\n            'dont_process_response': True, # optional, default is False\n            'dont_send_headers': True,  # optional, default is False\n            'magic_response': False,    # optional, default is True\n        }\n    })\n\nUse ``request.meta['splash']`` API in middlewares or when scrapy.Request\nsubclasses are used (there is also ``SplashFormRequest`` described below).\nFor example, ``meta['splash']`` allows to create a middleware which enables\nSplash for all outgoing requests by default.\n\n``SplashRequest`` is a convenient utility to fill ``request.meta['splash']``;\nit should be easier to use in most cases. For each ``request.meta['splash']``\nkey there is a corresponding ``SplashRequest`` keyword argument: for example,\nto set ``meta['splash']['args']`` use ``SplashRequest(..., args=myargs)``.\n\n* ``meta['splash']['args']`` contains arguments sent to Splash.\n  scrapy-splash adds some default keys/values to ``args``:\n\n  * 'url' is set to request.url;\n  * 'http_method' is set to 'POST' for POST requests;\n  * 'body' is set to to request.body for POST requests.\n\n  You can override default values by setting them explicitly.\n\n  Note that by default Scrapy escapes URL fragments using AJAX escaping scheme.\n  If you want to pass a URL with a fragment to Splash then set ``url``\n  in ``args`` dict manually. This is handled automatically if you use\n  ``SplashRequest``, but you need to keep that in mind if you use raw\n  ``meta['splash']`` API.\n\n  Splash 1.8+ is required to handle POST requests; in earlier Splash versions\n  'http_method' and 'body' arguments are ignored. If you work with ``/execute``\n  endpoint and want to support POST requests you have to handle\n  ``http_method`` and ``body`` arguments in your Lua script manually.\n\n* ``meta['splash']['cache_args']`` is a list of argument names to cache\n  on Splash side. These arguments are sent to Splash only once, then cached\n  values are used; it allows to save network traffic and decreases request\n  queue disk memory usage. Use ``cache_args`` only for large arguments\n  which don't change with each request; ``lua_source`` is a good candidate\n  (if you don't use string formatting to build it). Splash 2.1+ is required\n  for this feature to work.\n\n* ``meta['splash']['endpoint']`` is the Splash endpoint to use.\n  In case of SplashRequest\n  `render.html \u003chttp://splash.readthedocs.org/en/latest/api.html#render-html\u003e`_\n  is used by default. If you're using raw scrapy.Request then\n  `render.json \u003chttp://splash.readthedocs.org/en/latest/api.html#render-json\u003e`_\n  is a default (for historical reasons). It is better to always pass endpoint\n  explicitly.\n\n  See Splash `HTTP API docs`_ for a full list of available endpoints\n  and parameters.\n\n.. _HTTP API docs: http://splash.readthedocs.org/en/latest/api.html\n\n* ``meta['splash']['splash_url']`` overrides the Splash URL set\n  in ``settings.py``.\n\n* ``meta['splash']['splash_headers']`` allows to add or change headers\n  which are sent to Splash server. Note that this option **is not** for\n  setting headers which are sent to the remote website.\n\n* ``meta['splash']['slot_policy']`` customize how\n  concurrency \u0026 politeness are maintained for Splash requests.\n\n  Currently there are 3 policies available:\n\n  1. ``scrapy_splash.SlotPolicy.PER_DOMAIN`` (default) - send Splash requests to\n     downloader slots based on URL being rendered. It is useful if you want\n     to maintain per-domain politeness \u0026 concurrency settings.\n\n  2. ``scrapy_splash.SlotPolicy.SINGLE_SLOT`` - send all Splash requests to\n     a single downloader slot. It is useful if you want to throttle requests\n     to Splash.\n\n  3. ``scrapy_splash.SlotPolicy.SCRAPY_DEFAULT`` - don't do anything with slots.\n     It is similar to ``SINGLE_SLOT`` policy, but can be different if you access\n     other services on the same address as Splash.\n\n* ``meta['splash']['dont_process_response']`` - when set to True,\n  SplashMiddleware won't change the response to a custom scrapy.Response\n  subclass. By default for Splash requests one of SplashResponse,\n  SplashTextResponse or SplashJsonResponse is passed to the callback.\n\n* ``meta['splash']['dont_send_headers']``: by default scrapy-splash passes\n  request headers to Splash in 'headers' JSON POST field. For all render.xxx\n  endpoints it means Scrapy header options are respected by default\n  (http://splash.readthedocs.org/en/stable/api.html#arg-headers). In Lua\n  scripts you can use ``headers`` argument of ``splash:go`` to apply the\n  passed headers: ``splash:go{url, headers=splash.args.headers}``.\n\n  Set 'dont_send_headers' to True if you don't want to pass ``headers``\n  to Splash.\n\n* ``meta['splash']['http_status_from_error_code']`` - set response.status\n  to HTTP error code when ``assert(splash:go(..))`` fails; it requires\n  ``meta['splash']['magic_response']=True``. ``http_status_from_error_code``\n  option is False by default if you use raw meta API;\n  SplashRequest sets it to True by default.\n\n* ``meta['splash']['magic_response']`` - when set to True and a JSON\n  response is received from Splash, several attributes of the response\n  (headers, body, url, status code) are filled using data returned in JSON:\n\n  * response.headers are filled from 'headers' keys;\n  * response.url is set to the value of 'url' key;\n  * response.body is set to the value of 'html' key,\n    or to base64-decoded value of 'body' key;\n  * response.status is set to the value of 'http_status' key.\n    When ``meta['splash']['http_status_from_error_code']`` is True\n    and ``assert(splash:go(..))`` fails with an HTTP error\n    response.status is also set to HTTP error code.\n\n  Original URL, status and headers are available as ``response.real_url``,\n  ``response.splash_response_status`` and ``response.splash_response_headers``.\n\n  This option is set to True by default if you use SplashRequest.\n  ``render.json`` and ``execute`` endpoints may not have all the necessary\n  keys/values in the response.\n  For non-JSON endpoints, only url is filled, regardless of the\n  ``magic_response`` setting.\n\n\nUse ``scrapy_splash.SplashFormRequest`` if you want to make a ``FormRequest``\nvia splash. It accepts the same arguments as ``SplashRequest``,\nand also ``formdata``, like ``FormRequest`` from scrapy::\n\n    \u003e\u003e\u003e from scrapy_splash import SplashFormRequest\n    \u003e\u003e\u003e SplashFormRequest('http://example.com', formdata={'foo': 'bar'})\n    \u003cPOST http://example.com\u003e\n\n``SplashFormRequest.from_response`` is also supported, and works as described\nin `scrapy documentation \u003chttp://scrapy.readthedocs.org/en/latest/topics/request-response.html#scrapy.http.FormRequest.from_response\u003e`_.\n\nResponses\n---------\n\nscrapy-splash returns Response subclasses for Splash requests:\n\n* SplashResponse is returned for binary Splash responses - e.g. for\n  /render.png responses;\n* SplashTextResponse is returned when the result is text - e.g. for\n  /render.html responses;\n* SplashJsonResponse is returned when the result is a JSON object - e.g.\n  for /render.json responses or /execute responses when script returns\n  a Lua table.\n\nTo use standard Response classes set ``meta['splash']['dont_process_response']=True``\nor pass ``dont_process_response=True`` argument to SplashRequest.\n\nAll these responses set ``response.url`` to the URL of the original request\n(i.e. to the URL of a website you want to render), not to the URL of the\nrequested Splash endpoint. \"True\" URL is still available as\n``response.real_url``.\n\nSplashJsonResponse provide extra features:\n\n* ``response.data`` attribute contains response data decoded from JSON;\n  you can access it like ``response.data['html']``.\n\n* If Splash session handling is configured, you can access current cookies\n  as ``response.cookiejar``; it is a CookieJar instance.\n\n* If Scrapy-Splash response magic is enabled in request (default),\n  several response attributes (headers, body, url, status code)\n  are set automatically from original response body:\n\n  * response.headers are filled from 'headers' keys;\n  * response.url is set to the value of 'url' key;\n  * response.body is set to the value of 'html' key,\n    or to base64-decoded value of 'body' key;\n  * response.status is set from the value of 'http_status' key.\n\nWhen ``response.body`` is updated in SplashJsonResponse\n(either from 'html' or from 'body' keys) familiar ``response.css``\nand ``response.xpath`` methods are available.\n\nTo turn off special handling of JSON result keys either set\n``meta['splash']['magic_response']=False`` or pass ``magic_response=False``\nargument to SplashRequest.\n\nSession Handling\n================\n\nSplash itself is stateless - each request starts from a clean state.\nIn order to support sessions the following is required:\n\n1. client (Scrapy) must send current cookies to Splash;\n2. Splash script should make requests using these cookies and update\n   them from HTTP response headers or JavaScript code;\n3. updated cookies should be sent back to the client;\n4. client should merge current cookies with the updated cookies.\n\nFor (2) and (3) Splash provides ``splash:get_cookies()`` and\n``splash:init_cookies()`` methods which can be used in Splash Lua scripts.\n\nscrapy-splash provides helpers for (1) and (4): to send current cookies\nin 'cookies' field and merge cookies back from 'cookies' response field\nset ``request.meta['splash']['session_id']`` to the session\nidentifier. If you only want a single session use the same ``session_id`` for\nall request; any value like '1' or 'foo' is fine.\n\nFor scrapy-splash session handling to work you must use ``/execute`` endpoint\nand a Lua script which accepts 'cookies' argument and returns 'cookies'\nfield in the result:\n\n.. code:: python\n\n   function main(splash)\n       splash:init_cookies(splash.args.cookies)\n\n       -- ... your script\n\n       return {\n           cookies = splash:get_cookies(),\n           -- ... other results, e.g. html\n       }\n   end\n\nSplashRequest sets ``session_id`` automatically for ``/execute`` endpoint,\ni.e. cookie handling is enabled by default if you use SplashRequest,\n``/execute`` endpoint and a compatible Lua rendering script.\n\nIf you want to start from the same set of cookies, but then 'fork' sessions\nset ``request.meta['splash']['new_session_id']`` in addition to\n``session_id``. Request cookies will be fetched from cookiejar ``session_id``,\nbut response cookies will be merged back to the ``new_session_id`` cookiejar.\n\nStandard Scrapy ``cookies`` argument can be used with ``SplashRequest``\nto add cookies to the current Splash cookiejar.\n\nExamples\n========\n\nGet HTML contents:\n\n.. code:: python\n\n    import scrapy\n    from scrapy_splash import SplashRequest\n\n    class MySpider(scrapy.Spider):\n        name = \"MySpider\"\n        start_urls = [\"http://example.com\", \"http://example.com/foo\"]\n\n        def start_requests(self):\n            for url in self.start_urls:\n                yield SplashRequest(url, self.parse, args={'wait': 0.5})\n\n        def parse(self, response):\n            # response.body is a result of render.html call; it\n            # contains HTML processed by a browser.\n            # ...\n\nGet HTML contents and a screenshot:\n\n.. code:: python\n\n    import json\n    import base64\n    import scrapy\n    from scrapy_splash import SplashRequest\n\n    class MySpider(scrapy.Spider):\n\n        # ...\n            splash_args = {\n                'wait': 1,\n                'html': 1,\n                'png': 1,\n                'width': 600,\n                'render_all': 1,\n            }\n            yield SplashRequest(url, self.parse_result, endpoint='render.json',\n                                args=splash_args)\n\n        # ...\n        def parse_result(self, response):\n            # magic responses are turned ON by default,\n            # so the result under 'html' key is available as response.body\n            html = response.body\n\n            # you can also query the html result as usual\n            title = response.css('title').extract_first()\n\n            # full decoded JSON data is available as response.data:\n            png_bytes = base64.b64decode(response.data['png'])\n\n            # ...\n\nRun a simple `Splash Lua Script`_:\n\n.. code:: python\n\n    import json\n    import base64\n    from scrapy_splash import SplashRequest\n\n\n    class MySpider(scrapy.Spider):\n\n        # ...\n            script = \"\"\"\n            function main(splash)\n                assert(splash:go(splash.args.url))\n                return splash:evaljs(\"document.title\")\n            end\n            \"\"\"\n            yield SplashRequest(url, self.parse_result, endpoint='execute',\n                                args={'lua_source': script})\n\n        # ...\n        def parse_result(self, response):\n            doc_title = response.text\n            # ...\n\n\nMore complex `Splash Lua Script`_ example - get a screenshot of an HTML\nelement by its CSS selector (it requires Splash 2.1+).\nNote how are arguments passed to the script:\n\n.. code:: python\n\n    import json\n    import base64\n    from scrapy_splash import SplashRequest\n\n    script = \"\"\"\n    -- Arguments:\n    -- * url - URL to render;\n    -- * css - CSS selector to render;\n    -- * pad - screenshot padding size.\n\n    -- this function adds padding around region\n    function pad(r, pad)\n      return {r[1]-pad, r[2]-pad, r[3]+pad, r[4]+pad}\n    end\n\n    -- main script\n    function main(splash)\n\n      -- this function returns element bounding box\n      local get_bbox = splash:jsfunc([[\n        function(css) {\n          var el = document.querySelector(css);\n          var r = el.getBoundingClientRect();\n          return [r.left, r.top, r.right, r.bottom];\n        }\n      ]])\n\n      assert(splash:go(splash.args.url))\n      assert(splash:wait(0.5))\n\n      -- don't crop image by a viewport\n      splash:set_viewport_full()\n\n      local region = pad(get_bbox(splash.args.css), splash.args.pad)\n      return splash:png{region=region}\n    end\n    \"\"\"\n\n    class MySpider(scrapy.Spider):\n\n\n        # ...\n            yield SplashRequest(url, self.parse_element_screenshot,\n                endpoint='execute',\n                args={\n                    'lua_source': script,\n                    'pad': 32,\n                    'css': 'a.title'\n                }\n             )\n\n        # ...\n        def parse_element_screenshot(self, response):\n            image_data = response.body  # binary image data in PNG format\n            # ...\n\n\nUse a Lua script to get an HTML response with cookies, headers, body\nand method set to correct values; ``lua_source`` argument value is cached\non Splash server and is not sent with each request (it requires Splash 2.1+):\n\n.. code:: python\n\n    import scrapy\n    from scrapy_splash import SplashRequest\n\n    script = \"\"\"\n    function main(splash)\n      splash:init_cookies(splash.args.cookies)\n      assert(splash:go{\n        splash.args.url,\n        headers=splash.args.headers,\n        http_method=splash.args.http_method,\n        body=splash.args.body,\n        })\n      assert(splash:wait(0.5))\n\n      local entries = splash:history()\n      local last_response = entries[#entries].response\n      return {\n        url = splash:url(),\n        headers = last_response.headers,\n        http_status = last_response.status,\n        cookies = splash:get_cookies(),\n        html = splash:html(),\n      }\n    end\n    \"\"\"\n\n    class MySpider(scrapy.Spider):\n\n\n        # ...\n            yield SplashRequest(url, self.parse_result,\n                endpoint='execute',\n                cache_args=['lua_source'],\n                args={'lua_source': script},\n                headers={'X-My-Header': 'value'},\n            )\n\n        def parse_result(self, response):\n            # here response.body contains result HTML;\n            # response.headers are filled with headers from last\n            # web page loaded to Splash;\n            # cookies from all responses and from JavaScript are collected\n            # and put into Set-Cookie response header, so that Scrapy\n            # can remember them.\n\n\n\n.. _Splash Lua Script: http://splash.readthedocs.org/en/latest/scripting-tutorial.html\n\n\nHTTP Basic Auth\n===============\n\nIf you need to use HTTP Basic Authentication to access Splash, use the\n``SPLASH_USER`` and ``SPLASH_PASS`` optional settings::\n\n    SPLASH_USER = 'user'\n    SPLASH_PASS = 'userpass'\n\nAnother option is ``meta['splash']['splash_headers']``: it allows to set\ncustom headers which are sent to Splash server; add Authorization header\nto ``splash_headers`` if you want to change credentials per-request::\n\n    import scrapy\n    from w3lib.http import basic_auth_header\n\n    class MySpider(scrapy.Spider):\n        # ...\n        def start_requests(self):\n            auth = basic_auth_header('user', 'userpass')\n            yield SplashRequest(url, self.parse,\n                                splash_headers={'Authorization': auth})\n\n**WARNING:** Don't use `HttpAuthMiddleware`_\n(i.e. ``http_user`` / ``http_pass`` spider attributes) for Splash\nauthentication: if you occasionally send a non-Splash request from your spider,\nyou may expose Splash credentials to a remote website, as HttpAuthMiddleware\nsets credentials for all requests unconditionally.\n\n.. _HttpAuthMiddleware: http://doc.scrapy.org/en/latest/topics/downloader-middleware.html#module-scrapy.downloadermiddlewares.httpauth\n\nWhy not use the Splash HTTP API directly?\n=========================================\n\nThe obvious alternative to scrapy-splash would be to send requests directly\nto the Splash `HTTP API`_. Take a look at the example below and make\nsure to read the observations after it:\n\n.. code:: python\n\n    import json\n\n    import scrapy\n    from scrapy.http.headers import Headers\n\n    RENDER_HTML_URL = \"http://127.0.0.1:8050/render.html\"\n\n    class MySpider(scrapy.Spider):\n        start_urls = [\"http://example.com\", \"http://example.com/foo\"]\n\n        def start_requests(self):\n            for url in self.start_urls:\n                body = json.dumps({\"url\": url, \"wait\": 0.5}, sort_keys=True)\n                headers = Headers({'Content-Type': 'application/json'})\n                yield scrapy.Request(RENDER_HTML_URL, self.parse, method=\"POST\",\n                                     body=body, headers=headers)\n\n        def parse(self, response):\n            # response.body is a result of render.html call; it\n            # contains HTML processed by a browser.\n            # ...\n\n\nIt works and is easy enough, but there are some issues that you should be\naware of:\n\n1. There is a bit of boilerplate.\n\n2. As seen by Scrapy, we're sending requests to ``RENDER_HTML_URL`` instead\n   of the target URLs. It affects concurrency and politeness settings:\n   ``CONCURRENT_REQUESTS_PER_DOMAIN``, ``DOWNLOAD_DELAY``, etc could behave\n   in unexpected ways since delays and concurrency settings are no longer\n   per-domain.\n\n3. As seen by Scrapy, response.url is an URL of the Splash server.\n   scrapy-splash fixes it to be an URL of a requested page.\n   \"Real\" URL is still available as ``response.real_url``. scrapy-splash also\n   allows to handle ``response.status`` and ``response.headers`` transparently\n   on Scrapy side.\n\n4. Some options depend on each other - for example, if you use timeout_\n   Splash option then you may want to set ``download_timeout``\n   scrapy.Request meta key as well.\n\n5. It is easy to get it subtly wrong - e.g. if you won't use\n   ``sort_keys=True`` argument when preparing JSON body then binary POST body\n   content could vary even if all keys and values are the same, and it means\n   dupefilter and cache will work incorrectly.\n\n6. Default Scrapy duplication filter doesn't take Splash specifics in\n   account. For example, if an URL is sent in a JSON POST request body\n   Scrapy will compute request fingerprint without canonicalizing this URL.\n\n7. Splash Bad Request (HTTP 400) errors are hard to debug because by default\n   response content is not displayed by Scrapy. SplashMiddleware logs content\n   of HTTP 400 Splash responses by default (it can be turned off by setting\n   ``SPLASH_LOG_400 = False`` option).\n\n8. Cookie handling is tedious to implement, and you can't use Scrapy\n   built-in Cookie middleware to handle cookies when working with Splash.\n\n9. Large Splash arguments which don't change with every request\n   (e.g. ``lua_source``) may take a lot of space when saved to Scrapy disk\n   request queues. ``scrapy-splash`` provides a way to store such static\n   parameters only once.\n\n10. Splash 2.1+ provides a way to save network traffic by caching large\n    static arguments on server, but it requires client support: client should\n    send proper ``save_args`` and ``load_args`` values and handle HTTP 498\n    responses.\n\nscrapy-splash utilities allow to handle such edge cases and reduce\nthe boilerplate.\n\n.. _HTTP API: http://splash.readthedocs.org/en/latest/api.html\n.. _timeout: http://splash.readthedocs.org/en/latest/api.html#arg-timeout\n\n\nGetting help\n============\n\n* for problems with rendering pages read \"`Splash FAQ`_\" page\n* for Scrapy-related bugs take a look at \"`reporting Scrapy bugs`_\" page\n\nBest approach to get any other help is to ask a question on `Stack Overflow`_\n\n.. _reporting Scrapy bugs: https://doc.scrapy.org/en/master/contributing.html#reporting-bugs\n.. _Splash FAQ: http://splash.readthedocs.io/en/stable/faq.html#website-is-not-rendered-correctly\n.. _Stack Overflow: https://stackoverflow.com/questions/tagged/scrapy-splash?sort=frequent\u0026pageSize=15\u0026mixed=1\n\n\nContributing\n============\n\nSource code and bug tracker are on github:\nhttps://github.com/scrapy-plugins/scrapy-splash\n\nTo run tests, install \"tox\" Python package and then run ``tox`` command\nfrom the source checkout.\n\nTo run integration tests, start Splash and set SPLASH_URL env variable\nto Splash address before running ``tox`` command::\n\n   docker run -d --rm -p8050:8050 scrapinghub/splash:3.0\n   SPLASH_URL=http://127.0.0.1:8050 tox -e py36\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrapy-plugins%2Fscrapy-splash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscrapy-plugins%2Fscrapy-splash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscrapy-plugins%2Fscrapy-splash/lists"}