1<!DOCTYPE html> 2<html class="writer-html5" lang="en" data-content_root="./"> 3<head> 4 <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> 5 6 <meta name="viewport" content="width=device-width, initial-scale=1.0" /> 7 <title>Installation — gcovr 8.6 documentation</title> 8 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" /> 9 <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" /> 10 11 12 <link rel="canonical" href="https://gcovr.com/en/stable/installation.html" /> 13 <!--[if lt IE 9]> 14
14<script src="_static/js/html5shiv.min.js"></script>
14 15 <![endif]--> 16 17
17<script src="_static/jquery.js?v=5d32c60e"></script>
17 18
18<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
18 19
19<script src="_static/documentation_options.js?v=d4c83366"></script>
19 20
20<script src="_static/doctools.js?v=9a2dae69"></script>
20 21
21<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
21 22
22<script src="_static/js/theme.js"></script>
22 23 <link rel="index" title="Index" href="genindex.html" /> 24 <link rel="search" title="Search" href="search.html" /> 25 <link rel="next" title="Getting Started" href="getting-started.html" /> 26 <link rel="prev" title="gcovr" href="index.html" />
27<script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script>
27<meta name="readthedocs-project-slug" content="gcovr" /><meta name="readthedocs-version-slug" content="stable" /><meta name="readthedocs-resolver-filename" content="/installation.html" /><meta name="readthedocs-http-status" content="200" /></head> 28 29<body class="wy-body-for-nav"> 30 <div class="wy-grid-for-nav"> 31 <nav data-toggle="wy-nav-shift" class="wy-nav-side"> 32 <div class="wy-side-scroll"> 33 <div class="wy-side-nav-search" > 34 35 36 37 <a href="index.html" class="icon icon-home"> 38 gcovr 39 </a> 40 <div class="version"> 41 8.6 42 </div> 43<div role="search"> 44 <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> 45 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> 46 <input type="hidden" name="check_keywords" value="yes" /> 47 <input type="hidden" name="area" value="default" /> 48 </form> 49</div> 50 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> 51 <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> 52<ul class="current"> 53<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li> 54<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started</a></li> 55<li class="toctree-l1"><a class="reference internal" href="guide.html">User Guide</a></li> 56<li class="toctree-l1"><a class="reference internal" href="manpage.html">Command Line Reference</a></li> 57<li class="toctree-l1"><a class="reference internal" href="cookbook.html">Cookbook</a></li> 58<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li> 59<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> 60<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change Log</a></li> 61<li class="toctree-l1"><a class="reference internal" href="known_bugs.html">Known bugs</a></li> 62<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li> 63</ul> 64 65 </div> 66 </div> 67 </nav> 68 69 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > 70 <i data-toggle="wy-nav-top" class="fa fa-bars"></i> 71 <a href="index.html">gcovr</a> 72 </nav> 73 74 <div class="wy-nav-content"> 75 <div class="rst-content"> 76 <div role="navigation" aria-label="Page navigation"> 77 <ul class="wy-breadcrumbs"> 78 <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> 79 <li class="breadcrumb-item active">Installation</li> 80 <li class="wy-breadcrumbs-aside"> 81 <a href="_sources/installation.rst.txt" rel="nofollow"> View page source</a> 82 </li> 83 </ul> 84 <hr/> 85</div> 86 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> 87 <div itemprop="articleBody"> 88 89 <section id="installation"> 90<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">ï</a></h1> 91<p>Gcovr is available as a Python package that can be installed via <a class="reference external" href="https://pip.pypa.io/en/stable">pip</a>.</p> 92<p>Install newest stable <code class="docutils literal notranslate"><span class="pre">gcovr</span></code> release from PyPI:</p> 93<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>gcovr 94</pre></div> 95</div> 96<p>Install development version from GitHub (needs at least version <cite>21.3</cite> of pip):</p> 97<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>git+https://github.com/gcovr/gcovr.git 98</pre></div> 99</div> 100<p>Which environments does <code class="docutils literal notranslate"><span class="pre">gcovr</span></code> support?</p> 101<dl> 102<dt>Python:</dt><dd><p>3.10+.</p> 103<p>The automated tests run on CPython (versions 3.10, 3.11, 3.12, 3.13) 104and a compatible PyPy3.
105Gcovr will only run on Python versions with upstream support.</p> 106<p>Last gcovr release for old Python versions:</p> 107<table class="docutils align-default"> 108<thead> 109<tr class="row-odd"><th class="head"><p>Python</p></th> 110<th class="head"><p>gcovr</p></th> 111</tr> 112</thead> 113<tbody> 114<tr class="row-even"><td><p>2.6</p></td> 115<td><p>3.4</p></td> 116</tr> 117<tr class="row-odd"><td><p>2.7</p></td> 118<td><p>4.2</p></td> 119</tr> 120<tr class="row-even"><td><p>3.4</p></td> 121<td><p>4.1</p></td> 122</tr> 123<tr class="row-odd"><td><p>3.5</p></td> 124<td><p>4.2</p></td> 125</tr> 126<tr class="row-even"><td><p>3.6</p></td> 127<td><p>5.0</p></td> 128</tr> 129<tr class="row-odd"><td><p>3.7</p></td> 130<td><p>6.0</p></td> 131</tr> 132<tr class="row-even"><td><p>3.8</p></td> 133<td><p>8.2</p></td> 134</tr> 135<tr class="row-odd"><td><p>3.9</p></td> 136<td><p>8.5</p></td> 137</tr> 138</tbody> 139</table> 140</dd> 141<dt>Operating System:</dt><dd><p>Linux, Windows, and macOS.</p> 142<p>The automated tests run on:</p> 143<ul class="simple"> 144<li><p>Ubuntu 20.04, 22.04 and 24.04</p></li> 145<li><p>Windows Server 2022 and 2025</p></li> 146<li><p>MacOS 14 and 15.</p></li> 147</ul> 148</dd> 149<dt>Compiler:</dt><dd><p>GCC and Clang. The versions used for development tests are 150documented in the <a class="reference internal" href="contributing.html#development-environment"><span class="std std-ref">contribution guide</span></a>.</p> 151</dd> 152</dl> 153</section> 154 155 156 </div> 157 </div> 158 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> 159 <a href="index.html" class="btn btn-neutral float-left" title="gcovr" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> 160 <a href="getting-started.html" class="btn btn-neutral float-right" title="Getting Started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> 161 </div> 162 163 <hr/> 164 165 <div role="contentinfo"> 166 <p>© Copyright 2026, the gcovr authors.</p> 167 </div> 168 169 Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a 170 <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> 171 provided by <a href="https://readthedocs.org">Read the Docs</a>. 172 173 174</footer> 175 </div> 176 </div> 177 </section> 178 </div> 179 180 181
182<script> 183 jQuery(function () { 184 SphinxRtdTheme.Navigation.enable(true); 185 }); 186 </script>
186 187 188</body> 189</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.