python-scrapyd-api 2.1.0

A Python wrapper for working with the Scrapyd API

==================
python-scrapyd-api
==================

.. image:: https://badge.fury.io/py/python-scrapyd-api.png
:target: http://badge.fury.io/py/python-scrapyd-api
:alt: The PyPI version

.. image:: https://travis-ci.org/djm/python-scrapyd-api.png?branch=master
:target: https://travis-ci.org/djm/python-scrapyd-api
:alt: Built Status on Travis-CI

.. image:: https://coveralls.io/repos/djm/python-scrapyd-api/badge.png
:target: https://coveralls.io/r/djm/python-scrapyd-api
:alt: Coverage Status on Coveralls

.. image:: https://readthedocs.org/projects/python-scrapyd-api/badge/?version=latest
:target: http://python-scrapyd-api.readthedocs.org/en/latest/
:alt: Documentation Status on ReadTheDocs


A Python wrapper for working with Scrapyd_'s API_.

Current released version: 2.1.0 (see history_).

Allows a Python application to talk to, and therefore control, the Scrapy_
daemon: Scrapyd_.

* Supports Python 2.6, 2.7, 3.3 & 3.4
* Free software: BSD license
* `Full documentation`_
* On the `Python Package Index (PyPI)`_
* Scrapyd's `API Documentation`_

.. _Scrapy: http://scrapy.org/
.. _Scrapyd: https://github.com/scrapy/scrapyd
.. _API: http://scrapyd.readthedocs.org/en/latest/api.html
.. _history: https://github.com/djm/python-scrapyd-api/blob/master/HISTORY.rst
.. _Python Package Index (PyPI): https://pypi.python.org/pypi/python-scrapyd-api/
.. _Full documentation: http://python-scrapyd-api.rtfd.org
.. _API Documentation: http://scrapyd.readthedocs.org/en/latest/api.html

Install
-------

Easiest installation is via `pip`::

pip install python-scrapyd-api

Quick Usage
-----------

Please refer to the full documentation_ for more detailed usage but to get you started:

.. code:: python

>>> from scrapyd_api import ScrapydAPI
>>> scrapyd = ScrapydAPI('http://localhost:6800')

.. _documentation: http://python-scrapyd-api.rtfd.org

**Add a project** egg as a new version:

.. code:: python

>>> egg = open('some_egg.egg', 'rb')
>>> scrapyd.add_version('project_name', 'version_name', egg)
# Returns the number of spiders in the project.
3
>>> egg.close()

**Cancel a scheduled job**:

.. code:: python

>>> scrapyd.cancel('project_name', '14a6599ef67111e38a0e080027880ca6')
# Returns the "previous state" of the job before it was cancelled: 'running' or 'pending'.
'running'

**Delete a project** and all sibling versions:

.. code:: python

>>> scrapyd.delete_project('project_name')
# Returns True if the request was met with an OK response.
True

**Delete a version** of a project:

.. code:: python

>>> scrapyd.delete_version('project_name', 'version_name')
# Returns True if the request was met with an OK response.
True

**Request status** of a job:

.. code:: python

>>> scrapyd.job_status('project_name', '14a6599ef67111e38a0e080027880ca6')
# Returns 'running', 'pending', 'finished' or '' for unknown state.
'running'

**List all jobs** registered:

.. code:: python

>>> scrapyd.list_jobs('project_name')
# Returns a dict of running, finished and pending job lists.
{
'pending': [
{
u'id': u'24c35...f12ae',
u'spider': u'spider_name'
},
],
'running': [
{
u'id': u'14a65...b27ce',
u'spider': u'spider_name',
u'start_time': u'2014-06-17 22:45:31.975358'
},
],
'finished': [
{
u'id': u'34c23...b21ba',
u'spider': u'spider_name',
u'start_time': u'2014-06-17 22:45:31.975358',
u'end_time': u'2014-06-23 14:01:18.209680'
}
]
}

**List all projects** registered:

.. code:: python

>>> scrapyd.list_projects()
[u'ecom_project', u'estate_agent_project', u'car_project']

**List all spiders** available to a given project:

.. code:: python

>>> scrapyd.list_spiders('project_name')
[u'raw_spider', u'js_enhanced_spider', u'selenium_spider']

**List all versions** registered to a given project:

.. code:: python

>>> scrapyd.list_versions('project_name'):
[u'345', u'346', u'347', u'348']

**Schedule a job** to run with a specific spider:

.. code:: python

# Schedule a job to run with a specific spider.
>>> scrapyd.schedule('project_name', 'spider_name')
# Returns the Scrapyd job id.
u'14a6599ef67111e38a0e080027880ca6'

**Schedule a job** to run while passing override settings:

.. code:: python

>>> settings = {'DOWNLOAD_DELAY': 2}
>>> scrapyd.schedule('project_name', 'spider_name', settings=settings)
u'25b6588ef67333e38a0e080027880de7'

**Schedule a job** to run while passing extra attributes to spider initialisation:

.. code:: python

>>> scrapyd.schedule('project_name', 'spider_name', extra_attribute='value')
# NB: 'project', 'spider' and 'settings' are reserved kwargs for this
# method and therefore these names should be avoided when trying to pass
# extra attributes to the spider init.
u'25b6588ef67333e38a0e080027880de7'


Setting up the project to contribute code
-----------------------------------------

Please see CONTRIBUTING.rst_ which is also mirrored in the `full documentation`_.
This will guide you through our pull request guidelines, project setup and
testing requirements.

.. _CONTRIBUTING.rst: https://github.com/djm/python-scrapyd-api/blob/master/CONTRIBUTING.rst
.. _full documentation: http://python-scrapyd-api.rtfd.org


License
-------

2-clause BSD. See the full LICENSE_.

.. _LICENSE: https://github.com/djm/python-scrapyd-api/blob/master/LICENSE




History
-------

2.1.0 (2018-03-31)
++++++++++++++++++

* Introduces the `timeout` keyword argument, which allows the caller to specify
a timeout after which requests to the scrapyd server give up. This works as
per the underlying `requests` library, and raises `requests.exceptions.Timeout`
when the timeout is exceeded. See docs for usage.


2.0.1 (2016-02-27)
++++++++++++++++++

v2.0.0 shipped with docs which were slightly out of date for the cancel
endpoint, this release corrects that.

2.0.0 (2016-02-27)
++++++++++++++++++

Why Version 2? This package has been production ready and stable in use
for over a year now, so it's ready to commit to a stable API /w semver.
Version 1 has deliberately been skipped to make it absolutely clear that
this release contains a breaking change:

Breaking changes:

* The cancel job endpoint now returns the previous state of the successfully
cancelled spider rather than a simple boolean True/False. This change was
made because:
a) the boolean return was relatively useless and actually hiding data the
scrapyd API passes us as part of the cancel endpoint response.
b) before this change, the method would have returned `True` only if the
cancelled job was previously running, and this resulted in us incorrectly
reporting `False` when a *pending* job was cancelled.
This may require no changes to your codebase but nevertheless it is a change
in a public API, thus the requirement for major version bumping.

Other changes:

* The cancel job endpoint now accepts a `signal` keyword argument which is
the termination signal Scrapyd uses to cancel the spider job. If not
specified, the value is not sent to the scrapyd endpoint at all, therefore
allows scrapyd control over which default signal gets used (currently `TERM`).


0.2.0 (2015-01-14)
++++++++++++++++++

* Added the new ``job_status`` method which can retrieve the job status of a
specific job from a project. See docs for usage.
* Increased and improved test coverage.

0.1.0 (2014-09-16)
++++++++++++++++++

* First release on PyPI.