Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A Django app for performing Akamai CCUAPI purge requests
Python
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
django_akamai
LICENSE.txt
MANIFEST.in
README.rst
setup.py

README.rst

django-akamai

Dependencies: requests (required), django-celery (optional)

django-akamai serves as a means to perform purge requests from Django apps using the Akamai REST API. Purge requests are performed on demand or, optionally, placed in a queue using Celery.

Required settings:

AKAMAI_CCUAPI_USERNAME = 'ccuapi_username'
AKAMAI_CCUAPI_PASSWORD = 'ccuapi_password'

There are a variety of ways to use this app in your app.

PLEASE NOTE: Currently, only 200 URLs will be purged per request, requiring that you send additional signals/create additional tasks/call purge() again with separate chunks of URLs/objects.

Consult Akamai's documentation for full information about the API:

https://api.ccu.akamai.com/ccu/v2/docs/

Using Signals

signals.py defines two signals, one that initiates a purge request directly, and another that queues the request. The queueing signal is conditionally defined and depends on the successful import of PurgeRequestTask, which depends on django-celery being installed.

When sending these signals from other apps, you can pass in a variety of things as the sender for convenience. Sender can be a single URL string, a list of URL strings, an individual Django object, or a QuerySet. If passing in an object or QuerySet, then get_absolute_url() must be defined on every object.

Example of signalling to immediately perform the request:

>>> from akamai.signals import purge_request, queue_purge_request
>>> obj = MyObject.objects.get(pk=3)
>>> obj.get_absolute_url()
u'http://www.example.com/blahblah.html'
>>> purge_request.send(obj)

Or, to queue the request using Celery:

>>> queue_purge_request.send(obj)

Using Tasks

To use the task directly, import PurgeRequestTask from tasks.py thusly:

>>> from akamai.tasks import PurgeRequestTask
>>> obj = MyObject.objects.get(pk=3)
>>> result = PurgeRequestTask.delay(obj)
>>> print result
1

Using PurgeRequest directly

You may also import PurgeRequest from purge.py and use it directly. Not that only 200 urls will be sent with each purge request, due to limits set by Akamai. If you add more than 200 urls, purge() will need to be called until none remain. Calling purge_all() will issue as many requests as needed for the full list, possibly taking a significant amount of time before returning.

If you don't provide a username and password when creating the PurgeRequest object, then your project's settings.py will be checked for AKAMAI_CCUAPI_USERNAME and AKAMAI_CCUAPI_PASSWORD. Failure to provide login info via either mechanism results in a NoAkamaiUsernameProvidedException and/or NoAkamaiPasswordProvidedException.

Example:

>>> pr = PurgeRequest(username="ccuapi_user", password="1234567")
>>> pr.add("http://www.example.com/url-1.html")
>>> pr.add(u"http://www.example.com/url-2.html")
>>> req = pr.purge()
>>> print pr.last_result
(PurgeResult){
   resultCode = 100
   resultMsg = "Success."
   sessionID = "987654321"
   estTime = 420
   uriIndex = -1
   modifiers[] = <empty>
 }
>>> print pr.urls
[]
Something went wrong with that request. Please try again.