output/blog/tags/api.html - libcloud-site - Git at Google

 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">


     <meta name="author" content="The Apache Software Foundation">


       <meta name="keywords" content="python,libcloud,cloud,cloud computing,rackspace,amazon ec2,cloudfiles,openstack,cloudstack" />


       <title>Apache Libcloud | Apache Libcloud</title>


     <!-- fav icons -->
     <link rel="shortcut icon" href="/images/favicon.png" />
     <link rel="apple-touch-icon" href="/images/apple-touch-icon.png" />
     <link rel="apple-touch-icon-precomposed" href="/images/apple-touch-icon.png" />

     <link href="/blog/atom.xml" type="application/atom+xml" rel="alternate" title="Apache Libcloud Blog Feed" />

     <!-- Facebook OpenGraph tags -->
     <meta content="Apache Libcloud" property="og:site_name">

       <meta content="Apache Libcloud" property="og:title">


       <meta content="website" property="og:type">


       <meta content="https://libcloud.apache.org/blog/tags/api" property="og:url">


     <link href='/assets/global-1768bfa479597eed443be67c5aec2edc.css' rel='stylesheet' type='text/css' />
   </head>

   <body data-spy="scroll" data-target=".sidebar-nav" data-offset="80">
     <nav class="navbar navbar-fixed-top navbar-inverse" role="navigation">
       <div class="container">
         <div class="navbar-header">
           <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
             <span class="sr-only">Toggle navigation</span>
             <span class="icon-bar"></span>
             <span class="icon-bar"></span>
             <span class="icon-bar"></span>
           </button>
           <a class="navbar-brand" href="/"><img src="/images/libcloud_logo.png" class="navbar-logo" /> Apache Libcloud</a>
         </div>
         <div class="collapse navbar-collapse navbar-ex1-collapse">
           <ul class="nav navbar-nav">


               <li ><a href="/" >Home</a></li>


               <li ><a href="/about.html" >About</a></li>


               <li ><a href="/getting-started.html" >Quick Start</a></li>


               <li ><a href="https://libcloud.readthedocs.org/en/stable/" target="_blank">Documentation</a></li>


               <li ><a href="/downloads.html" >Downloads</a></li>


               <li ><a href="/community.html" >Community</a></li>


               <li ><a href="/blog/" >Blog</a></li>

           </ul>

           <div class="material-switch pull-right">
               <input id="theme-switch" name="theme-switch" type="checkbox" onclick="modeSwitcher()"/>
               <label for="theme-switch" class="label-default"></label>
               <span id="theme-toggle" class="theme-switch">Dark mode</span>
           </div>

         </div><!-- /.navbar-collapse -->
       </div><!-- /.container -->
     </nav>

     <div class="container main-container">
       <div class="row section page-content">
   <div class="col-lg-8 col-lg-offset-2">
     <h1>Tag: API</h1>


     <div class="post">

     <h2 class="post-title"><a href="/blog/2016/04/06/requests-support.html">Experimental support for the requests package</a></h2>

   <span class="post-date-author">By Anthony Shaw on Apr 06, 2016</span>

   <div class="post-content">
     <h2 id="background">Background</h2>

 <p>I’ve just pushed a branch of the latest version of libcloud using the popular <code class="language-plaintext highlighter-rouge">requests</code> package by Kenneth Reitz instead of our home-rolled HTTP client library.</p>

 <p>This article is for both users and developers of libcloud. If you want to give feedback, please join the developer mailing list.</p>

 <h2 id="why">Why?</h2>

 <ul>
   <li>requests is the defacto standard - it would be in the standard library but agreed against to allow it to develop faster https://github.com/kennethreitz/requests/issues/2424</li>
   <li>it works with python 2.6-&gt;3.5</li>
   <li>Our SSL experience has a lot to be desired for Windows users, having to download the CA cert package and setting environment variables just to get SSL working</li>
   <li>Developers can use requests_mock for deeper integration testing</li>
   <li>less code to maintain</li>
   <li>the role of libcloud is for cloud abstraction, we provide no value in writing and maintaining our own HTTP client library</li>
 </ul>

 <h2 id="benefits-of-requests">Benefits of requests</h2>

 <p>There are a number of benefits to having a requests package</p>

 <ul>
   <li>The client library code is smaller, leaner and simpler.</li>
   <li>Requests has built in decompression support, we no longer need to support this</li>
   <li>Requests has built in RAW download, upload support, helping with our storage drivers</li>
 </ul>

 <h2 id="implications-of-the-change">Implications of the change</h2>

 <ul>
   <li>There are no longer 2 classes (<code class="language-plaintext highlighter-rouge">LibcloudHTTPSConnection</code> and <code class="language-plaintext highlighter-rouge">LibcloudHTTPConnection</code>) to be provided to each driver, they are now 1 class - <code class="language-plaintext highlighter-rouge">LibcloudConnection</code>. You probably won’t notice this because it is a property of the <code class="language-plaintext highlighter-rouge">Connection</code> class, but
 if you are developing or extending functionality then it is implicated.</li>
   <li>Unit tests will look slightly different (see below)</li>
   <li>This change broke 4200 unit tests (out of 6340)! I’ve since fixed them all since they were coupled to the original implementation, but now I don’t know if all of tests are valid.</li>
 </ul>

 <h2 id="testing-with-requests">Testing with requests</h2>

 <p>Unit tests that were written like this:</p>

 <div class="language-python highlighter-rouge">
   <div class="highlight">
     <pre class="highlight"><code><span class="k">class</span> <span class="nc">DigitalOceanTests</span><span class="p">(</span><span class="n">LibcloudTestCase</span><span class="p">):</span>

       <span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
           <span class="n">DigitalOceanBaseDriver</span><span class="p">.</span><span class="n">connectionCls</span><span class="p">.</span><span class="n">conn_classes</span> <span class="o">=</span> \
            <span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="n">DigitalOceanMockHttp</span><span class="p">)</span>
           <span class="n">DigitalOceanMockHttp</span><span class="p">.</span><span class="nb">type</span> <span class="o">=</span> <span class="bp">None</span>
           <span class="bp">self</span><span class="p">.</span><span class="n">driver</span> <span class="o">=</span> <span class="n">DigitalOceanBaseDriver</span><span class="p">(</span><span class="o">*</span><span class="n">DIGITALOCEAN_v1_PARAMS</span><span class="p">)</span>
 </code></pre>
   </div>
 </div>

 <p>Because of the change have been modified to (I updated all of them - so this is just for future reference)</p>

 <div class="language-python highlighter-rouge">
   <div class="highlight">
     <pre class="highlight"><code><span class="k">class</span> <span class="nc">DigitalOceanTests</span><span class="p">(</span><span class="n">LibcloudTestCase</span><span class="p">):</span>

       <span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
           <span class="n">DigitalOceanBaseDriver</span><span class="p">.</span><span class="n">connectionCls</span><span class="p">.</span><span class="n">conn_class</span> <span class="o">=</span> <span class="n">DigitalOceanMockHttp</span>
           <span class="n">DigitalOceanMockHttp</span><span class="p">.</span><span class="nb">type</span> <span class="o">=</span> <span class="bp">None</span>
           <span class="bp">self</span><span class="p">.</span><span class="n">driver</span> <span class="o">=</span> <span class="n">DigitalOceanBaseDriver</span><span class="p">(</span><span class="o">*</span><span class="n">DIGITALOCEAN_v1_PARAMS</span><span class="p">)</span>
 </code></pre>
   </div>
 </div>

 <h1 id="check-it-out">Check it out!</h1>

 <p>The package is on my personal apache site, you can download it and install it in a virtualenv for testing.</p>

 <p><code class="language-plaintext highlighter-rouge">pip install -e http://people.apache.org/~anthonyshaw/libcloud/1.0.0-rc2-requests/apache-libcloud-1.0.0-rc2-requests.zip@feature#egg=apache-libcloud</code></p>

 <p>The hashes are my <a href="http://people.apache.org/~anthonyshaw/libcloud/1.0.0-rc2-requests/">apache space</a></p>

 <p>Have a look at the <a href="https://github.com/apache/libcloud/pull/728/files">PR and the change set</a> for a list of changes</p>

 <h1 id="what-might-break">What might break?</h1>

 <p>What I’m really looking for is for users of Libcloud to take 15 minutes, an existing (working) libcloud script, install this package in a virtualenv and just validate
 that there are no regression bugs with this change.</p>

 <p>I’m particularly sceptical about the storage drivers.</p>

 <p>Once we have enough community feedback, we will propose a vote to merge this into trunk for future release.</p>

 <h2 id="credit">Credit</h2>

 <p>Credit to dz0ny on IRC for contributing some of the requests patch.</p>

   </div>

   <div class="row section post-meta">
     <div class="col-md-12 post-tags">
       <p>Tags: <a href="/blog/tags/news.html" rel="tag">news</a>, <a href="/blog/tags/api.html" rel="tag">API</a>, <a href="/blog/tags/tutorial.html" rel="tag">tutorial</a></p>
     </div>
   </div>
 </div>


   </div>
 </div>


       <hr />

       <footer>
         <div class="row">
           <div class="col-lg-12 text-center">
             <div class="footer-links">
   <p><a href="http://www.apache.org/licenses/">License</a> | <a
   href="/security.html">Security</a> | <a
   href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> |
   <a href="http://www.apache.org/foundation/thanks.html">Thanks</a> |
   <a href="https://www.apache.org/events/">Events</a> |
   <a href="/credits.html">Credits</a> | <a href="/media.html">Media</a>
 </div>

 <div class="footer-text">
   <p><a class="acevent" data-format="wide"></a></p>
   <p class="">Copyright &copy; 2009-2023 <a href="https://www.apache.org/" target="_blank">The Apache Software Foundation</a></p>
   <p class="">Apache Libcloud, Libcloud, Apache, the Apache feather, and the Apache Libcloud project logo are trademarks of the Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
   <p class="">Site last updated on 2023-09-09 21:33:21 +0000</p>
 </div>

           </div>
         </div>
       </footer>

     </div><!-- /.container -->

     <!-- JavaScript -->
     <script src='/assets/global-20157a00c0e17a775f45ed99ccdf79d7.js' type='text/javascript'></script>


     <script type="text/javascript">
   var _paq = window._paq = window._paq || [];
   /* tracker methods like "setCustomDimension" should be called before
 "trackPageView" */
   /* We explicitly disable cookie tracking to avoid privacy issues */
   _paq.push(['disableCookies']);
   _paq.push(['trackPageView']);
   _paq.push(['enableLinkTracking']);
   (function() {
     var u="https://analytics.apache.org/";
     _paq.push(['setTrackerUrl', u+'matomo.php']);
     _paq.push(['setSiteId', '7']);
     var d=document, g=d.createElement('script'),
 s=d.getElementsByTagName('script')[0];
     g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
   })();
 </script>

     <script src="https://www.apachecon.com/event-images/snippet.js"></script>

   </body>
 </html>
	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1.0">



	<meta name="author" content="The Apache Software Foundation">


	<meta name="keywords" content="python,libcloud,cloud,cloud computing,rackspace,amazon ec2,cloudfiles,openstack,cloudstack" />



	<title>Apache Libcloud \| Apache Libcloud</title>


	<!-- fav icons -->
	<link rel="shortcut icon" href="/images/favicon.png" />
	<link rel="apple-touch-icon" href="/images/apple-touch-icon.png" />
	<link rel="apple-touch-icon-precomposed" href="/images/apple-touch-icon.png" />

	<link href="/blog/atom.xml" type="application/atom+xml" rel="alternate" title="Apache Libcloud Blog Feed" />

	<!-- Facebook OpenGraph tags -->
	<meta content="Apache Libcloud" property="og:site_name">

	<meta content="Apache Libcloud" property="og:title">







	<meta content="website" property="og:type">



	<meta content="https://libcloud.apache.org/blog/tags/api" property="og:url">





	<link href='/assets/global-1768bfa479597eed443be67c5aec2edc.css' rel='stylesheet' type='text/css' />
	</head>

	<body data-spy="scroll" data-target=".sidebar-nav" data-offset="80">
	<nav class="navbar navbar-fixed-top navbar-inverse" role="navigation">
	<div class="container">
	<div class="navbar-header">
	<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
	<span class="sr-only">Toggle navigation</span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	</button>
	<a class="navbar-brand" href="/"><img src="/images/libcloud_logo.png" class="navbar-logo" /> Apache Libcloud</a>
	</div>
	<div class="collapse navbar-collapse navbar-ex1-collapse">
	<ul class="nav navbar-nav">



	<li ><a href="/" >Home</a></li>


	<li ><a href="/about.html" >About</a></li>


	<li ><a href="/getting-started.html" >Quick Start</a></li>


	<li ><a href="https://libcloud.readthedocs.org/en/stable/" target="_blank">Documentation</a></li>


	<li ><a href="/downloads.html" >Downloads</a></li>


	<li ><a href="/community.html" >Community</a></li>


	<li ><a href="/blog/" >Blog</a></li>

	</ul>

	<div class="material-switch pull-right">
	<input id="theme-switch" name="theme-switch" type="checkbox" onclick="modeSwitcher()"/>
	<label for="theme-switch" class="label-default"></label>
	<span id="theme-toggle" class="theme-switch">Dark mode</span>
	</div>

	</div><!-- /.navbar-collapse -->
	</div><!-- /.container -->
	</nav>

	<div class="container main-container">
	<div class="row section page-content">
	<div class="col-lg-8 col-lg-offset-2">
	<h1>Tag: API</h1>




	<div class="post">

	<h2 class="post-title"><a href="/blog/2016/04/06/requests-support.html">Experimental support for the requests package</a></h2>

	<span class="post-date-author">By Anthony Shaw on Apr 06, 2016</span>

	<div class="post-content">
	<h2 id="background">Background</h2>

	<p>I’ve just pushed a branch of the latest version of libcloud using the popular <code class="language-plaintext highlighter-rouge">requests</code> package by Kenneth Reitz instead of our home-rolled HTTP client library.</p>

	<p>This article is for both users and developers of libcloud. If you want to give feedback, please join the developer mailing list.</p>

	<h2 id="why">Why?</h2>

	<ul>
	<li>requests is the defacto standard - it would be in the standard library but agreed against to allow it to develop faster https://github.com/kennethreitz/requests/issues/2424</li>
	<li>it works with python 2.6->3.5</li>
	<li>Our SSL experience has a lot to be desired for Windows users, having to download the CA cert package and setting environment variables just to get SSL working</li>
	<li>Developers can use requests_mock for deeper integration testing</li>
	<li>less code to maintain</li>
	<li>the role of libcloud is for cloud abstraction, we provide no value in writing and maintaining our own HTTP client library</li>
	</ul>

	<h2 id="benefits-of-requests">Benefits of requests</h2>

	<p>There are a number of benefits to having a requests package</p>

	<ul>
	<li>The client library code is smaller, leaner and simpler.</li>
	<li>Requests has built in decompression support, we no longer need to support this</li>
	<li>Requests has built in RAW download, upload support, helping with our storage drivers</li>
	</ul>

	<h2 id="implications-of-the-change">Implications of the change</h2>

	<ul>
	<li>There are no longer 2 classes (<code class="language-plaintext highlighter-rouge">LibcloudHTTPSConnection</code> and <code class="language-plaintext highlighter-rouge">LibcloudHTTPConnection</code>) to be provided to each driver, they are now 1 class - <code class="language-plaintext highlighter-rouge">LibcloudConnection</code>. You probably won’t notice this because it is a property of the <code class="language-plaintext highlighter-rouge">Connection</code> class, but
	if you are developing or extending functionality then it is implicated.</li>
	<li>Unit tests will look slightly different (see below)</li>
	<li>This change broke 4200 unit tests (out of 6340)! I’ve since fixed them all since they were coupled to the original implementation, but now I don’t know if all of tests are valid.</li>
	</ul>

	<h2 id="testing-with-requests">Testing with requests</h2>

	<p>Unit tests that were written like this:</p>

	<div class="language-python highlighter-rouge">
	<div class="highlight">
	<pre class="highlight"><code><span class="k">class</span> <span class="nc">DigitalOceanTests</span><span class="p">(</span><span class="n">LibcloudTestCase</span><span class="p">):</span>

	<span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
	<span class="n">DigitalOceanBaseDriver</span><span class="p">.</span><span class="n">connectionCls</span><span class="p">.</span><span class="n">conn_classes</span> <span class="o">=</span> \
	<span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="n">DigitalOceanMockHttp</span><span class="p">)</span>
	<span class="n">DigitalOceanMockHttp</span><span class="p">.</span><span class="nb">type</span> <span class="o">=</span> <span class="bp">None</span>
	<span class="bp">self</span><span class="p">.</span><span class="n">driver</span> <span class="o">=</span> <span class="n">DigitalOceanBaseDriver</span><span class="p">(</span><span class="o">*</span><span class="n">DIGITALOCEAN_v1_PARAMS</span><span class="p">)</span>
	</code></pre>
	</div>
	</div>

	<p>Because of the change have been modified to (I updated all of them - so this is just for future reference)</p>

	<div class="language-python highlighter-rouge">
	<div class="highlight">
	<pre class="highlight"><code><span class="k">class</span> <span class="nc">DigitalOceanTests</span><span class="p">(</span><span class="n">LibcloudTestCase</span><span class="p">):</span>

	<span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
	<span class="n">DigitalOceanBaseDriver</span><span class="p">.</span><span class="n">connectionCls</span><span class="p">.</span><span class="n">conn_class</span> <span class="o">=</span> <span class="n">DigitalOceanMockHttp</span>
	<span class="n">DigitalOceanMockHttp</span><span class="p">.</span><span class="nb">type</span> <span class="o">=</span> <span class="bp">None</span>
	<span class="bp">self</span><span class="p">.</span><span class="n">driver</span> <span class="o">=</span> <span class="n">DigitalOceanBaseDriver</span><span class="p">(</span><span class="o">*</span><span class="n">DIGITALOCEAN_v1_PARAMS</span><span class="p">)</span>
	</code></pre>
	</div>
	</div>

	<h1 id="check-it-out">Check it out!</h1>

	<p>The package is on my personal apache site, you can download it and install it in a virtualenv for testing.</p>

	<p><code class="language-plaintext highlighter-rouge">pip install -e http://people.apache.org/~anthonyshaw/libcloud/1.0.0-rc2-requests/apache-libcloud-1.0.0-rc2-requests.zip@feature#egg=apache-libcloud</code></p>

	<p>The hashes are my <a href="http://people.apache.org/~anthonyshaw/libcloud/1.0.0-rc2-requests/">apache space</a></p>

	<p>Have a look at the <a href="https://github.com/apache/libcloud/pull/728/files">PR and the change set</a> for a list of changes</p>

	<h1 id="what-might-break">What might break?</h1>

	<p>What I’m really looking for is for users of Libcloud to take 15 minutes, an existing (working) libcloud script, install this package in a virtualenv and just validate
	that there are no regression bugs with this change.</p>

	<p>I’m particularly sceptical about the storage drivers.</p>

	<p>Once we have enough community feedback, we will propose a vote to merge this into trunk for future release.</p>

	<h2 id="credit">Credit</h2>

	<p>Credit to dz0ny on IRC for contributing some of the requests patch.</p>

	</div>

	<div class="row section post-meta">
	<div class="col-md-12 post-tags">
	<p>Tags: <a href="/blog/tags/news.html" rel="tag">news</a>, <a href="/blog/tags/api.html" rel="tag">API</a>, <a href="/blog/tags/tutorial.html" rel="tag">tutorial</a></p>
	</div>
	</div>
	</div>




	</div>
	</div>


	<hr />

	<footer>
	<div class="row">
	<div class="col-lg-12 text-center">
	<div class="footer-links">
	<p><a href="http://www.apache.org/licenses/">License</a> \| <a
	href="/security.html">Security</a> \| <a
	href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> \|
	<a href="http://www.apache.org/foundation/thanks.html">Thanks</a> \|
	<a href="https://www.apache.org/events/">Events</a> \|
	<a href="/credits.html">Credits</a> \| <a href="/media.html">Media</a>
	</div>

	<div class="footer-text">
	<p><a class="acevent" data-format="wide"></a></p>
	<p class="">Copyright © 2009-2023 <a href="https://www.apache.org/" target="_blank">The Apache Software Foundation</a></p>
	<p class="">Apache Libcloud, Libcloud, Apache, the Apache feather, and the Apache Libcloud project logo are trademarks of the Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
	<p class="">Site last updated on 2023-09-09 21:33:21 +0000</p>
	</div>

	</div>
	</div>
	</footer>

	</div><!-- /.container -->

	<!-- JavaScript -->
	<script src='/assets/global-20157a00c0e17a775f45ed99ccdf79d7.js' type='text/javascript'></script>



	<script type="text/javascript">
	var _paq = window._paq = window._paq \|\| [];
	/* tracker methods like "setCustomDimension" should be called before
	"trackPageView" */
	/* We explicitly disable cookie tracking to avoid privacy issues */
	_paq.push(['disableCookies']);
	_paq.push(['trackPageView']);
	_paq.push(['enableLinkTracking']);
	(function() {
	var u="https://analytics.apache.org/";
	_paq.push(['setTrackerUrl', u+'matomo.php']);
	_paq.push(['setSiteId', '7']);
	var d=document, g=d.createElement('script'),
	s=d.getElementsByTagName('script')[0];
	g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
	})();
	</script>

	<script src="https://www.apachecon.com/event-images/snippet.js"></script>

	</body>
	</html>