Merge pull request #48 from scrapinghub/sc1467-fixes

Improvements and fixes for new python client

Author: chekunkov

README.rst

@@ -74,8 +74,8 @@ And select a particular project to work with::
     >>> project = client.get_project(123)
     >>> project
     <scrapinghub.client.Project at 0x106cdd6a0>
-    >>> project.id
-    123
+    >>> project.key
+    '123'
 
 The above is a shortcut for ``client.projects.get(123)``.
 
@@ -88,7 +88,7 @@ Jobs instance is described well in ``Jobs`` section below.
 
 For example, to schedule a spider run (it returns a job object)::
 
-    >>> project.jobs.schedule('spider1', arg1='val1')
+    >>> project.jobs.schedule('spider1', spider_args={'arg1':'val1'})
     <scrapinghub.client.Job at 0x106ee12e8>>
 
 Project instance also has the following fields:
@@ -116,8 +116,8 @@ To select a particular spider to work with::
     >>> spider = project.spiders.get('spider2')
     >>> spider
     <scrapinghub.client.Spider at 0x106ee3748>
-    >>> spider.id
-    2
+    >>> spider.key
+    '123/2'
     >>> spider.name
     spider2
 
@@ -128,7 +128,7 @@ Like project instance, spider instance has ``jobs`` field to work with the spide
 
 To schedule a spider run::
 
-    >>> spider.jobs.schedule(arg1='val1')
+    >>> spider.jobs.schedule(spider_args={'arg1:'val1'})
     <scrapinghub.client.Job at 0x106ee12e8>>
 
 Note that you don't need to specify spider name explicitly.
@@ -144,7 +144,7 @@ get
 To select a specific job for a project::
 
     >>> job = project.jobs.get('123/1/2')
-    >>> job.id
+    >>> job.key
     '123/1/2'
 
 Also there's a shortcut to get same job with client instance::
@@ -160,6 +160,7 @@ Use ``schedule`` method to schedule a new job for project/spider::
 
 Scheduling logic supports different options, like
 
+- spider_args to provide spider arguments for the job
 - units to specify amount of units to schedule the job
 - job_settings to pass additional settings for the job
 - priority to set higher/lower priority of the job

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+addopts = --doctest-glob='scrapinghub/*.py'