blob: 02e13b5622eabf37d30cd867729d2e000c912780 [file] [log] [blame]
<!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>Apache UserALE &mdash; Apache UserALE.PyQt5 0.1.5 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="Apache UserALE.PyQt5 0.1.5 documentation" href="#"/>
<link rel="next" title="Installation Guide" href="installation.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<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="#" class="icon icon-home"> Apache UserALE.PyQt5
</a>
<div class="version">
0.1.5
</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 Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="userale.html">ALE Library</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to Apache UserALE.PyQt5</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Apache UserALE.PyQt5</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="#">Docs</a> &raquo;</li>
<li>Apache UserALE</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="apache-userale">
<h1>Apache UserALE<a class="headerlink" href="#apache-userale" title="Permalink to this headline"></a></h1>
<p>Apache UserALE.PyQt5 is one of the Software As A Sensor™ products. The goal of Software As A Sensor™ is to develop understanding
of your users through their interactions with your software product. You can then apply that understanding to improve your
product&#8217;s design and functionality. Apache UserALE.PyQt5 provides an easy way to generate highly detailed log streams from any PyQt5 application.</p>
<p>Apache UserALE.PyQt5 is developed at Draper and released free and open source through the Apache v2.0 license. Bug reports and contributions are welcome through Jira.</p>
<div class="section" id="user-s-guide">
<h2>User&#8217;s Guide<a class="headerlink" href="#user-s-guide" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-apache-userale-pyqt5">Installing Apache UserALE.PyQt5</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-apache-userale-pyqt5-in-an-virtual-environment">Installing Apache UserALE.PyQt5 in an Virtual Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#installing-documentation">Installing Documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#instrumenting-your-application-globally-with-apache-userale-pyqt5">Instrumenting Your Application Globally with Apache UserALE.PyQt5</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#instrumenting-your-application-manually-with-apache-userale-pyqt5">Instrumenting Your Application Manually with Apache UserALE.PyQt5</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="api-reference">
<h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h2>
<p>This entire section is mainly for developers of Apache UserALE.PyQt5. This section was automatically generated by <a class="reference external" href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> and <a class="reference external" href="http://apidocjs.com/">apidoc</a>.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="userale.html">ALE Library</a><ul>
<li class="toctree-l2"><a class="reference internal" href="userale.html#module-userale.ale">Apache UserALE.PyQt5</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="additional-notes">
<h2>Additional Notes<a class="headerlink" href="#additional-notes" title="Permalink to this headline"></a></h2>
<p>Design notes, legal information and changelog are here.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="authors.html#development-lead">Development Lead</a></li>
<li class="toctree-l2"><a class="reference internal" href="authors.html#additional-staff">Additional Staff</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to Apache UserALE.PyQt5</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#id2">0.1.5 (2016-09-19)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">0.1.4 (2016-08-04)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">0.1.3 (2016-08-02)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">0.1.2 (2016-08-01)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id6">0.1.1 (2016-07-29)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">0.1.0 (2016-06-24)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="installation.html" class="btn btn-neutral float-right" title="Installation Guide" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2016, Apache Software License.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.1.5',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</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/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>