Commits

Evgeniy Tatarkin committed 1594fc2

docs for engine

  • Participants
  • Parent commits 83425a8

Comments (0)

Files changed (2)

File docs/api.rst

 .. automodule:: pomp.contrib
     :members: 
 
+Engine
+******
+
+.. automodule:: pomp.core.engine
+    :members:
+
+
 Interfaces
 **********
 

File pomp/core/engine.py

 
 
 class Pomp(object):
+    """Configuration object
+
+    Main goal of class is to glue together all parts of application:
+
+    - Downloader implementation with middlewares
+    - Item pipelines
+    - Crawler
+    
+    :param downloader: :class:`pomp.core.base.BaseDownloader`
+    :param pipelines: list of item pipelines :class:`pomp.core.base.BasePipeline`
+    """
 
     def __init__(self, downloader, pipelines=None):
 
             return urls
 
     def pump(self, crawler):
+        """Start crawling
+        
+        :param crawler: crawler to execute :class:`pomp.core.base.BaseCrawler`
+        """
 
         log.info('Prepare downloader: %s', self.downloader)
         self.downloader.prepare()