<!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>Project — 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="Project chroot" href="project_chroot.html" />
<link rel="prev" title="Error handling" href="../errors.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 current"><a class="reference internal" href="../../ClientV2.html">Client version 2</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../initialization.html">Client initialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="../resources_usage.html">Resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="../errors.html">Error handling</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../ClientV2.html#resources-info">Resources info</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Project</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#project-entity-attributes">Project entity attributes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#get-projects-list">Get projects list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#get-one-project">Get one project</a></li>
<li class="toctree-l4"><a class="reference internal" href="#modify-project-parameters">Modify project parameters</a></li>
<li class="toctree-l4"><a class="reference internal" href="#delete-project">Delete project</a></li>
<li class="toctree-l4"><a class="reference internal" href="#create-new-project">Create new project</a></li>
<li class="toctree-l4"><a class="reference internal" href="#access-project-chroots">Access project chroots</a></li>
<li class="toctree-l4"><a class="reference internal" href="#access-project-builds">Access project builds</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="project_chroot.html">Project chroot</a></li>
<li class="toctree-l3"><a class="reference internal" href="build.html">Build</a></li>
<li class="toctree-l3"><a class="reference internal" href="build_task.html">Build task</a></li>
<li class="toctree-l3"><a class="reference internal" href="mock_chroot.html">Mock chroot</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../ClientV2.html#autodoc">Autodoc</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../ClientV3.html">Client version 3</a></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><a href="../../ClientV2.html">Client version 2</a> »</li>
<li>Project</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/client_v2/resource_info/project.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="project">
<span id="project-info"></span><h1>Project<a class="headerlink" href="#project" title="Permalink to this headline">¶</a></h1>
<p>Project resource represents copr projects and operations with them.</p>
<p>Access to the projects is done through <a class="reference internal" href="../general.html#copr.client_v2.client.CoprClient.projects" title="copr.client_v2.client.CoprClient.projects"><code class="xref py py-meth docutils literal notranslate"><span class="pre">projects()</span></code></a>.
property of initialized <a class="reference internal" href="../general.html#copr.client_v2.client.CoprClient" title="copr.client_v2.client.CoprClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">CoprClient</span></code></a>. That property is an instance of
<a class="reference internal" href="../handlers.html#copr.client_v2.handlers.ProjectHandle" title="copr.client_v2.handlers.ProjectHandle"><code class="xref py py-class docutils literal notranslate"><span class="pre">ProjectHandle</span></code></a>. Projects are represented by
<a class="reference internal" href="../resources.html#copr.client_v2.resources.Project" title="copr.client_v2.resources.Project"><code class="xref py py-class docutils literal notranslate"><span class="pre">Project</span></code></a> class.</p>
<div class="section" id="project-entity-attributes">
<span id="project-attributes"></span><h2>Project entity attributes<a class="headerlink" href="#project-entity-attributes" title="Permalink to this headline">¶</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="14%" />
<col width="16%" />
<col width="7%" />
<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Type</th>
<th class="head">Can edit?</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>id</td>
<td>number</td>
<td>no</td>
<td>unique identifier</td>
</tr>
<tr class="row-odd"><td>owner</td>
<td>string</td>
<td>no</td>
<td>username of the project owner</td>
</tr>
<tr class="row-even"><td>group</td>
<td>string</td>
<td>no</td>
<td><dl class="first last docutils">
<dt>name of the group which owns the project, value is null for non-group projects</dt>
<dd><ul class="first last simple">
<li>MAY be specified during a project creation to create a group managed project</li>
</ul>
</dd>
</dl>
</td>
</tr>
<tr class="row-odd"><td>name</td>
<td>string</td>
<td>no</td>
<td><dl class="first last docutils">
<dt>name of the project</dt>
<dd><ul class="first last simple">
<li>MUST be specified during a project creation</li>
</ul>
</dd>
</dl>
</td>
</tr>
<tr class="row-even"><td>description</td>
<td>string</td>
<td>yes</td>
<td>project description</td>
</tr>
<tr class="row-odd"><td>instructions</td>
<td>string</td>
<td>yes</td>
<td>installation instructions</td>
</tr>
<tr class="row-even"><td>homepage</td>
<td>string(URL)</td>
<td>yes</td>
<td>project homepage URL</td>
</tr>
<tr class="row-odd"><td>contact</td>
<td>string(URL or email)</td>
<td>yes</td>
<td>contact with the project maintainer</td>
</tr>
<tr class="row-even"><td>disable_createrepo</td>
<td>bool</td>
<td>yes</td>
<td>disables automatic repository metadata generation</td>
</tr>
<tr class="row-odd"><td>build_enable_net</td>
<td>bool</td>
<td>yes</td>
<td>set default value for new builds option <code class="docutils literal notranslate"><span class="pre">enable_net</span></code></td>
</tr>
<tr class="row-even"><td>repos</td>
<td>list of string</td>
<td>yes</td>
<td>list of additional repositories to be enabled during the build</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">all following examples assume that we use <code class="docutils literal notranslate"><span class="pre">cl</span></code>
as an instance of <a class="reference internal" href="../general.html#copr.client_v2.client.CoprClient" title="copr.client_v2.client.CoprClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">client_v2.client.CoprClient</span></code></a></p>
</div>
</div>
<div class="section" id="get-projects-list">
<h2>Get projects list<a class="headerlink" href="#get-projects-list" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">plist_1</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">project</span><span class="o">.</span><span class="n">get_list</span><span class="p">(</span><span class="n">limit</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
<span class="go"># filter by name</span>
<span class="gp">>>> </span><span class="n">plist_2</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">project</span><span class="o">.</span><span class="n">get_list</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"copr"</span><span class="p">)</span>
<span class="go"># search by string</span>
<span class="gp">>>> </span><span class="n">plist_2</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">project</span><span class="o">.</span><span class="n">get_list</span><span class="p">(</span><span class="n">search_query</span><span class="o">=</span><span class="s2">"copr"</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="get-one-project">
<h2>Get one project<a class="headerlink" href="#get-one-project" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">p</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">projects</span><span class="o">.</span><span class="n">get_one</span><span class="p">(</span><span class="mi">1835</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="modify-project-parameters">
<h2>Modify project parameters<a class="headerlink" href="#modify-project-parameters" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">p</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="s2">"Nothing"</span>
<span class="gp">>>> </span><span class="n">p</span><span class="o">.</span><span class="n">update</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="delete-project">
<h2>Delete project<a class="headerlink" href="#delete-project" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">p</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="create-new-project">
<h2>Create new project<a class="headerlink" href="#create-new-project" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Here you could also provide list of chroots, which should be activated. Use key <code class="docutils literal notranslate"><span class="pre">chroots</span></code>.</p>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">res</span> <span class="o">=</span> <span class="n">cl</span><span class="o">.</span><span class="n">projects</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">"my_cool_project"</span><span class="p">,</span>
<span class="go"> owner="vgologuz",</span>
<span class="go"> instructions="don't touch me!",</span>
<span class="go"> chroots=["fedora-22-x86_64"])</span>
<span class="gp">>>> </span> <span class="k">print</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="go"><Project #5384: vgologuz/my_cool_project></span>
</pre></div>
</div>
</div>
<div class="section" id="access-project-chroots">
<h2>Access project chroots<a class="headerlink" href="#access-project-chroots" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">see also <a class="reference internal" href="project_chroot.html#project-chroot-info"><span class="std std-ref">Project chroot</span></a></p>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># get all lists</span>
<span class="o">>>></span> <span class="n">chroots</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">get_project_chroot_list</span><span class="p">()</span>
<span class="o">>>></span> <span class="k">print</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">chroots</span><span class="p">)))</span>
<span class="o"><</span><span class="n">Project</span> <span class="n">chroot</span><span class="p">:</span> <span class="n">fedora</span><span class="o">-</span><span class="mi">21</span><span class="o">-</span><span class="n">x86_64</span><span class="p">,</span> <span class="n">additional</span> <span class="n">packages</span><span class="p">:</span> <span class="p">[],</span> <span class="n">comps</span> <span class="n">size</span> <span class="k">if</span> <span class="nb">any</span><span class="p">:</span> <span class="mi">0</span><span class="o">></span>
<span class="o"><</span><span class="n">Project</span> <span class="n">chroot</span><span class="p">:</span> <span class="n">fedora</span><span class="o">-</span><span class="mi">21</span><span class="o">-</span><span class="n">i386</span><span class="p">,</span> <span class="n">additional</span> <span class="n">packages</span><span class="p">:</span> <span class="p">[],</span> <span class="n">comps</span> <span class="n">size</span> <span class="k">if</span> <span class="nb">any</span><span class="p">:</span> <span class="mi">0</span><span class="o">></span>
<span class="c1"># get one chroot</span>
<span class="o">>>></span> <span class="n">chroot_1</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">get_project_chroot</span><span class="p">(</span><span class="s2">"fedora-22-i386"</span><span class="p">)</span>
<span class="c1"># enable chroot for project</span>
<span class="o">>>></span> <span class="n">p</span><span class="o">.</span><span class="n">enable_project_chroot</span><span class="p">(</span><span class="s2">"fedora-22-x86_64)</span>
</pre></div>
</div>
</div>
<div class="section" id="access-project-builds">
<h2>Access project builds<a class="headerlink" href="#access-project-builds" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">see also <a class="reference internal" href="build.html#build-info"><span class="std std-ref">Build</span></a></p>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">p</span><span class="o">.</span><span class="n">get_builds</span><span class="p">(</span><span class="n">limit</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">pbuilds</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">get_builds</span><span class="p">(</span><span class="n">limit</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span><span class="p">(</span><span class="n">pbuilds</span><span class="p">[</span><span class="mi">3</span><span class="p">])</span>
<span class="go"><Build #138414 state: failed></span>
<span class="go"># submit new builds</span>
<span class="gp">>>> </span><span class="n">p</span><span class="o">.</span><span class="n">create_build_from_url</span><span class="p">(</span><span class="n">srpm_url</span><span class="o">=</span><span class="s2">"http://example.com/my.src.rpm"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">p</span><span class="o">.</span><span class="n">create_build_from_file</span><span class="p">(</span><span class="n">file_path</span><span class="o">=</span><span class="s2">"/tmp/my.src.rpm"</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="project_chroot.html" class="btn btn-neutral float-right" title="Project chroot" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../errors.html" class="btn btn-neutral float-left" title="Error handling" 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
>
137
