Skip to content

Commit

Permalink
Add documentation and rename things properly
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicolas Kuttler committed Feb 25, 2012
1 parent 79eda8f commit f58f2fd
Show file tree
Hide file tree
Showing 9 changed files with 64 additions and 29 deletions.
26 changes: 26 additions & 0 deletions LICENSE
Original file line number Original file line Diff line number Diff line change
@@ -0,0 +1,26 @@
Copyright (c) Nicolas Kuttler.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
37 changes: 37 additions & 0 deletions README.rst
Original file line number Original file line Diff line number Diff line change
@@ -0,0 +1,37 @@
===========
README
===========

This django application allows various webmaster tools to quickly verify that the site is managed by you.

Currently Google and Bing webmaster tools are supported.

Usage
-----

Get ``django-webmaster-verification`` into your python path::

pip install django-webmaster-verification
Add ``webmaster_verification`` to your INSTALLED_APPS in settings.py::

INSTALLED_APPS = (
...
'webmaster_verification',
...
)
Add ``wembaster_verification`` to your root urlconf (urls.py)::

urlpatterns = patterns('',
...,
url(r'', include('webmaster_verification.urls')),
...,
)

Add settings just as::

WEBMASTER_VERIFICATION = {
'google': '<google verification code>',
'bing': '<bing verification code>',
}
3 changes: 0 additions & 3 deletions models.py

This file was deleted.

25 changes: 0 additions & 25 deletions tests.py

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion views.py → webmaster_verification/views.py
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class VerificationView(TemplateView):
def get_context_data(self, **kwargs): def get_context_data(self, **kwargs):
context = super(VerificationView, self).get_context_data(**kwargs) context = super(VerificationView, self).get_context_data(**kwargs)
try: try:
context['%s_verification' % self.provider] = settings.VERIFICATION[self.provider] context['%s_verification' % self.provider] = settings.WEBMASTER_VERIFICATION[self.provider]
except KeyError: except KeyError:
raise Http404 raise Http404
return context return context
Expand Down

0 comments on commit f58f2fd

Please sign in to comment.