{ "info": { "author": "Scrapy developers", "author_email": "info@scrapy.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Topic :: Internet :: WWW/HTTP" ], "description": "==============\nScrapyd-client\n==============\n\n.. image:: https://secure.travis-ci.org/scrapy/scrapyd-client.png?branch=master\n :target: http://travis-ci.org/scrapy/scrapyd-client\n\nScrapyd-client is a client for `scrapyd `_. It provides the ``scrapyd-deploy`` utility which allows you to deploy your project to a Scrapyd server.\n\n.. _how-it-works:\n\nHow It Works\n------------\n\nDeploying your project to a Scrapyd server typically involves two steps:\n\n1. `Eggifying `_ your project. You'll need to install `setuptools `_ for this. See `Egg Caveats`_ below.\n2. Uploading the egg to the Scrapyd server through the `addversion.json `_ endpoint.\n\nThe ``scrapyd-deploy`` tool automates the process of building the egg and pushing it to the target Scrapyd server.\n\n.. _targets:\n\nTargets\n-------\n\nYou can define Scrapyd targets in your project's ``scrapy.cfg`` file. Example::\n\n [deploy:example]\n url = http://scrapyd.example.com/api/scrapyd\n username = scrapy\n password = secret\n\nWhile your target needs to be defined with its URL in ``scrapy.cfg``, you can use `netrc `_ for username and password, like so::\n\n machine scrapyd.example.com\n username scrapy\n password secret\n\nIf you want to list all available targets, you can use the ``-l`` option::\n\n scrapyd-deploy -l\n\nTo list projects available on a specific target, use the ``-L`` option::\n\n scrapyd-deploy -L example\n\nDeploying a Project\n-------------------\n\nFirst ``cd`` into your project's root, you can then deploy your project with the following::\n\n scrapyd-deploy -p \n\nThis will eggify your project and upload it to the target. If you have a ``setup.py`` file in your project, it will be used, otherwise one will be created automatically. \n\nIf successful you should see a JSON response similar to the following::\n\n Deploying myproject-1287453519 to http://localhost:6800/addversion.json\n Server response (200):\n {\"status\": \"ok\", \"spiders\": [\"spider1\", \"spider2\"]}\n\nTo save yourself from having to specify the target and project, you can set the defaults in the ``scrapy.cfg`` file::\n\n [deploy]\n url = http://scrapyd.example.com/api/scrapyd\n username = scrapy\n password = secret\n project = yourproject\n\n\nYou can now deploy your project with just the following::\n\n scrapyd-deploy\n \nIf you have more than one target to deploy, you can deploy your project in all targets with one command::\n\n scrapyd-deploy -a -p \n\n.. _versioning:\n\nVersioning\n----------\n\nBy default, ``scrapyd-deploy`` uses the current timestamp for generating the project version, as shown above. However, you can pass a custom version using ``--version``::\n\n scrapyd-deploy -p --version \n\nOr for all targets::\n\n scrapyd-deploy -a -p --version \n\nThe version must be comparable with `LooseVersion `_. Scrapyd will use the greatest version unless specified.\n\nIf you use Mercurial or Git, you can use ``HG`` or ``GIT`` respectively as the argument supplied to ``--version`` to use the current revision as the version. You can save yourself having to specify the version parameter by adding it to your target's entry in ``scrapy.cfg``::\n\n [deploy:target]\n ...\n version = HG\n\n.. _local-settings:\n\nLocal Settings\n--------------\n\nYou may want to keep certain settings local and not have them deployed to Scrapyd. To accomplish this you can create a ``local_settings.py`` file at the root of your project, where your ``scrapy.cfg`` file resides, and add the following to your project's settings::\n\n try:\n from local_settings import *\n except ImportError:\n pass\n\n``scrapyd-deploy`` doesn't deploy anything outside of the project module, so the ``local_settings.py`` file won't be deployed.\n\n.. _egg-caveats:\n\nEgg Caveats\n-----------\n\nSome things to keep in mind when building eggs for your Scrapy project:\n\n* Make sure no local development settings are included in the egg when you build it. The ``find_packages`` function may be picking up your custom settings. In most cases you want to upload the egg with the default project settings.\n* You should avoid using ``__file__`` in your project code as it doesn't play well with eggs. Consider using `pkgutil.get_data() `_ instead.\n* Be careful when writing to disk in your project, as Scrapyd will most likely be running under a different user which may not have write access to certain directories. If you can, avoiding writing to disk and always use `tempfile `_ for temporary files.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/scrapy/scrapyd-client", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "scrapyd-client", "package_url": "https://pypi.org/project/scrapyd-client/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/scrapyd-client/", "project_urls": { "Homepage": "https://github.com/scrapy/scrapyd-client" }, "release_url": "https://pypi.org/project/scrapyd-client/1.1.0/", "requires_dist": null, "requires_python": "", "summary": "A client for scrapyd", "version": "1.1.0" }, "last_serial": 3120928, "releases": { "1.0": [], "1.0.1": [ { "comment_text": "", "digests": { "md5": "48b45fdd2514c780b64c077042fa46f9", "sha256": "8bd918d389806a7168b33003c16e41bb99f087edbaf4557642c018423dd70c1b" }, "downloads": -1, "filename": "scrapyd-client-1.0.1.tar.gz", "has_sig": false, "md5_digest": "48b45fdd2514c780b64c077042fa46f9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5432, "upload_time": "2015-04-09T20:37:14", "url": "https://files.pythonhosted.org/packages/4f/12/7b6929bd1089733fd1248408125be7e932cc43b397af053b1009a2d1e91e/scrapyd-client-1.0.1.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "614ad1c48b78cd71c931420fa1e93f3b", "sha256": "caa0f5369c2e1efa7b79c309afb9819b2518870c5f4f2caf84d3e474cd6a9890" }, "downloads": -1, "filename": "scrapyd_client-1.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "614ad1c48b78cd71c931420fa1e93f3b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13196, "upload_time": "2017-02-10T14:21:23", "url": "https://files.pythonhosted.org/packages/e1/76/3dd5fbe5c98436bb71d7212bf18233ae8519da0a7d03f541dafe0f91be6b/scrapyd_client-1.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "21429a56e9f83e9b1bce97dec1d84318", "sha256": "e547475c5c8dbd811e2cc4141a0e7b4ba47600e9980c59df4f831bb60b94e4cb" }, "downloads": -1, "filename": "scrapyd-client-1.1.0.tar.gz", "has_sig": false, "md5_digest": "21429a56e9f83e9b1bce97dec1d84318", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7823, "upload_time": "2017-02-10T14:21:12", "url": "https://files.pythonhosted.org/packages/78/5c/cee10ae5ec487a7da96dc6400fe60bd8bc90a8828ca5f50510c0c2b2d377/scrapyd-client-1.1.0.tar.gz" } ], "1.2.0a1": [ { "comment_text": "", "digests": { "md5": "448679e9b93772cc5a0815cba494d466", "sha256": "c5d742f2f6a551e1ba00b5423197fc1a7c2a09d64871b2c80707cb463d0df605" }, "downloads": -1, "filename": "scrapyd_client-1.2.0a1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "448679e9b93772cc5a0815cba494d466", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15121, "upload_time": "2017-08-24T16:43:54", "url": "https://files.pythonhosted.org/packages/1c/b4/1045eac8200331de05fb5ed548b62d2b2a5a757e73ffa2361e8d8fb33591/scrapyd_client-1.2.0a1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "54909f6cfa16db84105460db562c1184", "sha256": "9f4fcb8474e21703d7f1dd518d9c73740901e55c07a5311801b891f821931f2f" }, "downloads": -1, "filename": "scrapyd-client-1.2.0a1.tar.gz", "has_sig": false, "md5_digest": "54909f6cfa16db84105460db562c1184", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11311, "upload_time": "2017-08-24T16:43:55", "url": "https://files.pythonhosted.org/packages/f3/d7/81e212d7e18f5531dcd117faf9e8721fb67c49748046fcfb6c86960184df/scrapyd-client-1.2.0a1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "614ad1c48b78cd71c931420fa1e93f3b", "sha256": "caa0f5369c2e1efa7b79c309afb9819b2518870c5f4f2caf84d3e474cd6a9890" }, "downloads": -1, "filename": "scrapyd_client-1.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "614ad1c48b78cd71c931420fa1e93f3b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13196, "upload_time": "2017-02-10T14:21:23", "url": "https://files.pythonhosted.org/packages/e1/76/3dd5fbe5c98436bb71d7212bf18233ae8519da0a7d03f541dafe0f91be6b/scrapyd_client-1.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "21429a56e9f83e9b1bce97dec1d84318", "sha256": "e547475c5c8dbd811e2cc4141a0e7b4ba47600e9980c59df4f831bb60b94e4cb" }, "downloads": -1, "filename": "scrapyd-client-1.1.0.tar.gz", "has_sig": false, "md5_digest": "21429a56e9f83e9b1bce97dec1d84318", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7823, "upload_time": "2017-02-10T14:21:12", "url": "https://files.pythonhosted.org/packages/78/5c/cee10ae5ec487a7da96dc6400fe60bd8bc90a8828ca5f50510c0c2b2d377/scrapyd-client-1.1.0.tar.gz" } ] }