Welcome to Durga’s documentation!

Contents:

Installation

At the command line:

$ pip install durga

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv durga
$ pip install durga

Usage

To use Durga in a project define a class that extends durga.resource.Resource. This example uses the Flickr API flickr.photos.search:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
import durga


class FlickrResource(durga.Resource):
    base_url = 'https://api.flickr.com/services'
    name = 'rest'
    results_path = ('photos', 'photo')
    schema = durga.schema.Schema({
        'farm': durga.schema.Use(int),
        'id': durga.schema.Use(int),
        'isfamily': durga.schema.Use(bool),
        'isfriend': durga.schema.Use(bool),
        'ispublic': durga.schema.Use(bool),
        'owner': durga.schema.And(basestring, len),
        'secret': durga.schema.And(basestring, len),
        'server': durga.schema.Use(int),
        'title': durga.schema.And(basestring, len),
    })
    query = {
        'method': 'flickr.photos.search',
        'api_key': 'a33076a7ae214c0d12931ae8e38e846d',
        'format': 'json',
        'nojsoncallback': 1,
    }

Note

For convenience durga.resource.Resource and the schema library are available at the top module level.

Now you can search for the first 10 cat images:

FlickrResource().collection.filter(text='Cat', per_page=10)

This will return a durga.collection.Collection with a durga.element.Element for each result.

durga

durga package

Submodules

durga.collection module

class durga.collection.Collection(url, resource)[source]

Bases: object

all()[source]
count()[source]
create(data)[source]
delete()[source]
filter(*args, **kwargs)[source]
get(*args, **kwargs)[source]
get_element(data)[source]
order_by()[source]
update(data)[source]
validate(data)[source]

durga.element module

class durga.element.Element(resource, data)[source]

Bases: object

delete()[source]
get_raw()[source]
get_resource()[source]
get_url()[source]
update(data)[source]

durga.resource module

class durga.resource.Resource[source]

Bases: object

get_url()[source]

Module contents

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at the GitHub issue tracker.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

Durga could always use more documentation, whether as part of the official Durga docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at the GitHub issue tracker.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up durga for local development.

  1. Fork the durga repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/durga.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv durga
$ cd durga/
$ pip install -e ./

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass pep8, pyflakes and the tests, including testing other Python versions with tox:

    $ make test
$ make test-all

    To get pytest, pep8, pyflakes and tox, just pip install them into your virtualenv:

    $ pip install -r requirements.txt

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7 and 3.4. Check Travis CI and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ make test TEST_ARGS='-k <EXPRESSION>'

Authors

Development Lead

Contributors

None yet. Why not be the first?

Changelog

0.1.0 (2014-12-09)

  • First release on PyPI.

Indices and tables