Welcome to django-sheets’s documentation!¶

Installation¶

To install the latest release from PyPI using pip:

$ pip install django-sheets

Add sheets to INSTALLED_APPS in settings.py:

INSTALLED_APPS = (
    ...
    'sheets',
    ...
)

Configuration¶

Provided your Django project has a working cache backend, django-sheets will cache requests to the Google Sheets API for 5 minutes.

• Performance- making an extra HTTP request per page-view (or more) will lead to poor response times.
• Reliability- The Google Sheets API may experience failing requests- having a cached copy on your servers means this is less likely to affect you.
• Exceeding quota- By making excessive requests you risk exceeding the API Quota and having requests denied until the quota is refreshed, making your page unusable.

If you wish to disable this cache, add to your settings file:

SHEETS_CACHE_DISABLED = True

You can lower the cache timeout if you wish to sacrifice performance to lessen the chance of stale data, or extend it to improve performance and reduce server load:

# Set timeout to 1 hour
SHEETS_CACHE_TIMEOUT = 3600

Usage¶

To use django-sheets, you need to have a key to a publically-accessible Google Sheets spreadsheet. To find it, open your sheet and select File -> Share. Click Get sharable link from the dialog. You’ll find the 44-character key as part of the URL.

For example, the sample link https://docs.google.com/spreadsheets/d/1bJNR7SLqpzWJNvstNcFR4gtS-M7Bmn0D1X2lGTJPvGM/pubhtml has key 1bJNR7SLqpzWJNvstNcFR4gtS-M7Bmn0D1X2lGTJPvGM

Load the django-sheets template tags in your template:

{% load sheets %}

Assign the CSV data to a variable using the {% csv %} tag:

{% csv <key> as <variable_name> %}

Try it using the sample key above:

{% load sheets %}
{% csv "1uPsdcGUnUsf3d2xGHRGUUb7_k5IQPtBvfQY61u8Z8wE" as data %}
<table>
    <thead>
        <tr>
        {% for header in data.headers %}
            <th>{{ header }}</th>
        {% endfor %}
        </tr>
    </thead>
    <tbody>
        {% for row in data.rows %}
        <tr>
            {% for cell in row %}
                <td>{{ cell }}</td>
            {% endfor %}
        </tr>
        {% endfor %}
    </tbody>
</table>

View the output, you should see

{% csv <key> gid=<gid> as <variable_name> %}

Credits¶

History¶