Use run endpoint instead of schedule

Author: vshlapakov

README.rst

@@ -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', job_args={'arg1':'val1'})
+    >>> project.jobs.run('spider1', job_args={'arg1':'val1'})
     <scrapinghub.client.Job at 0x106ee12e8>>
 
 Project instance also has the following fields:
@@ -151,7 +151,7 @@ Like project instance, spider instance has ``jobs`` field to work with the spide
 
 To schedule a spider run::
 
-    >>> spider.jobs.schedule(job_args={'arg1:'val1'})
+    >>> spider.jobs.run(job_args={'arg1:'val1'})
     <scrapinghub.client.Job at 0x106ee12e8>>
 
 Note that you don't need to specify spider name explicitly.
@@ -174,30 +174,30 @@ Also there's a shortcut to get same job with client instance::
 
     >>> job = client.get_job('123/1/2')
 
-schedule
-^^^^^^^^
+run
+^^^
 
-Use ``schedule`` method to schedule a new job for project/spider::
+Use ``run`` method to run a new job for project/spider::
 
-    >>> job = spider.jobs.schedule()
+    >>> job = spider.jobs.run()
 
 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
+- units to specify amount of units to run the job
 - job_settings to pass additional settings for the job
 - priority to set higher/lower priority of the job
 - add_tag to create a job with a set of initial tags
 - meta to pass additional custom metadata
 
-For example, to schedule a new job for a given spider with custom params::
+For example, to run a new job for a given spider with custom params::
 
-    >>> job = spider.jobs.schedule(units=2, job_settings={'SETTING': 'VALUE'},
+    >>> job = spider.jobs.run(units=2, job_settings={'SETTING': 'VALUE'},
         priority=1, add_tag=['tagA','tagB'], meta={'custom-data': 'val1'})
 
-Note that if you schedule a job on project level, spider name is required::
+Note that if you run a job on project level, spider name is required::
 
-    >>> job = project.jobs.schedule('spider1')
+    >>> job = project.jobs.run('spider1')
 
 count
 ^^^^^

scrapinghub/client/jobs.py

@@ -179,9 +179,9 @@ def list(self, count=None, start=None, spider=None, state=None,
                       lacks_tag=lacks_tag, startts=startts, endts=endts)
         return list(self.iter(**params))
 
-    def schedule(self, spider=None, units=None, priority=None, meta=None,
-                 add_tag=None, job_args=None, job_settings=None, cmd_args=None,
-                 **params):
+    def run(self, spider=None, units=None, priority=None, meta=None,
+            add_tag=None, job_args=None, job_settings=None, cmd_args=None,
+            **params):
         """Schedule a new job and returns its job key.
 
         :param spider: a spider name string
@@ -200,7 +200,7 @@ def schedule(self, spider=None, units=None, priority=None, meta=None,
 
         Usage::
 
-            >>> project.jobs.schedule('spider1', job_args={'arg1': 'val1'})
+            >>> project.jobs.run('spider1', job_args={'arg1': 'val1'})
             '123/1/1'
         """
         if not spider and not self.spider:
@@ -218,10 +218,9 @@ def schedule(self, spider=None, units=None, priority=None, meta=None,
         update_kwargs(params, units=units, priority=priority, add_tag=add_tag,
                       cmd_args=cmd_args, job_settings=job_settings, meta=meta)
 
-        # FIXME improve to schedule multiple jobs
+        # FIXME improve to run multiple jobs
         try:
-            response = self._client._connection._post(
-                'schedule', 'json', params)
+            response = self._client._connection._post('run', 'json', params)
         except BadRequest as exc:
             if 'already scheduled' in str(exc):
                 raise DuplicateJobError(exc)

scrapinghub/client/projects.py

@@ -71,7 +71,7 @@ def summary(self, state=None, **params):
         :param state: a string state or a list of states.
         :return: a list of dictionaries: each dictionary represents a project
             summary (amount of pending/running/finished jobs and a flag if it
-            has a capacity to schedule new jobs).
+            has a capacity to run new jobs).
         :rtype: list[dict]
 
         Usage::

scrapinghub/legacy.py

@@ -45,7 +45,8 @@ class Connection(object):
         'eggs_list': 'eggs/list',
         'as_project_slybot': 'as/project-slybot',
         'as_spider_properties': 'as/spider-properties',
-        'schedule': 'schedule',
+        'run': 'run',
+        'schedule': 'schedule',  # deprecated in favour of run
         'items': 'items',
         'log': 'log',
         'spiders': 'spiders/list',