A simple Django app to provide access to a robots.txt file
Project description
# Django-roberts
A simple Django app to serve a robots.txt file.
## Installation
Use your favorite Python installer to install it from PyPI:
pip install django-roberts
Or get the source from the application site:
hg clone https://bitbucket.org/mhurt/django-roberts
The `robots` package, included in the distribution, should be placed on the `PYTHONPATH`.
## Configuration
Include the package's url patterns in your root urlconf:
url(r'', include('robots.urls')),
Add `robots` to your `INSTALLED_APPS` setting.
If your run Django's development server you should now be able to see the example robots.txt file at
http://127.0.0.1:8000/robots.txt
If you don't wish to use the supplied templates you can simply:
1. Remove `robots` from your `INSTALLED_APPS` setting;
2. Create your own template using the default location `robots/robots.txt`
## Extras
For convenience the package defines the usable combinations of robots directives which can be used in your views and templates.
In your view:
# views.py
import robots
class MyView(ListView):
meta_robots = robots.NOINDEX_FOLLOW
...
...
In your base template:
# base.html
<html>
<head>
...
{% include 'robots/meta_robots.html' %}
<!-- OR -->
{% if view.meta_robots %}
<meta name="robots" content="{{ view.meta_robots }}">
{% endif %}
A simple Django app to serve a robots.txt file.
## Installation
Use your favorite Python installer to install it from PyPI:
pip install django-roberts
Or get the source from the application site:
hg clone https://bitbucket.org/mhurt/django-roberts
The `robots` package, included in the distribution, should be placed on the `PYTHONPATH`.
## Configuration
Include the package's url patterns in your root urlconf:
url(r'', include('robots.urls')),
Add `robots` to your `INSTALLED_APPS` setting.
If your run Django's development server you should now be able to see the example robots.txt file at
http://127.0.0.1:8000/robots.txt
If you don't wish to use the supplied templates you can simply:
1. Remove `robots` from your `INSTALLED_APPS` setting;
2. Create your own template using the default location `robots/robots.txt`
## Extras
For convenience the package defines the usable combinations of robots directives which can be used in your views and templates.
In your view:
# views.py
import robots
class MyView(ListView):
meta_robots = robots.NOINDEX_FOLLOW
...
...
In your base template:
# base.html
<html>
<head>
...
{% include 'robots/meta_robots.html' %}
<!-- OR -->
{% if view.meta_robots %}
<meta name="robots" content="{{ view.meta_robots }}">
{% endif %}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-roberts-0.1.0.tar.gz
(3.0 kB
view hashes)