From e7da720c39c4835b509e7b6516851fef1866f63d Mon Sep 17 00:00:00 2001 From: andybak Date: Mon, 24 Aug 2009 09:30:17 -0700 Subject: [PATCH] github generated gh-pages branch --- index.html | 119 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 119 insertions(+) create mode 100644 index.html diff --git a/index.html b/index.html new file mode 100644 index 0000000..f32976b --- /dev/null +++ b/index.html @@ -0,0 +1,119 @@ + + + + + + + andybak/django-linkcheck @ GitHub + + + + + + + Fork me on GitHub + +
+ +
+ + + + +
+ +

django-linkcheck + by andybak

+ +
+ An app that will analyze and report on links in any model that you register with it. +
+ +

http://cms.andybak.webfactional.com/media/linkcheck.jpg + +A fairly flexible app that will analyze and report on links in any model that you register with it. Links can be bare (urls or image and file fields) or embedded in HTML (linkcheck handles the parsing). It's fairly easy to override methods of the Linkcheck object should you need to do anything more complicated (like generate URLs from slug fields etc). + +The current version does all the finding and checking of links as a bulk job you can run from cron but it's fairly easy to hook up signals to your model's save and delete to keep the data updated once an initial sweep has been done. + +Another future enhancement would be the ability to automatically fix links when the related object is changed. + +This is working code but it currently comes with a few caveats: + + # It's been extracted from my homespun CMS and in some places that still shows. + # No tests :( + # Few comments or docstrings :( + # The documentation was rather a rush job :( + +Yes I'm a bad person. I'm putting this out there because doing so might inspire someone - hopefully me - to fix the above issues.

Dependencies

+

Jquery (my base admin template already links to it. If your's doesn't then add it to base_linkcheck.html +

+

Install

+

1. Install app to somewhere on your Python path +2. Edit examples/linkcheck_config.py to include references to all your models that might contain links. +3. Add something along the lines of linklists.py to every app you referenced in linkcheck_config.py +4. Import linkcheck_config.py from your root urls. +5. Syncdb +6. Run findlinks management command or the utils.find() +7. Run checklinks management command or the utils.check() +8. Add (r'^admin/linkcheck/', include('linkcheck.urls')) to your root url config +9. View /admin/linkcheck/ from your browser +

+

License

+

New BSD License

+

Authors

+

andybak (andy@andybak.net)

+

Contact

+

Andy Baker (andy@andybak.net)

+ + +

Download

+

+ You can download this project in either + zip or + tar formats. +

+

You can also clone the project with Git + by running: + 

$ git clone git://github.com/andybak/django-linkcheck
+

+ +
+ get the source code on GitHub : andybak/django-linkcheck +
+ +
+ + + + +