arsenetar
/
dupeguru
mirror of https://github.com/arsenetar/dupeguru.git
1
0
Fork 0
Code Releases Wiki Activity
dupeguru/help/en/developer/hscommon/build.html

112 lines
7.1 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>hscommon.build &#8212; dupeGuru 4.0.3 documentation</title>
<link rel="stylesheet" href="../../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" 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/translations.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="hscommon.conflict" href="conflict.html" />
<link rel="prev" title="hscommon" href="index.html" />
</head><body>
<div class="header" role="banner"><h1 class="heading"><a href="../../index.html">
<span>dupeGuru 4.0.3 documentation</span></a></h1>
<h2 class="heading"><span>hscommon.build</span></h2>
</div>
<div class="topnav" role="navigation" aria-label="top navigation">
<p>
«&#160;&#160;<a href="index.html">hscommon</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="conflict.html">hscommon.conflict</a>&#160;&#160;»
</p>
</div>
<div class="content">
<div class="section" id="module-hscommon.build">
<span id="hscommon-build"></span><h1>hscommon.build<a class="headerlink" href="#module-hscommon.build" title="Permalink to this headline"></a></h1>
<p>This module is a collection of function to help in HS apps build process.</p>
<dl class="function">
<dt id="hscommon.build.add_to_pythonpath">
<code class="descclassname">hscommon.build.</code><code class="descname">add_to_pythonpath</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#hscommon.build.add_to_pythonpath" title="Permalink to this definition"></a></dt>
<dd><p>Adds <code class="docutils literal notranslate"><span class="pre">path</span></code> to both <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> env and <code class="docutils literal notranslate"><span class="pre">sys.path</span></code>.</p>
</dd></dl>
<dl class="function">
<dt id="hscommon.build.build_debian_changelog">
<code class="descclassname">hscommon.build.</code><code class="descname">build_debian_changelog</code><span class="sig-paren">(</span><em>changelogpath</em>, <em>destfile</em>, <em>pkgname</em>, <em>from_version=None</em>, <em>distribution='precise'</em>, <em>fix_version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#hscommon.build.build_debian_changelog" title="Permalink to this definition"></a></dt>
<dd><p>Builds a debian changelog out of a YAML changelog.</p>
<p>Use fix_version to patch the top changelog to that version (if, for example, there was a
packaging error and you need to quickly fix it)</p>
</dd></dl>
<dl class="function">
<dt id="hscommon.build.build_dmg">
<code class="descclassname">hscommon.build.</code><code class="descname">build_dmg</code><span class="sig-paren">(</span><em>app_path</em>, <em>destfolder</em><span class="sig-paren">)</span><a class="headerlink" href="#hscommon.build.build_dmg" title="Permalink to this definition"></a></dt>
<dd><p>Builds a DMG volume with application at <code class="docutils literal notranslate"><span class="pre">app_path</span></code> and puts it in <code class="docutils literal notranslate"><span class="pre">dest_path</span></code>.</p>
<p>The name of the resulting DMG volume is determined by the app’s name and version.</p>
</dd></dl>
<dl class="function">
<dt id="hscommon.build.copy_packages">
<code class="descclassname">hscommon.build.</code><code class="descname">copy_packages</code><span class="sig-paren">(</span><em>packages_names</em>, <em>dest</em>, <em>create_links=False</em>, <em>extra_ignores=None</em><span class="sig-paren">)</span><a class="headerlink" href="#hscommon.build.copy_packages" title="Permalink to this definition"></a></dt>
<dd><p>Copy python packages <code class="docutils literal notranslate"><span class="pre">packages_names</span></code> to <code class="docutils literal notranslate"><span class="pre">dest</span></code>, spurious data.</p>
<p>Copy will happen without tests, testdata, mercurial data or C extension module source with it.
<code class="docutils literal notranslate"><span class="pre">py2app</span></code> include and exclude rules are <strong>quite</strong> funky, and doing this is the only reliable
way to make sure we don’t end up with useless stuff in our app.</p>
</dd></dl>
<dl class="function">
<dt id="hscommon.build.ensure_empty_folder">
<code class="descclassname">hscommon.build.</code><code class="descname">ensure_empty_folder</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#hscommon.build.ensure_empty_folder" title="Permalink to this definition"></a></dt>
<dd><p>Make sure that the path exists and that it’s an empty folder.</p>
</dd></dl>
<dl class="function">
<dt id="hscommon.build.filereplace">
<code class="descclassname">hscommon.build.</code><code class="descname">filereplace</code><span class="sig-paren">(</span><em>filename</em>, <em>outfilename=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#hscommon.build.filereplace" title="Permalink to this definition"></a></dt>
<dd><p>Reads <cite>filename</cite>, replaces all {variables} in kwargs, and writes the result to <cite>outfilename</cite>.</p>
</dd></dl>
<dl class="function">
<dt id="hscommon.build.print_and_do">
<code class="descclassname">hscommon.build.</code><code class="descname">print_and_do</code><span class="sig-paren">(</span><em>cmd</em><span class="sig-paren">)</span><a class="headerlink" href="#hscommon.build.print_and_do" title="Permalink to this definition"></a></dt>
<dd><p>Prints <code class="docutils literal notranslate"><span class="pre">cmd</span></code> and executes it in the shell.</p>
</dd></dl>
</div>
</div>
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
<p>
«&#160;&#160;<a href="index.html">hscommon</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="conflict.html">hscommon.conflict</a>&#160;&#160;»
</p>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2016, Hardcoded Software.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.1.
</div>
</body>
</html>
View Git Blame Copy Permalink