<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Client version 3 — python-copr 1.63 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Client initialization" href="client_v3/client_initialization.html" />
<link rel="prev" title="Entities" href="client_v2/entities.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> python-copr
</a>
<div class="version">
1.63
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="ClientV1.html">Legacy client</a></li>
<li class="toctree-l1"><a class="reference internal" href="ClientV2.html">Client version 2</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Client version 3</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#example-usage">Example usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#quick-overview">Quick overview</a><ul>
<li class="toctree-l3"><a class="reference internal" href="client_v3/client_initialization.html">Client initialization</a></li>
<li class="toctree-l3"><a class="reference internal" href="client_v3/data_structures.html">Data structures</a></li>
<li class="toctree-l3"><a class="reference internal" href="client_v3/error_handling.html">Error handling</a></li>
<li class="toctree-l3"><a class="reference internal" href="client_v3/pagination.html">Pagination</a></li>
<li class="toctree-l3"><a class="reference internal" href="client_v3/working_with_proxies_directly.html">Working with proxies directly</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#resources-info">Resources info</a><ul>
<li class="toctree-l3"><a class="reference internal" href="client_v3/proxies.html">Proxies</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#parameters">Parameters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="client_v3/build_options.html">Build Options</a></li>
<li class="toctree-l3"><a class="reference internal" href="client_v3/package_source_types.html">Package Source Type</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">python-copr</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Client version 3</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/ClientV3.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="client-version-3">
<h1>Client version 3<a class="headerlink" href="#client-version-3" title="Permalink to this headline">¶</a></h1>
<p>This documentation describes the third version of python Copr client, which officially supports APIv3. This version
addresses the problems that we had with previous versions and therefore obsoletes them.</p>
<p>Operations are separated among multiple proxy classes. All methods are just tiny wrappers around API endpoints. When
a method is successful, it returns Munch with data as a result. Otherwise, an exception is raised.</p>
<div class="section" id="example-usage">
<h2>Example usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">copr.v3</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="c1"># Create an API client from config file</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">Client</span><span class="o">.</span><span class="n">create_from_config_file</span><span class="p">()</span>
<span class="c1"># Create a new project</span>
<span class="n">chroots</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"fedora-rawhide-x86_64"</span><span class="p">,</span> <span class="s2">"fedora-rawhide-i386"</span><span class="p">]</span>
<span class="n">client</span><span class="o">.</span><span class="n">project_proxy</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s2">"@copr"</span><span class="p">,</span> <span class="s2">"foo"</span><span class="p">,</span> <span class="n">chroots</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="s2">"Some desc"</span><span class="p">)</span>
<span class="c1"># Build a package</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">"http://foo.ex/bar.src.rpm"</span>
<span class="n">build</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">build_proxy</span><span class="o">.</span><span class="n">create_from_url</span><span class="p">(</span><span class="s2">"@copr"</span><span class="p">,</span> <span class="s2">"foo"</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="n">build</span><span class="o">.</span><span class="n">id</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="quick-overview">
<h2>Quick overview<a class="headerlink" href="#quick-overview" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="client_v3/client_initialization.html">Client initialization</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_v3/data_structures.html">Data structures</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_v3/error_handling.html">Error handling</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_v3/pagination.html">Pagination</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_v3/working_with_proxies_directly.html">Working with proxies directly</a></li>
</ul>
</div>
</div>
<div class="section" id="resources-info">
<h2>Resources info<a class="headerlink" href="#resources-info" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="client_v3/proxies.html">Proxies</a><ul>
<li class="toctree-l2"><a class="reference internal" href="client_v3/proxies.html#base">Base</a></li>
<li class="toctree-l2"><a class="reference internal" href="client_v3/proxies.html#project">Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="client_v3/proxies.html#build">Build</a></li>
<li class="toctree-l2"><a class="reference internal" href="client_v3/proxies.html#package">Package</a></li>
<li class="toctree-l2"><a class="reference internal" href="client_v3/proxies.html#module">Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="client_v3/proxies.html#project-chroot">Project Chroot</a></li>
<li class="toctree-l2"><a class="reference internal" href="client_v3/proxies.html#build-chroot">Build Chroot</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="parameters">
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="client_v3/build_options.html">Build Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_v3/package_source_types.html">Package Source Type</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="client_v3/client_initialization.html" class="btn btn-neutral float-right" title="Client initialization" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="client_v2/entities.html" class="btn btn-neutral float-left" title="Entities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Red Hat, Inc.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
40e2f31081093569df699eb11a858fc8
>
files
>
6
