django-linkcheck 1.9

Minimal requirements

django-linkchecks requires Python 3 and Django 2.2.

Basic usage

1. Install app to somewhere on your Python path (e.g. pip install django-linkcheck).

2. Add 'linkcheck' to your settings.INSTALLED_APPS.

3. Add a file named linklists.py to every app (see an example in examples/linklists.py) that either:

   1. has models that contain content (e.g. url/image fields, chunks of markup or anything that gets transformed into a IMG or HREF when displayed

   2. can be the target of a link - i.e. is addressed by a url - in this case make sure it has an instance method named ‘get_absolute_url’

4. Run ./manage.py migrate.

5. Add to your root url config:

   path('admin/linkcheck/', include('linkcheck.urls'))

6. View /admin/linkcheck/ from your browser.

We are aware that this documentation is on the brief side of things so any suggestions for elaboration or clarification would be gratefully accepted.

Linklist classes

The following class attributes can be added to your Linklist subclasses to customize the extracted links:

object_filter: a dictionary which will be passed as a filter argument to the filter applied to the default queryset of the target class. This allows you to filter the objects from which the links will be extracted. (example: {'active': True})

object_exclude: a dictionary which will be passed as a filter argument to the exclude applied to the default queryset of the target class. As with object_filter, this allows you to exclude objects from which the links will be extracted.

html_fields: a list of field names which will be searched for links.

url_fields: a list of URLField field names whose content will be considered as links. If the field content is empty and the field name is in ignore_empty, the content is ignored.

ignore_empty: a list of fields from url_fields. See the explanation above. (new in django-linkcheck 1.1)

image_fields: a list of ImageField field names whose content will be considered as links. Empty ImageField content is always ignored.

Management commands

Settings

django-filebrowser integration

If django-filebrowser is present on your path then linkcheck will listen to the post-upload, delete and rename signals and update itself according

Running tests

Tests can be run standalone by using the runtests.py script in linkcheck root:

$ python runtests.py

If you want to run linkcheck tests in the context of your project, you should include ‘linkcheck.tests.sampleapp’ in your INSTALLED_APPS setting.

Linkcheck gives you two context managers to enable or disable listeners in your own tests. For example:

def test_something_without_listeners(self):

with listeners.disable_listeners():

# Create/update here without linkcheck intervening.

In the case you defined the LINKCHECK_DISABLE_LISTENERS setting, you can temporarily enable it by:

def test_something_with_listeners(self):

with listeners.enable_listeners():

# Create/update here and see linkcheck activated.