mirror of
https://github.com/almet/notmyidea.git
synced 2025-04-29 03:52:38 +02:00
140 lines
No EOL
11 KiB
HTML
140 lines
No EOL
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Cheese & code - Wrap-up - Carnets en ligne</title>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="https://blog.notmyidea.org/theme/css/main.css" type="text/css" />
|
|
<link href="https://blog.notmyidea.org/feeds/all.atom.xml" type="application/atom+xml" rel="alternate" title="Carnets en ligne ATOM Feed" />
|
|
</head>
|
|
<body>
|
|
<section id="links">
|
|
<li>
|
|
<a class="" href="https://blog.notmyidea.org/" id="site-title">Blog</a>
|
|
</li>
|
|
<li><a class="" href="https://blog.notmyidea.org/pages/projets.html">Projets</a></li>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<header>
|
|
<h1 class="post-title">Cheese & code - Wrap-up</h1>
|
|
<time datetime="2012-10-22T00:00:00+02:00">22 octobre 2012</time>
|
|
|
|
|
|
</header>
|
|
<article>
|
|
|
|
<p>This week-end I hosted a <em>cheese & code</em> session in the country-side of
|
|
Angers, France.</p>
|
|
<p>We were a bunch of python hackers and it rained a lot, wich forced us to
|
|
stay inside and to code. Bad.</p>
|
|
<p>We were not enough to get rid of all the cheese and the awesome meals,
|
|
but well, we finally managed it pretty well.</p>
|
|
<p>Here is a summary of what we worked on:</p>
|
|
<h2 id="daybed">Daybed</h2>
|
|
<p>Daybed started some time ago, and intend to be a replacement to google
|
|
forms, in term of features, but backed as a REST web service, in python,
|
|
and open source.</p>
|
|
<p>In case you wonder, daybed is effectively the name of a couch. We chose
|
|
this name because of the similarities (in the sound) with <strong>db</strong>, and
|
|
because we're using <strong>CouchDB</strong> as a backend.</p>
|
|
<p><img alt="Daybed is a big couch!" src="images/daybed.jpg"></p>
|
|
<p>We mainly hacked on daybed and are pretty close to the release of the
|
|
first version, meaning that we have something working.</p>
|
|
<p><a href="http://github.com/spiral-project/daybed">The code</a> is available on
|
|
github, and we also wrote <a href="http://daybed.rtfd.org">a small
|
|
documentation</a> for it.</p>
|
|
<p>Mainly, we did a lot of cleanup, rewrote a bunch of tests so that it
|
|
would be easier to continue to work on the project, and implemented some
|
|
minor features. I'm pretty confidend that we now have really good basis
|
|
for this project.</p>
|
|
<p>Also, we will have a nice todolist application, with the backend <strong>and</strong>
|
|
the frontend, in javascript / html / css, you'll know more when it'll be
|
|
ready :-)</p>
|
|
<p>Once we have something good enough, we'll release the first version and
|
|
I'll host it somewhere so that people can play with it.</p>
|
|
<h2 id="cornice">Cornice</h2>
|
|
<p>Daybed is built on top of <a href="http://cornice.rtfd.org">Cornice</a>, a
|
|
framework to ease the creation of web-services.</p>
|
|
<p>At Pycon France, we had the opportunity to attend a good presentation
|
|
about <a href="https://github.com/SPORE/specifications">SPORE</a>. SPORE is a way
|
|
to describe your REST web services, as WSDL is for WS-* services. This
|
|
allows to ease the creation of generic SPORE clients, which are able to
|
|
consume any REST API with a SPORE endpoint.</p>
|
|
<p>Here is how you can let cornice describe your web service for you</p>
|
|
<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">cornice.ext.spore</span> <span class="kn">import</span> <span class="n">generate_spore_description</span>
|
|
<span class="kn">from</span> <span class="nn">cornice.service</span> <span class="kn">import</span> <span class="n">Service</span><span class="p">,</span> <span class="n">get_services</span>
|
|
|
|
<span class="n">spore</span> <span class="o">=</span> <span class="n">Service</span><span class="p">(</span><span class="s1">'spore'</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s1">'/spore'</span><span class="p">,</span> <span class="n">renderer</span><span class="o">=</span><span class="s1">'jsonp'</span><span class="p">)</span>
|
|
<span class="nd">@spore</span><span class="o">.</span><span class="n">get</span>
|
|
<span class="k">def</span> <span class="nf">get_spore</span><span class="p">(</span><span class="n">request</span><span class="p">):</span>
|
|
<span class="n">services</span> <span class="o">=</span> <span class="n">get_services</span><span class="p">()</span>
|
|
<span class="k">return</span> <span class="n">generate_spore_description</span><span class="p">(</span><span class="n">services</span><span class="p">,</span> <span class="s1">'Service name'</span><span class="p">,</span>
|
|
<span class="n">request</span><span class="o">.</span><span class="n">application_url</span><span class="p">,</span> <span class="s1">'1.0'</span><span class="p">)</span>
|
|
</code></pre></div>
|
|
|
|
<p>And you'll get a definition of your service, in SPORE, available at
|
|
/spore.</p>
|
|
<p>Of course, you can use it to do other things, like generating the file
|
|
locally and exporting it wherever it makes sense to you, etc.</p>
|
|
<p>I released today <a href="http://crate.io/packages/cornice/">Cornice 0.11</a>,
|
|
which adds into other things the support for SPORE, plus some other
|
|
fixes we found on our way.</p>
|
|
<h2 id="respire">Respire</h2>
|
|
<p>Once you have the description of the service, you can do generic clients
|
|
consuming them!</p>
|
|
<p>We first wanted to contribute to <a href="https://github.com/bl0b/spyre">spyre</a>
|
|
but it was written in a way that wasn't supporting to POST data, and
|
|
they were using their own stack to handle HTTP. A lot of code that
|
|
already exists in other libraries.</p>
|
|
<p>While waiting the train with <a href="http://natim.ionyse.com/">Rémy</a>, we hacked
|
|
something together, named "Respire", a thin layer on top of the awesome
|
|
<a href="http://python-requests.org">Requests</a> library.</p>
|
|
<p>We have a first version, feel free to have a look at it and provide
|
|
enhancements if you feel like it. We're still hacking on it so it may
|
|
break (for the better), but that had been working pretty well for us so
|
|
far.</p>
|
|
<p>You can <a href="http://github.com/spiral-project/respire">find the project on
|
|
github</a>, but here is how to
|
|
use it, really quickly (these examples are how to interact with daybed)</p>
|
|
<div class="highlight"><pre><span></span><code><span class="o">>>></span> <span class="kn">from</span> <span class="nn">respire</span> <span class="kn">import</span> <span class="n">client_from_url</span>
|
|
|
|
<span class="o">>>></span> <span class="c1"># create the client from the SPORE definition</span>
|
|
<span class="o">>>></span> <span class="n">cl</span> <span class="o">=</span> <span class="n">client_from_url</span><span class="p">(</span><span class="s1">'http://localhost:8000/spore'</span><span class="p">)</span>
|
|
|
|
<span class="o">>>></span> <span class="c1"># in daybed, create a new definition</span>
|
|
<span class="o">>>></span> <span class="n">todo_def</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="o">...</span> <span class="s2">"title"</span><span class="p">:</span> <span class="s2">"todo"</span><span class="p">,</span>
|
|
<span class="o">...</span> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"A list of my stuff to do"</span><span class="p">,</span>
|
|
<span class="o">...</span> <span class="s2">"fields"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="o">...</span> <span class="p">{</span>
|
|
<span class="o">...</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"item"</span><span class="p">,</span>
|
|
<span class="o">...</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span>
|
|
<span class="o">...</span> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"The item"</span>
|
|
<span class="o">...</span> <span class="p">},</span>
|
|
<span class="o">...</span> <span class="p">{</span>
|
|
<span class="o">...</span> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"status"</span><span class="p">,</span>
|
|
<span class="o">...</span> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"enum"</span><span class="p">,</span>
|
|
<span class="o">...</span> <span class="s2">"choices"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="o">...</span> <span class="s2">"done"</span><span class="p">,</span>
|
|
<span class="o">...</span> <span class="s2">"todo"</span>
|
|
<span class="o">...</span> <span class="p">],</span>
|
|
<span class="o">...</span> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"is it done or not"</span>
|
|
<span class="o">...</span> <span class="p">}</span>
|
|
<span class="o">...</span> <span class="p">]}</span>
|
|
<span class="o">>>></span> <span class="n">cl</span><span class="o">.</span><span class="n">put_definition</span><span class="p">(</span><span class="n">model_name</span><span class="o">=</span><span class="s1">'todo'</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">todo_def</span><span class="p">)</span>
|
|
<span class="o">>>></span> <span class="n">cl</span><span class="o">.</span><span class="n">post_data</span><span class="p">(</span><span class="n">model_name</span><span class="o">=</span><span class="s1">'todo'</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="nb">dict</span><span class="p">(</span><span class="n">item</span><span class="o">=</span><span class="s1">'make it work'</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="s1">'todo'</span><span class="p">))</span>
|
|
<span class="p">{</span><span class="sa">u</span><span class="s1">'id'</span><span class="p">:</span> <span class="sa">u</span><span class="s1">'9f2c90c0529a442cfdc03c191b022cf7'</span><span class="p">}</span>
|
|
<span class="o">>>></span> <span class="n">cl</span><span class="o">.</span><span class="n">get_data</span><span class="p">(</span><span class="n">model_name</span><span class="o">=</span><span class="s1">'todo'</span><span class="p">)</span>
|
|
</code></pre></div>
|
|
|
|
<p>Finally, we were out of cheese so everyone headed back to their
|
|
respective houses and cities.</p>
|
|
<p>Until next time?</p>
|
|
</article>
|
|
|
|
</body>
|
|
</html> |