<!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">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>python-semanticversion — python-semanticversion 2.6.0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Reference" href="reference.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="reference.html" title="Reference"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">python-semanticversion 2.6.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="python-semanticversion">
<h1>python-semanticversion<a class="headerlink" href="#python-semanticversion" title="Permalink to this headline">¶</a></h1>
<p>This small python library provides a few tools to handle <a class="reference external" href="http://semver.org/">SemVer</a> in Python.
It follows strictly the 2.0.0 version of the SemVer scheme.</p>
<a class="reference external image-reference" href="http://travis-ci.org/rbarrois/python-semanticversion/"><img alt="https://secure.travis-ci.org/rbarrois/python-semanticversion.png?branch=master" src="https://secure.travis-ci.org/rbarrois/python-semanticversion.png?branch=master" /></a>
<a class="reference external image-reference" href="https://python-semanticversion.readthedocs.io/en/latest/changelog.html"><img alt="Latest Version" src="https://img.shields.io/pypi/v/semantic_version.svg" /></a>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/semantic_version/"><img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/semantic_version.svg" /></a>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/semantic_version/"><img alt="Wheel status" src="https://img.shields.io/pypi/wheel/semantic_version.svg" /></a>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/semantic_version/"><img alt="License" src="https://img.shields.io/pypi/l/semantic_version.svg" /></a>
<div class="section" id="links">
<h2>Links<a class="headerlink" href="#links" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Package on <a class="reference external" href="http://pypi.python.org/">PyPI</a>: <a class="reference external" href="http://pypi.python.org/pypi/semantic_version/">http://pypi.python.org/pypi/semantic_version/</a></li>
<li>Doc on <a class="reference external" href="http://readthedocs.org/">ReadTheDocs</a>: <a class="reference external" href="https://python-semanticversion.readthedocs.io/">https://python-semanticversion.readthedocs.io/</a></li>
<li>Source on <a class="reference external" href="http://github.com/">GitHub</a>: <a class="reference external" href="http://github.com/rbarrois/python-semanticversion/">http://github.com/rbarrois/python-semanticversion/</a></li>
<li>Build on <a class="reference external" href="http://travis-ci.org/">Travis CI</a>: <a class="reference external" href="http://travis-ci.org/rbarrois/python-semanticversion/">http://travis-ci.org/rbarrois/python-semanticversion/</a></li>
<li>Semantic Version specification: <a class="reference external" href="http://semver.org/">SemVer</a></li>
</ul>
</div>
</div>
<div class="section" id="getting-started">
<h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
<p>Install the package from <a class="reference external" href="http://pypi.python.org/">PyPI</a>, using pip:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install semantic_version
</pre></div>
</div>
<p>Or from GitHub:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ git clone git://github.com/rbarrois/python-semanticversion.git
</pre></div>
</div>
<p>Import it in your code:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">semantic_version</span>
</pre></div>
</div>
<p>This module provides two classes to handle semantic versions:</p>
<ul class="simple">
<li><a class="reference internal" href="reference.html#semantic_version.Version" title="semantic_version.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Version</span></code></a> represents a version number (<code class="docutils literal notranslate"><span class="pre">0.1.1-alpha+build.2012-05-15</span></code>)</li>
<li><a class="reference internal" href="reference.html#semantic_version.Spec" title="semantic_version.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Spec</span></code></a> represents a requirement specification (<code class="docutils literal notranslate"><span class="pre">>=0.1.1,<0.3.0</span></code>)</li>
</ul>
<div class="section" id="versions">
<h2>Versions<a class="headerlink" href="#versions" title="Permalink to this headline">¶</a></h2>
<p>Defining a <a class="reference internal" href="reference.html#semantic_version.Version" title="semantic_version.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Version</span></code></a> is quite simple:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">semantic_version</span>
<span class="gp">>>> </span><span class="n">v</span> <span class="o">=</span> <span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.1'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">v</span><span class="o">.</span><span class="n">major</span>
<span class="go">0</span>
<span class="gp">>>> </span><span class="n">v</span><span class="o">.</span><span class="n">minor</span>
<span class="go">1</span>
<span class="gp">>>> </span><span class="n">v</span><span class="o">.</span><span class="n">patch</span>
<span class="go">1</span>
<span class="gp">>>> </span><span class="n">v</span><span class="o">.</span><span class="n">prerelease</span>
<span class="go">[]</span>
<span class="gp">>>> </span><span class="n">v</span><span class="o">.</span><span class="n">build</span>
<span class="go">[]</span>
<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="go">[0, 1, 1, [], []]</span>
</pre></div>
</div>
<p>If the provided version string is invalid, a <code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> will be raised:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1'</span><span class="p">)</span>
<span class="gt">Traceback (most recent call last):</span>
File <span class="nb">"<stdin>"</span>, line <span class="m">1</span>, in <span class="n"><module></span>
File <span class="nb">"/Users/rbarrois/dev/semantic_version/src/semantic_version/base.py"</span>, line <span class="m">64</span>, in <span class="n">__init__</span>
<span class="n">major</span><span class="p">,</span> <span class="n">minor</span><span class="p">,</span> <span class="n">patch</span><span class="p">,</span> <span class="n">prerelease</span><span class="p">,</span> <span class="n">build</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">version_string</span><span class="p">,</span> <span class="n">partial</span><span class="p">)</span>
File <span class="nb">"/Users/rbarrois/dev/semantic_version/src/semantic_version/base.py"</span>, line <span class="m">86</span>, in <span class="n">parse</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Invalid version string: </span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> <span class="n">version_string</span><span class="p">)</span>
<span class="gr">ValueError</span>: <span class="n">Invalid version string: '0.1'</span>
</pre></div>
</div>
<p>In order to define “relaxed” version strings, you must pass in <code class="docutils literal notranslate"><span class="pre">partial=True</span></code>:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">v</span> <span class="o">=</span> <span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1'</span><span class="p">,</span> <span class="n">partial</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="go">[0, 1, None, None, None]</span>
</pre></div>
</div>
<p>Obviously, <a class="reference internal" href="reference.html#semantic_version.Version" title="semantic_version.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Versions</span></code></a> can be compared:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.1'</span><span class="p">)</span> <span class="o"><</span> <span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.2'</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.1'</span><span class="p">)</span> <span class="o">></span> <span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.1-alpha'</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.1'</span><span class="p">)</span> <span class="o"><=</span> <span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.1-alpha'</span><span class="p">)</span>
<span class="go">False</span>
</pre></div>
</div>
<p>You can also get a new version that represents a bump in one of the version levels:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">v</span> <span class="o">=</span> <span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.1-pre+build'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">new_v</span> <span class="o">=</span> <span class="n">v</span><span class="o">.</span><span class="n">next_major</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">new_v</span><span class="p">)</span>
<span class="go">'1.0.0'</span>
<span class="gp">>>> </span><span class="n">v</span> <span class="o">=</span> <span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'1.1.1-pre+build'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">new_v</span> <span class="o">=</span> <span class="n">v</span><span class="o">.</span><span class="n">next_minor</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">new_v</span><span class="p">)</span>
<span class="go">'1.2.0'</span>
<span class="gp">>>> </span><span class="n">v</span> <span class="o">=</span> <span class="n">semantic_version</span><span class="o">.</span><span class="n">Version</span><span class="p">(</span><span class="s1">'1.1.1-pre+build'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">new_v</span> <span class="o">=</span> <span class="n">v</span><span class="o">.</span><span class="n">next_patch</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">new_v</span><span class="p">)</span>
<span class="go">'1.1.2'</span>
</pre></div>
</div>
<p>It is also possible to check whether a given string is a proper semantic version string:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">semantic_version</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="s1">'0.1.3'</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">semantic_version</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="s1">'0a2'</span><span class="p">)</span>
<span class="go">False</span>
</pre></div>
</div>
</div>
<div class="section" id="requirement-specification">
<h2>Requirement specification<a class="headerlink" href="#requirement-specification" title="Permalink to this headline">¶</a></h2>
<p>The <a class="reference internal" href="reference.html#semantic_version.Spec" title="semantic_version.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Spec</span></code></a> object describes a range of accepted versions:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">s</span> <span class="o">=</span> <span class="n">Spec</span><span class="p">(</span><span class="s1">'>=0.1.1'</span><span class="p">)</span> <span class="c1"># At least 0.1.1</span>
<span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.1'</span><span class="p">))</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.1-alpha1'</span><span class="p">))</span> <span class="c1"># pre-release satisfy version spec</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.0'</span><span class="p">))</span>
<span class="go">False</span>
</pre></div>
</div>
<p>Simpler test syntax is also available using the <code class="docutils literal notranslate"><span class="pre">in</span></code> keyword:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">s</span> <span class="o">=</span> <span class="n">Spec</span><span class="p">(</span><span class="s1">'==0.1.1'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.1-alpha1'</span><span class="p">)</span> <span class="ow">in</span> <span class="n">s</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.2'</span><span class="p">)</span> <span class="ow">in</span> <span class="n">s</span>
<span class="go">False</span>
</pre></div>
</div>
<p>Combining specifications can be expressed in two ways:</p>
<ul>
<li><p class="first">Components separated by commas in a single string:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Spec</span><span class="p">(</span><span class="s1">'>=0.1.1,<0.3.0'</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">Components given as different arguments:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Spec</span><span class="p">(</span><span class="s1">'>=0.1.1'</span><span class="p">,</span> <span class="s1">'<0.3.0'</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">A mix of both versions:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Spec</span><span class="p">(</span><span class="s1">'>=0.1.1'</span><span class="p">,</span> <span class="s1">'!=0.2.4-alpha,<0.3.0'</span><span class="p">)</span>
</pre></div>
</div>
</li>
</ul>
<div class="section" id="using-a-specification">
<h3>Using a specification<a class="headerlink" href="#using-a-specification" title="Permalink to this headline">¶</a></h3>
<p>The <a class="reference internal" href="reference.html#semantic_version.Spec.filter" title="semantic_version.Spec.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">Spec.filter()</span></code></a> method filters an iterable of <a class="reference internal" href="reference.html#semantic_version.Version" title="semantic_version.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Version</span></code></a>:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">s</span> <span class="o">=</span> <span class="n">Spec</span><span class="p">(</span><span class="s1">'>=0.1.0,<0.4.0'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">versions</span> <span class="o">=</span> <span class="p">(</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.</span><span class="si">%d</span><span class="s1">.0'</span> <span class="o">%</span> <span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">6</span><span class="p">))</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">s</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">versions</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">print</span> <span class="n">v</span>
<span class="go">0.1.0</span>
<span class="go">0.2.0</span>
<span class="go">0.3.0</span>
</pre></div>
</div>
<p>It is also possible to select the ‘best’ version from such iterables:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">s</span> <span class="o">=</span> <span class="n">Spec</span><span class="p">(</span><span class="s1">'>=0.1.0,<0.4.0'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">versions</span> <span class="o">=</span> <span class="p">(</span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.</span><span class="si">%d</span><span class="s1">.0'</span> <span class="o">%</span> <span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">6</span><span class="p">))</span>
<span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">versions</span><span class="p">)</span>
<span class="go">Version('0.3.0')</span>
</pre></div>
</div>
</div>
<div class="section" id="coercing-an-arbitrary-version-string">
<h3>Coercing an arbitrary version string<a class="headerlink" href="#coercing-an-arbitrary-version-string" title="Permalink to this headline">¶</a></h3>
<p>Some user-supplied input might not match the semantic version scheme.
For such cases, the <a class="reference internal" href="reference.html#semantic_version.Version.coerce" title="semantic_version.Version.coerce"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Version.coerce()</span></code></a> method will try to convert any
version-like string into a valid semver version:</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Version</span><span class="o">.</span><span class="n">coerce</span><span class="p">(</span><span class="s1">'0'</span><span class="p">)</span>
<span class="go">Version('0.0.0')</span>
<span class="gp">>>> </span><span class="n">Version</span><span class="o">.</span><span class="n">coerce</span><span class="p">(</span><span class="s1">'0.1.2.3.4'</span><span class="p">)</span>
<span class="go">Version('0.1.2+3.4')</span>
<span class="gp">>>> </span><span class="n">Version</span><span class="o">.</span><span class="n">coerce</span><span class="p">(</span><span class="s1">'0.1.2a3'</span><span class="p">)</span>
<span class="go">Version('0.1.2-a3')</span>
</pre></div>
</div>
</div>
<div class="section" id="including-pre-release-identifiers-in-specifications">
<h3>Including pre-release identifiers in specifications<a class="headerlink" href="#including-pre-release-identifiers-in-specifications" title="Permalink to this headline">¶</a></h3>
<p>When testing a <a class="reference internal" href="reference.html#semantic_version.Version" title="semantic_version.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Version</span></code></a> against a <a class="reference internal" href="reference.html#semantic_version.Spec" title="semantic_version.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Spec</span></code></a>, comparisons are only
performed for components defined in the <a class="reference internal" href="reference.html#semantic_version.Spec" title="semantic_version.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Spec</span></code></a>; thus, a pre-release
version (<code class="docutils literal notranslate"><span class="pre">1.0.0-alpha</span></code>), while not strictly equal to the non pre-release
version (<code class="docutils literal notranslate"><span class="pre">1.0.0</span></code>), satisfies the <code class="docutils literal notranslate"><span class="pre">==1.0.0</span></code> <a class="reference internal" href="reference.html#semantic_version.Spec" title="semantic_version.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Spec</span></code></a>.</p>
<p>Pre-release identifiers will only be compared if included in the <a class="reference internal" href="reference.html#semantic_version.Spec" title="semantic_version.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Spec</span></code></a>
definition or (for the empty pre-release number) if a single dash is appended
(<code class="docutils literal notranslate"><span class="pre">1.0.0-</span></code>):</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.0-alpha'</span><span class="p">)</span> <span class="ow">in</span> <span class="n">Spec</span><span class="p">(</span><span class="s1">'>=0.1.0'</span><span class="p">)</span> <span class="c1"># No pre-release identifier</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">Version</span><span class="p">(</span><span class="s1">'0.1.0-alpha'</span><span class="p">)</span> <span class="ow">in</span> <span class="n">Spec</span><span class="p">(</span><span class="s1">'>=0.1.0-'</span><span class="p">)</span> <span class="c1"># Include pre-release in checks</span>
<span class="go">False</span>
</pre></div>
</div>
</div>
<div class="section" id="including-build-metadata-in-specifications">
<h3>Including build metadata in specifications<a class="headerlink" href="#including-build-metadata-in-specifications" title="Permalink to this headline">¶</a></h3>
<p>Build metadata has no ordering; thus, the only meaningful comparison including
build metadata is equality.</p>
<div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Version</span><span class="p">(</span><span class="s1">'1.0.0+build2'</span><span class="p">)</span> <span class="ow">in</span> <span class="n">Spec</span><span class="p">(</span><span class="s1">'<=1.0.0'</span><span class="p">)</span> <span class="c1"># Build metadata ignored</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">Version</span><span class="p">(</span><span class="s1">'1.0.0+build2'</span><span class="p">)</span> <span class="ow">in</span> <span class="n">Spec</span><span class="p">(</span><span class="s1">'==1.0.0+build2'</span><span class="p">)</span> <span class="c1"># Include build in checks</span>
<span class="go">False</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="using-with-django">
<h1>Using with Django<a class="headerlink" href="#using-with-django" title="Permalink to this headline">¶</a></h1>
<p>The <a class="reference internal" href="django.html#module-semantic_version.django_fields" title="semantic_version.django_fields"><code class="xref py py-mod docutils literal notranslate"><span class="pre">semantic_version.django_fields</span></code></a> module provides django fields to
store <a class="reference internal" href="reference.html#semantic_version.Version" title="semantic_version.Version"><code class="xref py py-class docutils literal notranslate"><span class="pre">Version</span></code></a> or <a class="reference internal" href="reference.html#semantic_version.Spec" title="semantic_version.Spec"><code class="xref py py-class docutils literal notranslate"><span class="pre">Spec</span></code></a> objects.</p>
<p>More documentation is available in the <a class="reference internal" href="django.html"><span class="doc">Interaction with Django</span></a> section.</p>
</div>
<div class="section" id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
<p>In order to contribute to the source code:</p>
<ul class="simple">
<li>Open an issue on <a class="reference external" href="http://github.com/">GitHub</a>: <a class="reference external" href="https://github.com/rbarrois/python-semanticversion/issues">https://github.com/rbarrois/python-semanticversion/issues</a></li>
<li>Fork the <a class="reference external" href="https://github.com/rbarrois/python-semanticversion">repository</a>
and submit a pull request on <a class="reference external" href="http://github.com/">GitHub</a></li>
<li>Or send me a patch (<a class="reference external" href="mailto:raphael.barrois+semver%40polytechnique.org">mailto:raphael<span>.</span>barrois+semver<span>@</span>polytechnique<span>.</span>org</a>)</li>
</ul>
<p>When submitting patches or pull requests, you should respect the following rules:</p>
<ul class="simple">
<li>Coding conventions are based on <span class="target" id="index-0"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0008"><strong>PEP 8</strong></a></li>
<li>The whole test suite must pass after adding the changes</li>
<li>The test coverage for a new feature must be 100%</li>
<li>New features and methods should be documented in the <a class="reference internal" href="reference.html"><span class="doc">Reference</span></a> section
and included in the <a class="reference internal" href="changelog.html"><span class="doc">ChangeLog</span></a></li>
<li>Include your name in the <span class="xref std std-ref">contributors</span> section</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>All files should contain the following header:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># -*- encoding: utf-8 -*-</span>
<span class="c1"># Copyright (c) The python-semanticversion project</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="contents">
<h1>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-level-functions">Module-level functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#representing-a-version-the-version-class">Representing a version (the Version class)</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#version-specifications-the-spec-class">Version specifications (the Spec class)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="django.html">Interaction with Django</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">ChangeLog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">2.6.0 (2016-09-25)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">2.5.0 (2016-02-12)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id8">2.4.2 (2015-07-02)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id9">2.4.1 (2015-04-01)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id10">2.4.0 (2015-04-01)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id12">2.3.1 (2014-09-24)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id14">2.3.0 (2014-03-16)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id16">2.2.2 (2013-12-23)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id18">2.2.1 (2013-10-29)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id20">2.2.0 (2013-03-22)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id22">2.1.2 (2012-05-22)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id23">2.1.1 (2012-05-22)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id24">2.1.0 (2012-05-22)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id25">2.0.0 (2012-05-22)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id26">1.2.0 (2012-05-18)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id27">1.1.0 (2012-05-18)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id28">1.0.0 (2012-05-17)</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">python-semanticversion</a><ul>
<li><a class="reference internal" href="#links">Links</a></li>
</ul>
</li>
<li><a class="reference internal" href="#getting-started">Getting started</a><ul>
<li><a class="reference internal" href="#versions">Versions</a></li>
<li><a class="reference internal" href="#requirement-specification">Requirement specification</a><ul>
<li><a class="reference internal" href="#using-a-specification">Using a specification</a></li>
<li><a class="reference internal" href="#coercing-an-arbitrary-version-string">Coercing an arbitrary version string</a></li>
<li><a class="reference internal" href="#including-pre-release-identifiers-in-specifications">Including pre-release identifiers in specifications</a></li>
<li><a class="reference internal" href="#including-build-metadata-in-specifications">Including build metadata in specifications</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#using-with-django">Using with Django</a></li>
<li><a class="reference internal" href="#contributing">Contributing</a></li>
<li><a class="reference internal" href="#contents">Contents</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="reference.html"
title="next chapter">Reference</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="reference.html" title="Reference"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">python-semanticversion 2.6.0 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2012-2014, The python-semanticversion project.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
be0ec2edf5701fac1f75c3921aad621f
>
files
>
37
