Skip to content

Commit

Permalink
Version bump.
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh Mervine committed Jan 7, 2015
1 parent c4e04e7 commit da475b6
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 14 deletions.
34 changes: 21 additions & 13 deletions README.text
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
.. contents::
:depth: 3.0
..

MaxCDN is Hiring!
=================

Do you like building cool stuff? Do APIs keep you up at night? We're
looking for our next superstar hacker and you could be it. Interested?
Check out our job posting on
`stackoverflow <http://careers.stackoverflow.com/jobs/37078/senior-web-engineer-for-fun-growing-la-startup-maxcdn&a=JdFbT4OY>`_.
`stackoverflow <http://careers.stackoverflow.com/jobs/37078/senior-web-engineer-for-fun-growing-la-startup-maxcdn&a=JdFbT4OY>`__.

MaxCDN REST Web Services Python Client
======================================
Expand All @@ -20,7 +24,7 @@ Installation
Usage
-----

::
.. code:: python

from maxcdn import MaxCDN

Expand Down Expand Up @@ -50,7 +54,7 @@ signed requests.
We now have a shortcut for Purge Calls!
---------------------------------------

::
.. code:: python

zone_id = 12345

Expand All @@ -63,18 +67,21 @@ We now have a shortcut for Purge Calls!
# Purge Files
api.purge(zone_id, ['/some_file', '/another_file'])

Every request can take an optional debug parameter. \`\`\`python
api.get("/account.json", debug=True) # Will output # Making GET request
to http://rws.netdna.com/myalias/account.json #{... API Returned Stuff
...}
Every request can take an optional debug parameter.

Every request can also take an optional debug\_json parameter if you
don't like the exception based errors. api.get('/account.json',
debug\_json=True) \`\`\`
.. code:: python

api.get("/account.json", debug=True)
# Will output
# Making GET request to http://rws.netdna.com/myalias/account.json
#{... API Returned Stuff ...}

Every request can also take an optional debug_json parameter if you don't like the exception based errors.
api.get('/account.json', debug_json=True)

For more information about what optional parameters this methods accept
you should check out `@kennethreitz <http://github.com/kennethreitz>`_
library `Requests <https://github.com/kennethreitz/requests>`_.
you should check out [@kennethreitz](http://github.com/kennethreitz)
library `Requests <https://github.com/kennethreitz/requests>`__.

Initialization
--------------
Expand All @@ -85,7 +92,7 @@ default initialization as the example above.
For applications that require user authentication, you can initialize
the API as follows.

::
.. code:: python

api = MaxCDN("myalias", "consumer_key", "consumer_secret",
token="user_token", token_secret="user_token_secret")
Expand Down Expand Up @@ -127,3 +134,4 @@ Running examples:
./examples/report.py # [hourly|daily|monthly]
./examples/purge.py # [zoneid]

:target: https://travis-ci.org/MaxCDN/python-maxcdn
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

options = {
"name": "maxcdn",
"version": "0.0.6",
"version": "0.0.7",
"description": "A Python REST Client for MaxCDN REST Web Services",
"author": "Joshua P. Mervine",
"author_email": "[email protected]",
Expand Down

0 comments on commit da475b6

Please sign in to comment.