durga documentation · durga documentation, release 0.1.0 •explain in detail how it would work....
TRANSCRIPT
![Page 1: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/1.jpg)
Durga DocumentationRelease 0.1.0
transcode
December 09, 2014
![Page 2: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/2.jpg)
![Page 3: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/3.jpg)
Contents
1 Installation 3
2 Usage 5
3 durga 73.1 durga package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4 Contributing 94.1 Types of Contributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94.2 Get Started! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104.3 Pull Request Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104.4 Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5 Authors 135.1 Development Lead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135.2 Contributors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
6 Changelog 156.1 0.1.0 (2014-12-09) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
7 Indices and tables 17
Python Module Index 19
i
![Page 4: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/4.jpg)
ii
![Page 5: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/5.jpg)
Durga Documentation, Release 0.1.0
Contents:
Contents 1
![Page 6: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/6.jpg)
Durga Documentation, Release 0.1.0
2 Contents
![Page 7: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/7.jpg)
CHAPTER 1
Installation
At the command line:
$ pip install durga
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv durga$ pip install durga
3
![Page 8: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/8.jpg)
Durga Documentation, Release 0.1.0
4 Chapter 1. Installation
![Page 9: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/9.jpg)
CHAPTER 2
Usage
To use Durga in a project define a class that extends durga.resource.Resource. This example uses theFlickr API flickr.photos.search:
1 import durga2
3
4 class FlickrResource(durga.Resource):5 base_url = 'https://api.flickr.com/services'6 name = 'rest'7 results_path = ('photos', 'photo')8 schema = durga.schema.Schema({9 'farm': durga.schema.Use(int),
10 'id': durga.schema.Use(int),11 'isfamily': durga.schema.Use(bool),12 'isfriend': durga.schema.Use(bool),13 'ispublic': durga.schema.Use(bool),14 'owner': durga.schema.And(basestring, len),15 'secret': durga.schema.And(basestring, len),16 'server': durga.schema.Use(int),17 'title': durga.schema.And(basestring, len),18 })19 query = {20 'method': 'flickr.photos.search',21 'api_key': 'a33076a7ae214c0d12931ae8e38e846d',22 'format': 'json',23 'nojsoncallback': 1,24 }
Note: For convenience durga.resource.Resource and the schema library are available at the top modulelevel.
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.
5
![Page 10: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/10.jpg)
Durga Documentation, Release 0.1.0
6 Chapter 2. Usage
![Page 11: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/11.jpg)
CHAPTER 3
durga
3.1 durga package
3.1.1 Submodules
3.1.2 durga.collection module
class durga.collection.Collection(url, resource)Bases: object
all()
count()
create(data)
delete()
filter(*args, **kwargs)
get(*args, **kwargs)
get_element(data)
order_by()
update(data)
validate(data)
3.1.3 durga.element module
class durga.element.Element(resource, data)Bases: object
delete()
get_raw()
get_resource()
get_url()
update(data)
7
![Page 12: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/12.jpg)
Durga Documentation, Release 0.1.0
3.1.4 durga.resource module
class durga.resource.ResourceBases: object
get_url()
3.1.5 Module contents
8 Chapter 3. durga
![Page 13: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/13.jpg)
CHAPTER 4
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:
4.1 Types of Contributions
4.1.1 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.
4.1.2 Fix Bugs
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
4.1.3 Implement Features
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implementit.
4.1.4 Write Documentation
Durga could always use more documentation, whether as part of the official Durga docs, in docstrings, or even on theweb in blog posts, articles, and such.
4.1.5 Submit Feedback
The best way to send feedback is to file an issue at the GitHub issue tracker.
If you are proposing a feature:
9
![Page 14: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/14.jpg)
Durga Documentation, Release 0.1.0
• 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 :)
4.2 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 [email protected]:your_name_here/durga.git
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set upyour 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 testingother 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.
4.3 Pull Request Guidelines
Before you submit a pull request, check that it meets these guidelines:
1. The pull request should include tests.
10 Chapter 4. Contributing
![Page 15: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/15.jpg)
Durga Documentation, Release 0.1.0
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a functionwith 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 allsupported Python versions.
4.4 Tips
To run a subset of tests:
$ make test TEST_ARGS='-k <EXPRESSION>'
4.4. Tips 11
![Page 16: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/16.jpg)
Durga Documentation, Release 0.1.0
12 Chapter 4. Contributing
![Page 17: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/17.jpg)
CHAPTER 5
Authors
5.1 Development Lead
• Markus Zapke-Gründemann
5.2 Contributors
None yet. Why not be the first?
13
![Page 18: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/18.jpg)
Durga Documentation, Release 0.1.0
14 Chapter 5. Authors
![Page 19: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/19.jpg)
CHAPTER 6
Changelog
6.1 0.1.0 (2014-12-09)
• First release on PyPI.
15
![Page 20: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/20.jpg)
Durga Documentation, Release 0.1.0
16 Chapter 6. Changelog
![Page 21: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/21.jpg)
CHAPTER 7
Indices and tables
• genindex
• modindex
• search
17
![Page 22: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/22.jpg)
Durga Documentation, Release 0.1.0
18 Chapter 7. Indices and tables
![Page 23: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/23.jpg)
Python Module Index
ddurga, 8durga.collection, 7durga.element, 7durga.resource, 8
19
![Page 24: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/24.jpg)
Durga Documentation, Release 0.1.0
20 Python Module Index
![Page 25: Durga Documentation · Durga Documentation, Release 0.1.0 •Explain in detail how it would work. •Keep the scope as narrow as possible, to make it easier to implement](https://reader036.vdocument.in/reader036/viewer/2022070617/5e0317b2d9e2ea2f2041b903/html5/thumbnails/25.jpg)
Index
Aall() (durga.collection.Collection method), 7
CCollection (class in durga.collection), 7count() (durga.collection.Collection method), 7create() (durga.collection.Collection method), 7
Ddelete() (durga.collection.Collection method), 7delete() (durga.element.Element method), 7durga (module), 8durga.collection (module), 7durga.element (module), 7durga.resource (module), 8
EElement (class in durga.element), 7
Ffilter() (durga.collection.Collection method), 7
Gget() (durga.collection.Collection method), 7get_element() (durga.collection.Collection method), 7get_raw() (durga.element.Element method), 7get_resource() (durga.element.Element method), 7get_url() (durga.element.Element method), 7get_url() (durga.resource.Resource method), 8
Oorder_by() (durga.collection.Collection method), 7
RResource (class in durga.resource), 8
Uupdate() (durga.collection.Collection method), 7update() (durga.element.Element method), 7
Vvalidate() (durga.collection.Collection method), 7
21