<commit_before>RestClient
==========

Inspired by Django's ORM, RestClient allows you to interact with resources as 
if they were objects.

Description
-----------



Install
-------



Contribute
----------

<commit_msg>Extended README to explain a little more about what RestClient does.<commit_after>RestClient
==========

Inspired by Django's ORM, **RestClient** allows you to interact with resources
as if they were objects.

Description
-----------

Most RESTful webservices are very easy to access with very little code.
**RestClient** is just a small layer on top of ``httplib2.Http`` to get a
response from a webservice. However, instead of regular Python ``dict``
objects, you'll get a ``dict``-like object that knows how to access related
resources as well.

Access a related resource::

    >>> book = Book.objects.get(id=1, client=jsonclient) # Get book with ID 1.
    >>> book['name'] # Get the value of the key "name".
    u'Dive Into Python'
    >>> book['author'] # Get the value of the key "author".
    http://api.example.com/author/3
    >>> author = book.author # Perform a GET on the "author" resource.
    >>> author['name']
    u'<NAME>'

Accessing multiple related resources::

    >>> city = City.objects.get(code='AMS')
    >>> city.country.continent['name'] # Perform 2 GET requests.
    u'Europe'

Install
-------



Contribute
----------

#. Get the code from Github::

    $ git clone git://github.com/joeribekker/restclient.git

#. Create and activate a virtual environment::

    $ cd restclient
    $ virtualenv .
    $ source bin/activate

#. Setup the project for development::

    $ python setup.py develop

#. Start hacking!
{'fraction_non_alphanumeric': 0.14371617558628982, 'fraction_numerical': 0.003006614552014432, 'mean_word_length': 3.118811881188119, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 25, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5947765', 'n_tokens_mistral': 490, 'n_tokens_neox': 461, 'n_words': 184}