Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
UserAle 1.0.4 documentation.
  • Loading branch information
mooshu1x2 committed Aug 4, 2016
1 parent fe8384b commit 7d2c001cf9852c641a31247141b9dc0452348b7e
Showing 13 changed files with 90 additions and 71 deletions.
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 4b35783a5f38b39dd1e64d2ede9ca7e5
config: d5d62b3de4b8dd23755bbe727a0ef169
tags: 645f666f9bcd5a90fca523b33c5a78b7
@@ -39,7 +39,7 @@ Below is an example PyQt5 application taken from ZetCode PyQt5 tutorial instrume
app = QApplication(sys.argv)
ex = TestApplication()
# Initiate UserAle
ale = Ale (output="mouse.log", user="testUser", version="0.0.1")
ale = Ale (output="mouse.log", user="testUser", toolversion="0.0.1")
# install globally
app.installEventFilter (ale)

@@ -51,7 +51,7 @@ Simply instantiate UserAle and install it as an event filter in your application
::

# Initiate UserAle
ale = Ale (output="mouse.log", user="testUser", version="0.0.1")
ale = Ale (output="mouse.log", user="testUser", toolversion="0.0.1")
# install globally
app.installEventFilter (ale)

@@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Authors &mdash; UserAle 1.0.3 documentation</title>
<title>Authors &mdash; UserAle 1.0.4 documentation</title>



@@ -30,7 +30,7 @@



<link rel="top" title="UserAle 1.0.3 documentation" href="index.html"/>
<link rel="top" title="UserAle 1.0.4 documentation" href="index.html"/>
<link rel="next" title="Contributing to UserAle.pyqt5" href="contributing.html"/>
<link rel="prev" title="ALE Library" href="userale.html"/>

@@ -60,7 +60,7 @@


<div class="version">
1.0.3
1.0.4
</div>


@@ -200,7 +200,7 @@ <h2>Additional Staff<a class="headerlink" href="#additional-staff" title="Permal
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
@@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Changelog &mdash; UserAle 1.0.3 documentation</title>
<title>Changelog &mdash; UserAle 1.0.4 documentation</title>



@@ -30,7 +30,7 @@



<link rel="top" title="UserAle 1.0.3 documentation" href="index.html"/>
<link rel="top" title="UserAle 1.0.4 documentation" href="index.html"/>
<link rel="next" title="License" href="license.html"/>
<link rel="prev" title="Contributing to UserAle.pyqt5" href="contributing.html"/>

@@ -60,7 +60,7 @@


<div class="version">
1.0.3
1.0.4
</div>


@@ -92,10 +92,11 @@
<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 UserAle.pyqt5</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id2">1.0.3 (2016-08-02)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id3">1.0.2 (2016-08-01)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id4">1.0.1 (2016-07-29)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id5">1.0.0 (2016-06-24)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">1.0.4 (2016-08-04)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id3">1.0.3 (2016-08-02)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id4">1.0.2 (2016-08-01)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id5">1.0.1 (2016-07-29)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id6">1.0.0 (2016-06-24)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
@@ -144,7 +145,25 @@
<div class="section" id="changelog">
<span id="id1"></span><h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline"></a></h1>
<div class="section" id="id2">
<h2>1.0.3 (2016-08-02)<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
<h2>1.0.4 (2016-08-04)<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h2>
<ul>
<li><p class="first">New events UserAle is tracking:</p>
<blockquote>
<div><ul class="simple">
<li><code class="docutils literal"><span class="pre">mousemove</span></code></li>
<li><code class="docutils literal"><span class="pre">resize</span></code></li>
<li><code class="docutils literal"><span class="pre">scroll</span></code></li>
</ul>
</div></blockquote>
</li>
<li><p class="first">Remove timer from <code class="docutils literal"><span class="pre">dragdrop</span></code> log due to incorrect time being recorded.</p>
</li>
<li><p class="first">Session id is autogenerated if not passed into configuration.</p>
</li>
</ul>
</div>
<div class="section" id="id3">
<h2>1.0.3 (2016-08-02)<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h2>
<ul>
<li><p class="first">New events UserAle is tracking:</p>
<blockquote>
@@ -156,14 +175,14 @@ <h2>1.0.3 (2016-08-02)<a class="headerlink" href="#id2" title="Permalink to this
</li>
</ul>
</div>
<div class="section" id="id3">
<h2>1.0.2 (2016-08-01)<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h2>
<div class="section" id="id4">
<h2>1.0.2 (2016-08-01)<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>The elapsed time for a drag event is being recorded in the <code class="docutils literal"><span class="pre">dragdrop</span></code> log.</li>
</ul>
</div>
<div class="section" id="id4">
<h2>1.0.1 (2016-07-29)<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h2>
<div class="section" id="id5">
<h2>1.0.1 (2016-07-29)<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
<ul>
<li><p class="first">All logs will be stored to file called userale.log (configurable).</p>
</li>
@@ -186,8 +205,8 @@ <h2>1.0.1 (2016-07-29)<a class="headerlink" href="#id4" title="Permalink to this
</li>
</ul>
</div>
<div class="section" id="id5">
<h2>1.0.0 (2016-06-24)<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h2>
<div class="section" id="id6">
<h2>1.0.0 (2016-06-24)<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h2>
<p>Initial release.</p>
</div>
</div>
@@ -233,7 +252,7 @@ <h2>1.0.0 (2016-06-24)<a class="headerlink" href="#id5" title="Permalink to this
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
@@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Contributing to UserAle.pyqt5 &mdash; UserAle 1.0.3 documentation</title>
<title>Contributing to UserAle.pyqt5 &mdash; UserAle 1.0.4 documentation</title>



@@ -30,7 +30,7 @@



<link rel="top" title="UserAle 1.0.3 documentation" href="index.html"/>
<link rel="top" title="UserAle 1.0.4 documentation" href="index.html"/>
<link rel="next" title="Changelog" href="changelog.html"/>
<link rel="prev" title="Authors" href="authors.html"/>

@@ -60,7 +60,7 @@


<div class="version">
1.0.3
1.0.4
</div>


@@ -225,7 +225,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
@@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>UserAle &mdash; UserAle 1.0.3 documentation</title>
<title>UserAle &mdash; UserAle 1.0.4 documentation</title>



@@ -30,7 +30,7 @@



<link rel="top" title="UserAle 1.0.3 documentation" href="#"/>
<link rel="top" title="UserAle 1.0.4 documentation" href="#"/>
<link rel="next" title="Installation Guide" href="installation.html"/>


@@ -59,7 +59,7 @@


<div class="version">
1.0.3
1.0.4
</div>


@@ -183,10 +183,11 @@ <h2>Additional Notes<a class="headerlink" href="#additional-notes" title="Permal
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to 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">1.0.3 (2016-08-02)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">1.0.2 (2016-08-01)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">1.0.1 (2016-07-29)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">1.0.0 (2016-06-24)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">1.0.4 (2016-08-04)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">1.0.3 (2016-08-02)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">1.0.2 (2016-08-01)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">1.0.1 (2016-07-29)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id6">1.0.0 (2016-06-24)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
@@ -234,7 +235,7 @@ <h2>Additional Notes<a class="headerlink" href="#additional-notes" title="Permal
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
@@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Installation Guide &mdash; UserAle 1.0.3 documentation</title>
<title>Installation Guide &mdash; UserAle 1.0.4 documentation</title>



@@ -30,7 +30,7 @@



<link rel="top" title="UserAle 1.0.3 documentation" href="index.html"/>
<link rel="top" title="UserAle 1.0.4 documentation" href="index.html"/>
<link rel="next" title="Quickstart Guide" href="quickstart.html"/>
<link rel="prev" title="UserAle" href="index.html"/>

@@ -60,7 +60,7 @@


<div class="version">
1.0.3
1.0.4
</div>


@@ -266,7 +266,7 @@ <h2>Installing Documentation<a class="headerlink" href="#installing-documentatio
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
@@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>License &mdash; UserAle 1.0.3 documentation</title>
<title>License &mdash; UserAle 1.0.4 documentation</title>



@@ -30,7 +30,7 @@



<link rel="top" title="UserAle 1.0.3 documentation" href="index.html"/>
<link rel="top" title="UserAle 1.0.4 documentation" href="index.html"/>
<link rel="prev" title="Changelog" href="changelog.html"/>


@@ -59,7 +59,7 @@


<div class="version">
1.0.3
1.0.4
</div>


@@ -188,7 +188,7 @@ <h1>License<a class="headerlink" href="#license" title="Permalink to this headli
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
@@ -1,6 +1,6 @@
# Sphinx inventory version 2
# Project: UserAle
# Version: 1.0.3
# Version: 1.0.4
# The remainder of this file is compressed using zlib.
xڥ��n� ��}
���f��M[�٤[���E�(X�f���?�f�텉��,4(�af������}{@E�g���ߣ8*:�l�±�h"#��@�g��s�L�K�̊3 �LFI�aRL��d��p FN�a���p��I_C�Ay=��V�?�@�f�7�;�$��8gH��x��2Y���Ve� ����O%�ܵtv��[�6�w�1:�������؊.s�,{�67�ۉ=B
@@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Quickstart Guide &mdash; UserAle 1.0.3 documentation</title>
<title>Quickstart Guide &mdash; UserAle 1.0.4 documentation</title>



@@ -30,7 +30,7 @@



<link rel="top" title="UserAle 1.0.3 documentation" href="index.html"/>
<link rel="top" title="UserAle 1.0.4 documentation" href="index.html"/>
<link rel="next" title="ALE Library" href="userale.html"/>
<link rel="prev" title="Installation Guide" href="installation.html"/>

@@ -60,7 +60,7 @@


<div class="version">
1.0.3
1.0.4
</div>


@@ -172,7 +172,7 @@ <h2>Instrumenting Your Application Globally with UserAle<a class="headerlink" hr
<span class="n">app</span> <span class="o">=</span> <span class="n">QApplication</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span>
<span class="n">ex</span> <span class="o">=</span> <span class="n">TestApplication</span><span class="p">()</span>
<span class="c1"># Initiate UserAle</span>
<span class="n">ale</span> <span class="o">=</span> <span class="n">Ale</span> <span class="p">(</span><span class="n">output</span><span class="o">=</span><span class="s2">&quot;mouse.log&quot;</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="s2">&quot;testUser&quot;</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="s2">&quot;0.0.1&quot;</span><span class="p">)</span>
<span class="n">ale</span> <span class="o">=</span> <span class="n">Ale</span> <span class="p">(</span><span class="n">output</span><span class="o">=</span><span class="s2">&quot;mouse.log&quot;</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="s2">&quot;testUser&quot;</span><span class="p">,</span> <span class="n">toolversion</span><span class="o">=</span><span class="s2">&quot;0.0.1&quot;</span><span class="p">)</span>
<span class="c1"># install globally</span>
<span class="n">app</span><span class="o">.</span><span class="n">installEventFilter</span> <span class="p">(</span><span class="n">ale</span><span class="p">)</span>

@@ -182,7 +182,7 @@ <h2>Instrumenting Your Application Globally with UserAle<a class="headerlink" hr
<p>Before we enter the mainloop of the application, UserAle needs to register the application to be instrumented.
Simply instantiate UserAle and install it as an event filter in your application.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Initiate UserAle</span>
<span class="n">ale</span> <span class="o">=</span> <span class="n">Ale</span> <span class="p">(</span><span class="n">output</span><span class="o">=</span><span class="s2">&quot;mouse.log&quot;</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="s2">&quot;testUser&quot;</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="s2">&quot;0.0.1&quot;</span><span class="p">)</span>
<span class="n">ale</span> <span class="o">=</span> <span class="n">Ale</span> <span class="p">(</span><span class="n">output</span><span class="o">=</span><span class="s2">&quot;mouse.log&quot;</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="s2">&quot;testUser&quot;</span><span class="p">,</span> <span class="n">toolversion</span><span class="o">=</span><span class="s2">&quot;0.0.1&quot;</span><span class="p">)</span>
<span class="c1"># install globally</span>
<span class="n">app</span><span class="o">.</span><span class="n">installEventFilter</span> <span class="p">(</span><span class="n">ale</span><span class="p">)</span>
</pre></div>
@@ -238,7 +238,7 @@ <h2>Instrumenting Your Application Manually with UserAle<a class="headerlink" hr
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.3',
VERSION:'1.0.4',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true

0 comments on commit 7d2c001

Please sign in to comment.