Django Crawler

The code

You can find the code on github:

The mailing list for the project is on Google Groups:


The crawler is implemented as a management command.

Step 1: pip install -e git://

Step 2: Add crawler to your INSTALLED_APPS

Step 3: The syntax for invoking the crawler looks like:

./ crawl [options] [relative_start_url]


Running a simple ./ crawl will work.

Relative start URLs are assumed to be relative to the site root and should look like ‘some/path’, ‘home’, or even ‘/’. The relative start URL will be normalized with leading and trailing slashes if they are not provided. The default relative start URL is ‘/’.

The crawler crawls your site using the Django Test Client (so no network traffic is required!) This allows the crawler to have intimate knowledge of your Django Code. This allows it to have features that other crawlers can’t have.


The main functionality of Crawler is implemented through plugins.

Global Options

-v –verbosity [0,1,2,3]

Same as most django apps. Set it to 2 to get a lot of output. 1 is the default, which will only output errors.

Setting output to 3 will show possibly really verbose debug output. This includes links that go over the depth allowed, and external links in your HTML.