Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

v0.7.1 doc update, also forgot to commit the version info on the last…

… commit
  • Loading branch information...
commit 2d19ed00f9c56bc700613cbea933e438de211e6c 1 parent 62497bd
@dmclain authored
Showing with 34 additions and 3 deletions.
  1. +33 −2 README.md
  2. +1 −1  scrapy_heroku/__init__.py
View
35 README.md
@@ -1,4 +1,35 @@
-A package to assist with running scrapy on heroku. Mainly provides a scrapyd script that respects
-PORT and a ISpiderQueue implementation that uses heroku's postgres implementation
+Scrapy-Heroku
+=============
+
+A package to assist with running scrapy on heroku. This is accomplished by providing
+a custom application configuration at ``scrapy_heroku.app.application`` that launches
+the scrapyd web service using the PORT environment variable and a multi-process work
+queue implemented on a Postgres database specified by the DATABASE_URL environment
+variable.
+
+Configuration
+-------------
+
+Create a git repo that has a scrapy project at the root (scrapy.cfg should be at the
+top level). Edit your scrapy.cfg to include the following::
+
+ [scrapyd]
+ application = scrapy_heroku.app.application
+
+ [deploy]
+ url = http://<YOUR_HEROKU_APP_NAME>.herokuapp.com:80/
+ project = <YOUR_PROJECT_NAME>
+ username = <A_USER_NAME>
+ password = <A_PASSWORD>
+
+Add a requirements.txt file that includes ``scrapy-heroku`` in it. It is strongly
+recommended that you version pin scrapy-heroku as well as the version of scrapy that
+your project is developed against (pip freeze > requirements.txt). Finally create a
+Procfile that consists of::
+
+ web: scrapy server
+
+Make sure you have a postgres database that has been promoted to DATABASE_URL
+
* Project page: <http://github.com/dmclain/scrapy-heroku>
View
2  scrapy_heroku/__init__.py
@@ -1,2 +1,2 @@
-__version__ = (0, 6, 0)
+__version__ = (0, 7, 1)
Please sign in to comment.
Something went wrong with that request. Please try again.