/tastypie-queryset-client

Permalink
Browse files

Create gh-pages branch via GitHub

  • Loading branch information...
@ikeikeikeike
ikeikeikeike committed Jul 16, 2012
0 parents commit ea8484e9b6947b5e4dc3bafb5b06bda5e1238277
BIN images/body-bg.jpg
Binary file not shown.
BIN images/download-button.png
Binary file not shown.
BIN images/github-button.png
Binary file not shown.
BIN images/header-bg.jpg
Binary file not shown.
BIN images/highlight-bg.jpg
Binary file not shown.
BIN images/sidebar-bg.jpg
Binary file not shown.
134 index.html
@@ -0,0 +1,134 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset='utf-8'>
+ <meta http-equiv="X-UA-Compatible" content="chrome=1">
+ <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
+ <link href='https://fonts.googleapis.com/css?family=Architects+Daughter' rel='stylesheet' type='text/css'>
+ <link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
+ <link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
+ <link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
+
+ <!--[if lt IE 9]>
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <title>Tastypie-queryset-client by ikeikeikeike</title>
+ </head>
+
+ <body>
+ <header>
+ <div class="inner">
+ <h1>Tastypie-queryset-client</h1>
+ <h2>Client for Tastypie. Provide operation similar to the Django Model API .</h2>
+ <a href="https://github.com/ikeikeikeike/tastypie-queryset-client" class="button"><small>View project on</small>GitHub</a>
+ </div>
+ </header>
+
+ <div id="content-wrapper">
+ <div class="inner clearfix">
+ <section id="main-content">
+ <h1>Tastypie Queryset Client</h1>
+
+<p>Client for <a href="https://github.com/toastdriven/django-tastypie">Tastypie</a>. Provide operation similar to the Django Model API .</p>
+
+<h1>Usage</h1>
+
+<h2>Get</h2>
+
+<div class="highlight">
+<pre><span class="o">&gt;&gt;&gt;</span> <span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="s">"http://api.server.com/your/v1/"</span><span class="p">)</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">client</span><span class="o">.</span><span class="n">your</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">"your"</span><span class="p">)</span>
+<span class="o">&lt;</span><span class="n">your</span><span class="p">:</span> <span class="p">{</span><span class="s">u"id"</span><span class="p">:</span> <span class="s">u"1"</span><span class="p">,</span> <span class="s">u"name"</span><span class="p">:</span> <span class="s">u"your"</span><span class="p">,</span> <span class="s">u"status"</span><span class="p">:</span> <span class="s">u"any"</span><span class="p">}</span><span class="o">&gt;</span>
+</pre>
+</div>
+
+
+<h2>Count</h2>
+
+<div class="highlight">
+<pre><span class="o">&gt;&gt;&gt;</span> <span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="s">"http://api.server.com/your/v1/"</span><span class="p">)</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">client</span><span class="o">.</span><span class="n">your</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">count</span><span class="p">()</span>
+<span class="mi">100</span>
+</pre>
+</div>
+
+
+<h2>Filter</h2>
+
+<div class="highlight">
+<pre><span class="o">&gt;&gt;&gt;</span> <span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="s">"http://api.server.com/your/v1/"</span><span class="p">)</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">client</span><span class="o">.</span><span class="n">your</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">"your"</span><span class="p">)</span>
+<span class="o">&lt;</span><span class="n">QuerySet</span> <span class="o">&lt;</span><span class="k">class</span> <span class="err">'</span><span class="nc">Response</span><span class="s">'&gt; (3/3)&gt;</span>
+</pre>
+</div>
+
+
+<h2>Save</h2>
+
+<div class="highlight">
+<pre><span class="o">&gt;&gt;&gt;</span> <span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="s">"http://api.server.com/your/v1/"</span><span class="p">)</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">your</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">your</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">"name"</span><span class="p">)</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">your</span>
+<span class="o">&lt;</span><span class="n">your</span><span class="p">:</span> <span class="p">{</span><span class="s">u"name"</span><span class="p">:</span> <span class="s">u"name"</span><span class="p">}</span><span class="o">&gt;</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">your</span><span class="o">.</span><span class="n">save</span><span class="p">()</span> <span class="c"># save Your object.</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">your</span>
+<span class="o">&lt;</span><span class="n">your</span><span class="p">:</span> <span class="p">{</span><span class="s">u"id"</span><span class="p">:</span> <span class="s">u"2"</span><span class="p">,</span> <span class="s">u"name"</span><span class="p">:</span> <span class="s">u"name"</span><span class="p">}</span><span class="o">&gt;</span>
+</pre>
+</div>
+
+
+<h2>Delete</h2>
+
+<div class="highlight">
+<pre><span class="o">&gt;&gt;&gt;</span> <span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="s">"http://api.server.com/your/v1/"</span><span class="p">)</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">message</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">message</span><span class="p">(</span><span class="n">subject</span><span class="o">=</span><span class="s">"subject delete 1"</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="s">"body delete 1"</span><span class="p">)</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">message</span><span class="o">.</span><span class="n">save</span><span class="p">()</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">message</span><span class="o">.</span><span class="n">id</span>
+<span class="o">&lt;</span><span class="n">message</span><span class="p">:</span> <span class="p">{</span><span class="s">u"id"</span><span class="p">:</span> <span class="s">u"1"</span><span class="p">,</span> <span class="s">u"subject"</span><span class="p">:</span> <span class="s">u"subject delete 1"</span><span class="p">,</span> <span class="s">u"body"</span><span class="p">:</span> <span class="s">u"body delete 1"</span><span class="p">}</span><span class="o">&gt;</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">message</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span> <span class="c"># remove Message object.</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="k">try</span><span class="p">:</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="n">message</span><span class="o">.</span><span class="n">id</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
+<span class="o">&gt;&gt;&gt;</span> <span class="k">assert</span> <span class="bp">True</span> <span class="c"># throw AttributeError.</span>
+</pre>
+</div>
+
+
+<h1>Setup</h1>
+
+<div class="highlight">
+<pre><span class="nv">$ </span>pip install tastypie-queryset-client
+</pre>
+</div>
+
+
+<h1>Documentation</h1>
+
+<p><a href="http://tastypie-queryset-client.readthedocs.org">tastypie-queryset-client.readthedocs.org</a></p>
+
+<h1>License</h1>
+
+<p>MIT License</p>
+ </section>
+
+ <aside id="sidebar">
+ <a href="https://github.com/ikeikeikeike/tastypie-queryset-client/zipball/master" class="button">
+ <small>Download</small>
+ .zip file
+ </a>
+ <a href="https://github.com/ikeikeikeike/tastypie-queryset-client/tarball/master" class="button">
+ <small>Download</small>
+ .tar.gz file
+ </a>
+
+ <p class="repo-owner"><a href="https://github.com/ikeikeikeike/tastypie-queryset-client"></a> is maintained by <a href="https://github.com/ikeikeikeike">ikeikeikeike</a>.</p>
+
+ <p>This page was generated by <a href="pages.github.com">GitHub Pages</a> using the Architect theme by <a href="http://twitter.com/jasonlong">Jason Long</a>.</p>
+ </aside>
+ </div>
+ </div>
+
+
+ </body>
+</html>
1 javascripts/main.js
@@ -0,0 +1 @@
+console.log('This would be the main JS file.');
1 params.json
@@ -0,0 +1 @@
+{"note":"Don't delete this file! It's used internally to help with page regeneration.","name":"Tastypie-queryset-client","google":"","tagline":"Client for Tastypie. Provide operation similar to the Django Model API .","body":"Tastypie Queryset Client\r\n========================\r\n\r\nClient for [Tastypie](https://github.com/toastdriven/django-tastypie). Provide operation similar to the Django Model API .\r\n\r\nUsage\r\n=====\r\n\r\nGet\r\n------\r\n```python\r\n>>> client = Client(\"http://api.server.com/your/v1/\")\r\n>>> client.your.objects.get(name=\"your\")\r\n<your: {u\"id\": u\"1\", u\"name\": u\"your\", u\"status\": u\"any\"}>\r\n```\r\n\r\nCount\r\n------\r\n```python\r\n>>> client = Client(\"http://api.server.com/your/v1/\")\r\n>>> client.your.objects.count()\r\n100\r\n```\r\n\r\nFilter\r\n------\r\n```python\r\n>>> client = Client(\"http://api.server.com/your/v1/\")\r\n>>> client.your.objects.filter(name=\"your\")\r\n<QuerySet <class 'Response'> (3/3)>\r\n```\r\n\r\nSave\r\n----\r\n```python\r\n>>> client = Client(\"http://api.server.com/your/v1/\")\r\n>>> your = client.your(name=\"name\")\r\n>>> your\r\n<your: {u\"name\": u\"name\"}>\r\n>>> your.save() # save Your object.\r\n>>> your\r\n<your: {u\"id\": u\"2\", u\"name\": u\"name\"}>\r\n```\r\n\r\nDelete\r\n------\r\n```python\r\n>>> client = Client(\"http://api.server.com/your/v1/\")\r\n>>> message = client.message(subject=\"subject delete 1\", body=\"body delete 1\")\r\n>>> message.save()\r\n>>> message.id\r\n<message: {u\"id\": u\"1\", u\"subject\": u\"subject delete 1\", u\"body\": u\"body delete 1\"}>\r\n>>> message.delete() # remove Message object.\r\n>>> try:\r\n>>> message.id\r\n>>> except AttributeError:\r\n>>> assert True # throw AttributeError.\r\n```\r\n\r\n\r\nSetup\r\n=====\r\n```bash\r\n$ pip install tastypie-queryset-client\r\n```\r\n\r\nDocumentation\r\n==============\r\n\r\n[tastypie-queryset-client.readthedocs.org](http://tastypie-queryset-client.readthedocs.org)\r\n\r\n\r\nLicense\r\n=======\r\nMIT License\r\n"}
226 stylesheets/print.css
@@ -0,0 +1,226 @@
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-size: 100%;
+ font: inherit;
+ vertical-align: baseline;
+}
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section {
+ display: block;
+}
+body {
+ line-height: 1;
+}
+ol, ul {
+ list-style: none;
+}
+blockquote, q {
+ quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+ content: '';
+ content: none;
+}
+table {
+ border-collapse: collapse;
+ border-spacing: 0;
+}
+body {
+ font-size: 13px;
+ line-height: 1.5;
+ font-family: 'Helvetica Neue', Helvetica, Arial, serif;
+ color: #000;
+}
+
+a {
+ color: #d5000d;
+ font-weight: bold;
+}
+
+header {
+ padding-top: 35px;
+ padding-bottom: 10px;
+}
+
+header h1 {
+ font-weight: bold;
+ letter-spacing: -1px;
+ font-size: 48px;
+ color: #303030;
+ line-height: 1.2;
+}
+
+header h2 {
+ letter-spacing: -1px;
+ font-size: 24px;
+ color: #aaa;
+ font-weight: normal;
+ line-height: 1.3;
+}
+#downloads {
+ display: none;
+}
+#main_content {
+ padding-top: 20px;
+}
+
+code, pre {
+ font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal;
+ color: #222;
+ margin-bottom: 30px;
+ font-size: 12px;
+}
+
+code {
+ padding: 0 3px;
+}
+
+pre {
+ border: solid 1px #ddd;
+ padding: 20px;
+ overflow: auto;
+}
+pre code {
+ padding: 0;
+}
+
+ul, ol, dl {
+ margin-bottom: 20px;
+}
+
+
+/* COMMON STYLES */
+
+table {
+ width: 100%;
+ border: 1px solid #ebebeb;
+}
+
+th {
+ font-weight: 500;
+}
+
+td {
+ border: 1px solid #ebebeb;
+ text-align: center;
+ font-weight: 300;
+}
+
+form {
+ background: #f2f2f2;
+ padding: 20px;
+
+}
+
+
+/* GENERAL ELEMENT TYPE STYLES */
+
+h1 {
+ font-size: 2.8em;
+}
+
+h2 {
+ font-size: 22px;
+ font-weight: bold;
+ color: #303030;
+ margin-bottom: 8px;
+}
+
+h3 {
+ color: #d5000d;
+ font-size: 18px;
+ font-weight: bold;
+ margin-bottom: 8px;
+}
+
+h4 {
+ font-size: 16px;
+ color: #303030;
+ font-weight: bold;
+}
+
+h5 {
+ font-size: 1em;
+ color: #303030;
+}
+
+h6 {
+ font-size: .8em;
+ color: #303030;
+}
+
+p {
+ font-weight: 300;
+ margin-bottom: 20px;
+}
+
+a {
+ text-decoration: none;
+}
+
+p a {
+ font-weight: 400;
+}
+
+blockquote {
+ font-size: 1.6em;
+ border-left: 10px solid #e9e9e9;
+ margin-bottom: 20px;
+ padding: 0 0 0 30px;
+}
+
+ul li {
+ list-style: disc inside;
+ padding-left: 20px;
+}
+
+ol li {
+ list-style: decimal inside;
+ padding-left: 3px;
+}
+
+dl dd {
+ font-style: italic;
+ font-weight: 100;
+}
+
+footer {
+ margin-top: 40px;
+ padding-top: 20px;
+ padding-bottom: 30px;
+ font-size: 13px;
+ color: #aaa;
+}
+
+footer a {
+ color: #666;
+}
+
+/* MISC */
+.clearfix:after {
+ clear: both;
+ content: '.';
+ display: block;
+ visibility: hidden;
+ height: 0;
+}
+
+.clearfix {display: inline-block;}
+* html .clearfix {height: 1%;}
+.clearfix {display: block;}
Oops, something went wrong.

0 comments on commit ea8484e

Please sign in to comment.