http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6a2b3459/_site/docs/useralepyqt/api.html ---------------------------------------------------------------------- diff --git a/_site/docs/useralepyqt/api.html b/_site/docs/useralepyqt/api.html deleted file mode 100644 index 55402af..0000000 --- a/_site/docs/useralepyqt/api.html +++ /dev/null @@ -1,592 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - - <head> - <meta charset="utf-8"> - <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <meta name="viewport" content="width=device-width, initial-scale=1"> - - <title>API Documentation</title> - <meta name="description" content="Apache UserALE.PyQt5 intercepts all application events by letting the developer install an event filter in their PyQt5 application to generate detailed user ..."> - - <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css"> - <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js";></script> - <script src="/semantic/dist/semantic.min.js"></script> - <script src="https://d3js.org/d3.v4.min.js";></script> - <script src="/js/main.js"></script> - - <link rel="stylesheet" href="/assets/main.css"> - <link rel="canonical" href="http://localhost:4000/docs/useralepyqt/api.html";> - <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml"> - - -</head> - - - <body> - - <div class="site-header"> - <div id="main-menu" class="ui inverted padded fixed top borderless menu"> - <a class="site-title" href="/"> - <h3 class="ui inverted header item">Apache SensSoft</h3> - </a> - - <div class="right menu"> - <div class="ui dropdown item"> - Components - <div class="menu"> - <a class="item" href="/system">System</a> - <a class="item" href="/userale">UserALE</a> - <a class="item" href="/distill">Distill</a> - <a class="item" href="/tap">Tap</a> - <a class="item" href="/stout">Stout</a> - </div> - </div> - <div class="ui dropdown item"> - <a href="/docs">Docs</a> - <div class="menu"> - <a class="item" href="/docs/system">System</a> - <a class="item" href="/docs/userale">UserALE</a> - <a class="item" href="/docs/useralejs">UserALE.js</a> - <a class="item" href="/docs/useralepyqt">UserALE.pyqt</a> - <a class="item" href="/docs/distill">Distill</a> - <a class="item" href="/docs/tap">Tap</a> - <a class="item" href="/docs/stout">Stout</a> - </div> - </div> - <a class="item" href="/releases">Releases</a> - <a class="item" href="/community">Community</a> - </div> - </div> -</div> - - - <div class="main-wrapper"> - <div class="docs-wrapper"> - <div class="docs-sidebar"> - - - - - - - - - -<!-- <div class="ui inverted list"> - <a class="item" href="/docs">About the Docs</a> -</div> --> -<div id="docs-nav" class="ui inverted accordion"> - - <div class="title"> - - <i class="dropdown icon"></i> - Apache SensSoft - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/">About the Docs</a> - - <a class="item" href="/docs/contributing.html">Contributing</a> - - </div> - </div> - - - - <div class="title"> - - <i class="dropdown icon"></i> - System - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/system/">Getting Started</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - UserALE - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/userale/">About UserALE</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - UserALE.js - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/useralejs/">Getting Started</a> - - <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a> - - <a class="item" href="/docs/useralejs/contributing.html">Contributing</a> - - </div> - </div> - - - <div class="active title"> - - <i class="dropdown icon"></i> - UserALE.pyqt - </div> - - <div class="active content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/useralepyqt/">Installation</a> - - <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a> - - <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a> - - <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Distill - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/distill/">Installation</a> - - <a class="item" href="/docs/distill/start.html">Getting Started</a> - - <a class="item" href="/docs/distill/api.html">API Documentation</a> - - <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a> - - <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a> - - <a class="item" href="/docs/distill/models.html">Apache Distill Models</a> - - <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a> - - <a class="item" href="/docs/distill/changelog.html">Changelog</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Tap - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/tap/">Getting Started</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Stout - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/stout/">About Stout</a> - - <a class="item" href="/docs/stout/start.html">Getting Started</a> - - </div> - </div> -</div> - - </div> - <div class="docs-content"> - <h2 class="ui header">API Documentation</h2> - <p>Apache UserALE.PyQt5 intercepts all application events by letting the developer install an event filter in their PyQt5 application to generate detailed user logs. Apache UserALE.PyQt5 does not capture system level logs or events generated by a non-user (a.k.a. system and signals sent between QObjects).</p> - -<h3 id="apache-useralepyqt5">Apache UserALE.PyQt5</h3> - -<blockquote> - - <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="k">class</span> <span class="nc">userale</span><span class="o">.</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="s">'userale.log'</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> -<span class="n">session</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">toolname</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">toolversion</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> -<span class="n">keylog</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">interval</span><span class="o">=</span><span class="mi">5000</span><span class="p">,</span> <span class="n">resolution</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">shutoff</span><span class="o">=</span><span class="p">[])</span> -</code></pre> - </div> -</blockquote> - -<blockquote> - <p><strong>Bases:</strong> PyQt5.QtCore.QObject</p> -</blockquote> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>output â [str] The file or url path to which logs will be sent</li> - <li>user â [str] Identifier for the user of the application</li> - <li>session â [str] Session tag to track same user with multiple sessions. If a session is not provided, one will be created</li> - <li>toolname â [str] The application name</li> - <li>toolversion â [str] The application version</li> - <li>keylog â [bool] Should detailed key logs be recorded. Default is False</li> - <li>interval â [int] The minimum time interval in ms between batch transmission of logs. Default is 5000ms.</li> - <li>resolution â [int] Delay in ms between instances of high frequency logs like mousemoves, scrolls, etc. Default is 100ms (10Hz).</li> - <li>shutoff â [list] Turn off logging for specific events</li> - </ul> -</blockquote> - -<p>An example log will appear like this:</p> - -<div class="language-javascript highlighter-rouge"><pre class="highlight"><code> <span class="p">{</span> - <span class="s1">'target'</span><span class="err">:</span> <span class="s1">'testLineEdit'</span><span class="p">,</span> - <span class="s1">'path'</span><span class="err">:</span> <span class="p">[</span><span class="s1">'Example'</span><span class="p">,</span> <span class="s1">'testLineEdit'</span><span class="p">],</span> - <span class="s1">'clientTime'</span><span class="err">:</span> <span class="s1">'2016-08-03 16:12:03.460573'</span><span class="p">,</span> - <span class="s1">'location'</span><span class="err">:</span> <span class="p">{</span><span class="s1">'x'</span><span class="err">:</span> <span class="mi">82</span><span class="p">,</span> <span class="s1">'y'</span><span class="err">:</span> <span class="mi">0</span><span class="p">},</span> - <span class="s1">'type'</span><span class="err">:</span> <span class="s1">'mousemove'</span><span class="p">,</span> - <span class="s1">'userAction'</span><span class="err">:</span> <span class="s1">'true'</span><span class="p">,</span> - <span class="s1">'details'</span> <span class="err">:</span> <span class="p">{},</span> - <span class="s1">'userId'</span><span class="err">:</span> <span class="s1">'userABC1234'</span><span class="p">,</span> - <span class="s1">'session'</span><span class="err">:</span> <span class="s1">'5ee42ccc-852c-44d9-a937-28d7901e4ead'</span><span class="p">,</span> - <span class="s1">'toolName'</span><span class="err">:</span> <span class="s1">'myApplication'</span><span class="p">,</span> - <span class="s1">'toolVersion'</span><span class="err">:</span> <span class="s1">'3.5.0'</span><span class="p">,</span> - <span class="s1">'useraleVersion'</span><span class="err">:</span> <span class="s1">'0.1.0'</span> - <span class="p">}</span> -</code></pre> -</div> - -<h4 id="aggregate">aggregate()</h4> -<p>Sample high frequency logs at self.resolution. High frequency logs are consolidated down to a single log event to be emitted later</p> - -<h4 id="cleanup">cleanup()</h4> -<p>Clean up any dangling logs in self.logs or self.hlogs</p> - -<h4 id="dump">dump()</h4> -<p>Write log data to file</p> - -<h4 id="eventfilterobject-event">eventFilter(object, event)</h4> -<p>Filters events for the watched widget.</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>object â [QObject] The object being watched.</li> - <li>event â [QEvent] The event triggered by a user action.</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[bool] Propagate filter up if other objects needs to be handled</li> - </ul> -</blockquote> - -<h4 id="getclienttime">getClientTime()</h4> -<p>Capture the time the event was captured in milliseconds since the UNIX epoch (January 1, 1970 00:00:00 UTC)</p> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[str] String representation of the time the event was captured.</li> - </ul> -</blockquote> - -<h4 id="getlocationevent">getLocation(event)</h4> -<p>Grab the x and y position of the mouse cursor, relative to the widget that received the event.</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>event â [QEvent] The base class for all event classes.</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[dict] A dictionary representation of the x and y positions of the mouse cursor.</li> - </ul> -</blockquote> - -<h4 id="getpathobject">getPath(object)</h4> -<p>Generate the entire object hierachy from root to leaf node.</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>object â [QObject] The base class for all Qt objects.</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[list] List of QObjects.</li> - </ul> -</blockquote> - -<h4 id="getselectorobject">getSelector(object)</h4> -<p>Get target objectâs name (object defined by user or objectâs meta class name).</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>object â [QObject] The base class for all Qt objects.</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[str] The Qt objectâs name</li> - </ul> -</blockquote> - -<h4 id="getsenderobject">getSender(object)</h4> -<p>Fetch the QObject who triggered the event</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>object â [QObject] The object being watched.</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[QObject] The QObject</li> - </ul> -</blockquote> - -<h4 id="handledrageventsevent_type-event-object">handleDragEvents(event_type, event, object)</h4> -<p>Returns the userale log representing all drag events.</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>event_type â [str] The string representation of the type of event being triggered by the user.</li> - <li>event â [QEvent] The base class for all event classes.</li> - <li>object â [QObject] The base class for all Qt objects.</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[dict] A userale log describing a drag event.</li> - </ul> -</blockquote> - -<h4 id="handlekeyeventsevent_type-event-object">handleKeyEvents(event_type, event, object)</h4> -<p>Returns the userale log representing all key events, including key name and key code.</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>event_type â [str] The string representation of the type of event being triggered by the user.</li> - <li>event â [QEvent] The base class for all event classes.</li> - <li>object â [QObject] The base class for all Qt objects.</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[dict] A userale log describing a key event.</li> - </ul> -</blockquote> - -<h4 id="handlemouseeventsevent_type-event-object">handleMouseEvents(event_type, event, object)</h4> -<p>Returns the userale log representing all mouse event data.</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>event_type â [str] The string representation of the type of event being triggered by the user.</li> - <li>event â [QEvent] The base class for all event classes.</li> - <li>object â [QObject] The base class for all Qt objects.</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[dict] A userale log describing a mouse event.</li> - </ul> -</blockquote> - -<h4 id="handlemoveeventsevent_type-event-object">handleMoveEvents(event_type, event, object)</h4> -<p>Returns the userale log representing all move events.</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>event_type â [str] The string representation of the type of event being triggered by the user.</li> - <li>event â [QEvent] The base class for all event classes.</li> - <li>object â [QObject] The base class for all Qt objects.</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[dict] A userale log describing a drag event.</li> - </ul> -</blockquote> - -<h4 id="handleresizeeventsevent_type-event-object">handleResizeEvents(event_type, event, object)</h4> -<p>Returns the userale log representing all resize events.</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>event_type â [str] The string representation of the type of event being triggered by the user.</li> - <li>event â [QEvent] The base class for all event classes.</li> - <li>object â [QObject] The base class for all Qt objects. -<strong>Returns:</strong></li> - <li>[dict] A userale log describing a resize event.</li> - </ul> -</blockquote> - -<h4 id="handlescrolleventsevent_type-event-object">handleScrollEvents(event_type, event, object)</h4> -<p>Returns the userale log representing all scroll events.</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>event_type â [str] The string representation of the type of event being triggered by the user.</li> - <li>event â [QEvent] The base class for all event classes.</li> - <li>object â [QObject] The base class for all Qt objects.</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[dict] A userale log describing a scroll event.</li> - </ul> -</blockquote> - -<h4 id="timereventevent">timerEvent(event)</h4> -<p>Routinely dump data to file or send over the network</p> - -<blockquote> - <p><strong>Parameters:</strong></p> - <ul> - <li>object â [list] List of events</li> - </ul> -</blockquote> - -<blockquote> - <p><strong>Returns:</strong></p> - <ul> - <li>[void] Emit events to file</li> - </ul> -</blockquote> - - </div> -</div> - - </div> - - <div class="footer ui inverted very padded vertical segment"> - <div class="ui vertical segment"> - <div class="ui four column grid"> - <div class="column"> - <h4 class="ui inverted header">About</h4> - <div class="ui inverted link list"> - <a class="item" href="/system">System</a> - <a class="item" href="/userale">UserALE</a> - <a class="item" href="/distill">Distill</a> - <a class="item" href="/tap">Tap</a> - <a class="item" href="/stout">Stout</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Docs</h4> - <div class="ui inverted link list"> - <a class="item" href="/docs/system">System</a> - <a class="item" href="/docs/userale">UserALE</a> - <a class="item" href="/docs/useralejs">UserAle.js</a> - <a class="item" href="/docs/useralepyqt">UserAle.pyqt</a> - <a class="item" href="/docs/distill">Distill</a> - <a class="item" href="/docs/tap">Tap</a> - <a class="item" href="/docs/stout">Stout</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Community</h4> - <div class="ui inverted link list"> - <a class="item" href="https://github.com/apache?q=senssoft";>GitHub</a> - <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a> - <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> - <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT";>Project Wiki</a> - <a class="item" href="https://twitter.com/apachesenssoft";>Twitter</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Apache</h4> - <div class="ui inverted link list"> - <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a> - <a class="item" href="http://www.apache.org/";>Apache Software Foundation</a> - <a class="item" href="http://incubator.apache.org/";>Apache Incubator</a> - <a class="item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsor Apache</a> - <a class="item" href="http://www.apache.org/foundation/thanks.html";>Thank you</a> - </div> - </div> - </div> - </div> - <div class="ui inverted vertical segment"> - <div class="ui two column middle aligned grid"> - <div class="column"> - Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. - </div> - <div class="center aligned column"> - <img class="component-image" src="/images/incubator-logo-white.png"> - <br> - Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc. - </div> - </div> - </div> -</div> - - - </body> - -</html>
http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6a2b3459/_site/docs/useralepyqt/changelog.html ---------------------------------------------------------------------- diff --git a/_site/docs/useralepyqt/changelog.html b/_site/docs/useralepyqt/changelog.html deleted file mode 100644 index 67965ce..0000000 --- a/_site/docs/useralepyqt/changelog.html +++ /dev/null @@ -1,379 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - - <head> - <meta charset="utf-8"> - <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <meta name="viewport" content="width=device-width, initial-scale=1"> - - <title>Changelog</title> - <meta name="description" content="0.1.5 (2016-09-19)"> - - <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css"> - <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js";></script> - <script src="/semantic/dist/semantic.min.js"></script> - <script src="https://d3js.org/d3.v4.min.js";></script> - <script src="/js/main.js"></script> - - <link rel="stylesheet" href="/assets/main.css"> - <link rel="canonical" href="http://localhost:4000/docs/useralepyqt/changelog.html";> - <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml"> - - -</head> - - - <body> - - <div class="site-header"> - <div id="main-menu" class="ui inverted padded fixed top borderless menu"> - <a class="site-title" href="/"> - <h3 class="ui inverted header item">Apache SensSoft</h3> - </a> - - <div class="right menu"> - <div class="ui dropdown item"> - Components - <div class="menu"> - <a class="item" href="/system">System</a> - <a class="item" href="/userale">UserALE</a> - <a class="item" href="/distill">Distill</a> - <a class="item" href="/tap">Tap</a> - <a class="item" href="/stout">Stout</a> - </div> - </div> - <div class="ui dropdown item"> - <a href="/docs">Docs</a> - <div class="menu"> - <a class="item" href="/docs/system">System</a> - <a class="item" href="/docs/userale">UserALE</a> - <a class="item" href="/docs/useralejs">UserALE.js</a> - <a class="item" href="/docs/useralepyqt">UserALE.pyqt</a> - <a class="item" href="/docs/distill">Distill</a> - <a class="item" href="/docs/tap">Tap</a> - <a class="item" href="/docs/stout">Stout</a> - </div> - </div> - <a class="item" href="/releases">Releases</a> - <a class="item" href="/community">Community</a> - </div> - </div> -</div> - - - <div class="main-wrapper"> - <div class="docs-wrapper"> - <div class="docs-sidebar"> - - - - - - - - - -<!-- <div class="ui inverted list"> - <a class="item" href="/docs">About the Docs</a> -</div> --> -<div id="docs-nav" class="ui inverted accordion"> - - <div class="title"> - - <i class="dropdown icon"></i> - Apache SensSoft - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/">About the Docs</a> - - <a class="item" href="/docs/contributing.html">Contributing</a> - - </div> - </div> - - - - <div class="title"> - - <i class="dropdown icon"></i> - System - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/system/">Getting Started</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - UserALE - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/userale/">About UserALE</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - UserALE.js - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/useralejs/">Getting Started</a> - - <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a> - - <a class="item" href="/docs/useralejs/contributing.html">Contributing</a> - - </div> - </div> - - - <div class="active title"> - - <i class="dropdown icon"></i> - UserALE.pyqt - </div> - - <div class="active content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/useralepyqt/">Installation</a> - - <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a> - - <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a> - - <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Distill - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/distill/">Installation</a> - - <a class="item" href="/docs/distill/start.html">Getting Started</a> - - <a class="item" href="/docs/distill/api.html">API Documentation</a> - - <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a> - - <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a> - - <a class="item" href="/docs/distill/models.html">Apache Distill Models</a> - - <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a> - - <a class="item" href="/docs/distill/changelog.html">Changelog</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Tap - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/tap/">Getting Started</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Stout - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/stout/">About Stout</a> - - <a class="item" href="/docs/stout/start.html">Getting Started</a> - - </div> - </div> -</div> - - </div> - <div class="docs-content"> - <h2 class="ui header">Changelog</h2> - <h3 id="015-2016-09-19">0.1.5 (2016-09-19)</h3> - -<ul> - <li>clientTime field is represented in ISO 8601 format.</li> - <li>Sampling mouseenter, mouseleave, and dragmove events by resolution parameter.</li> - <li>Batch dumping all logs to file by interval parameter.</li> - <li>Added Apache license headers.</li> - <li>Updated all documentation.</li> - <li>Updated versioning numbers.</li> - <li>Added docker support.</li> -</ul> - -<h3 id="014-2016-08-04">0.1.4 (2016-08-04)</h3> - -<ul> - <li>New events Apache UserAle is tracking: - <ul> - <li>move</li> - <li>resize</li> - <li>scroll</li> - </ul> - </li> - <li>Remove timer from dragdrop log due to incorrect time being recorded.</li> - <li>Session id is autogenerated if not passed into configuration.</li> -</ul> - -<h3 id="013-2016-08-02">0.1.3 (2016-08-02)</h3> - -<ul> - <li>New events Apache UserAle is tracking: - <ul> - <li>mouseenter</li> - <li>mouseleave</li> - </ul> - </li> -</ul> - -<h3 id="012-2016-08-01">0.1.2 (2016-08-01)</h3> - -<ul> - <li>The elapsed time for a drag event is being recorded in the dragdrop log.</li> -</ul> - -<h3 id="011-2016-07-29">0.1.1 (2016-07-29)</h3> - -<ul> - <li>All logs will be stored to file called userale.log (configurable).</li> - <li>Users can specify which events to capture by passing in a list of event keys when instantiating Apache UserAle.</li> - <li>These are the events Apache UserAle is tracking: - <ul> - <li>mouseup</li> - <li>mousedown</li> - <li>mousemove</li> - <li>keypress (optional)</li> - <li>keydown (optional)</li> - <li>dragenter</li> - <li>dragleave</li> - <li>dragmove</li> - <li>dragdrop</li> - </ul> - </li> -</ul> - -<h3 id="010-2016-06-24">0.1.0 (2016-06-24)</h3> - -<ul> - <li>Initial release.</li> -</ul> - - </div> -</div> - - </div> - - <div class="footer ui inverted very padded vertical segment"> - <div class="ui vertical segment"> - <div class="ui four column grid"> - <div class="column"> - <h4 class="ui inverted header">About</h4> - <div class="ui inverted link list"> - <a class="item" href="/system">System</a> - <a class="item" href="/userale">UserALE</a> - <a class="item" href="/distill">Distill</a> - <a class="item" href="/tap">Tap</a> - <a class="item" href="/stout">Stout</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Docs</h4> - <div class="ui inverted link list"> - <a class="item" href="/docs/system">System</a> - <a class="item" href="/docs/userale">UserALE</a> - <a class="item" href="/docs/useralejs">UserAle.js</a> - <a class="item" href="/docs/useralepyqt">UserAle.pyqt</a> - <a class="item" href="/docs/distill">Distill</a> - <a class="item" href="/docs/tap">Tap</a> - <a class="item" href="/docs/stout">Stout</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Community</h4> - <div class="ui inverted link list"> - <a class="item" href="https://github.com/apache?q=senssoft";>GitHub</a> - <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a> - <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> - <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT";>Project Wiki</a> - <a class="item" href="https://twitter.com/apachesenssoft";>Twitter</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Apache</h4> - <div class="ui inverted link list"> - <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a> - <a class="item" href="http://www.apache.org/";>Apache Software Foundation</a> - <a class="item" href="http://incubator.apache.org/";>Apache Incubator</a> - <a class="item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsor Apache</a> - <a class="item" href="http://www.apache.org/foundation/thanks.html";>Thank you</a> - </div> - </div> - </div> - </div> - <div class="ui inverted vertical segment"> - <div class="ui two column middle aligned grid"> - <div class="column"> - Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. - </div> - <div class="center aligned column"> - <img class="component-image" src="/images/incubator-logo-white.png"> - <br> - Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc. - </div> - </div> - </div> -</div> - - - </body> - -</html> http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6a2b3459/_site/docs/useralepyqt/index.html ---------------------------------------------------------------------- diff --git a/_site/docs/useralepyqt/index.html b/_site/docs/useralepyqt/index.html deleted file mode 100644 index 2fcc333..0000000 --- a/_site/docs/useralepyqt/index.html +++ /dev/null @@ -1,423 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - - <head> - <meta charset="utf-8"> - <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <meta name="viewport" content="width=device-width, initial-scale=1"> - - <title>Installation</title> - <meta name="description" content="Apache UserALE.PyQt5 is the UserALE client for PyQt5 applications. It provides an easy way to generate highly detailed log streams from any PyQt5 application."> - - <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css"> - <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js";></script> - <script src="/semantic/dist/semantic.min.js"></script> - <script src="https://d3js.org/d3.v4.min.js";></script> - <script src="/js/main.js"></script> - - <link rel="stylesheet" href="/assets/main.css"> - <link rel="canonical" href="http://localhost:4000/docs/useralepyqt/";> - <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml"> - - -</head> - - - <body> - - <div class="site-header"> - <div id="main-menu" class="ui inverted padded fixed top borderless menu"> - <a class="site-title" href="/"> - <h3 class="ui inverted header item">Apache SensSoft</h3> - </a> - - <div class="right menu"> - <div class="ui dropdown item"> - Components - <div class="menu"> - <a class="item" href="/system">System</a> - <a class="item" href="/userale">UserALE</a> - <a class="item" href="/distill">Distill</a> - <a class="item" href="/tap">Tap</a> - <a class="item" href="/stout">Stout</a> - </div> - </div> - <div class="ui dropdown item"> - <a href="/docs">Docs</a> - <div class="menu"> - <a class="item" href="/docs/system">System</a> - <a class="item" href="/docs/userale">UserALE</a> - <a class="item" href="/docs/useralejs">UserALE.js</a> - <a class="item" href="/docs/useralepyqt">UserALE.pyqt</a> - <a class="item" href="/docs/distill">Distill</a> - <a class="item" href="/docs/tap">Tap</a> - <a class="item" href="/docs/stout">Stout</a> - </div> - </div> - <a class="item" href="/releases">Releases</a> - <a class="item" href="/community">Community</a> - </div> - </div> -</div> - - - <div class="main-wrapper"> - <div class="docs-wrapper"> - <div class="docs-sidebar"> - - - - - - - - - -<!-- <div class="ui inverted list"> - <a class="item" href="/docs">About the Docs</a> -</div> --> -<div id="docs-nav" class="ui inverted accordion"> - - <div class="title"> - - <i class="dropdown icon"></i> - Apache SensSoft - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/">About the Docs</a> - - <a class="item" href="/docs/contributing.html">Contributing</a> - - </div> - </div> - - - - <div class="title"> - - <i class="dropdown icon"></i> - System - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/system/">Getting Started</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - UserALE - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/userale/">About UserALE</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - UserALE.js - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/useralejs/">Getting Started</a> - - <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a> - - <a class="item" href="/docs/useralejs/contributing.html">Contributing</a> - - </div> - </div> - - - <div class="active title"> - - <i class="dropdown icon"></i> - UserALE.pyqt - </div> - - <div class="active content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/useralepyqt/">Installation</a> - - <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a> - - <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a> - - <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Distill - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/distill/">Installation</a> - - <a class="item" href="/docs/distill/start.html">Getting Started</a> - - <a class="item" href="/docs/distill/api.html">API Documentation</a> - - <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a> - - <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a> - - <a class="item" href="/docs/distill/models.html">Apache Distill Models</a> - - <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a> - - <a class="item" href="/docs/distill/changelog.html">Changelog</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Tap - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/tap/">Getting Started</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Stout - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/stout/">About Stout</a> - - <a class="item" href="/docs/stout/start.html">Getting Started</a> - - </div> - </div> -</div> - - </div> - <div class="docs-content"> - <h2 class="ui header">Installation</h2> - <p>Apache UserALE.PyQt5 is the UserALE client for PyQt5 applications. It provides an easy way to generate highly detailed log streams from any PyQt5 application.</p> - -<h3 id="requirements">Requirements</h3> - -<ul> - <li>Python 3.5 or above</li> - <li>PyQt5, version 5.3 or above</li> - <li>pip3, see requirements.txt</li> -</ul> - -<h3 id="installing-useralepyqt5">Installing UserALE.PyQt5</h3> - -<p>The first step is to install Apache UserALE.PyQt5. First, checkout the latest version of Apache UserALE.PyQt5 from our Git repository.</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://git-wip-us.apache.org/repos/asf/incubator-senssoft-userale-pyqt5.git -</code></pre> -</div> - -<p>Apache UserALE.PyQt5 is a python3 project, so it can be installed like any other python library. Several operating systems (Mac OS X, Major Versions of Linux/BSD) have Python3 pre-installed, so you should just have to run</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>easy_install3 userale -</code></pre> -</div> - -<div class="highlighter-rouge"><pre class="highlight"><code> or -</code></pre> -</div> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>pip3 install userale -</code></pre> -</div> - -<p>Users are strongly recommended to install Apache UserALE.PyQt5 in a virtualenv. Instructions to setup an virtual environment will be explained below.</p> - -<blockquote> - <p><strong>Note</strong> -Apache UserALE.PyQt5 requires that PyQt5 and the Qt5 bindings has been installed. Instructions to install PyQt5 and Qt5 in a virtual environment will be left to the user.</p> -</blockquote> - -<blockquote> - <p><strong>Note</strong> -When the package is installed via easy_install3 or pip3 this function will be bound to the userale executable in the Python installationâs bin directory (on Windows - the Scripts directory).</p> -</blockquote> - -<h3 id="installing-apache-useralepyqt5-in-an-virtual-environment">Installing Apache UserALE.PyQt5 in an Virtual Environment</h3> - -<p>There are multiple ways to create virtual environments for a Python3 application. virtualenv is a one of those tools to create isolated Python environments. virtualenv creates a folder which contains all the necessary executables to use the packages that the UserAle project would need.</p> - -<p>Start by changing directory into the root of Apache UserALE.PyQt5âs project directory, and then use the virtualenv command-line tool to create a new environment:</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>virtualenv --python<span class="o">=</span>/usr/bin/python3 env -</code></pre> -</div> - -<p>Optionally, Python3 has built in support for virtual environments.</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>mkdir env - <span class="nv">$ </span>python3 -m venv env -</code></pre> -</div> - -<p>Activate environment:</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span><span class="nb">source </span>env/bin/activate -</code></pre> -</div> - -<p>Install UserAle requirements:</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip3 install -r requirements.txt -</code></pre> -</div> - -<p>To build the source code and run all unit tests.</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/python3 setup.py develop <span class="nb">test</span> -</code></pre> -</div> - -<p>Deactivate environment</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>deactivate -</code></pre> -</div> - -<h3 id="installing-documentation">Installing Documentation</h3> - -<p>First, install the documentation dependencies:</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip3 install -r doc_requirements.txt -</code></pre> -</div> - -<p>To build Apache UserALE.PyQt5âs documentation, create a directory at the root level of /userale.pyqt5 called userale.pyqt5-docs.</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>mkdir userale.pyqt5-docs & <span class="nb">cd </span>userale.pyqt5-docs -</code></pre> -</div> - -<p>Execute build command from inside the top-level doc/ directory:</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>make html -</code></pre> -</div> - -<p>This should build the documentation in your shell, and output HTML. At then end, it should say something about documents being ready in userale.pyqt5-docs/html.</p> - -<p>You can now open them in your browser by typing</p> - -<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>open userale.pyqt5-docs/html/index.html -</code></pre> -</div> - - </div> -</div> - - </div> - - <div class="footer ui inverted very padded vertical segment"> - <div class="ui vertical segment"> - <div class="ui four column grid"> - <div class="column"> - <h4 class="ui inverted header">About</h4> - <div class="ui inverted link list"> - <a class="item" href="/system">System</a> - <a class="item" href="/userale">UserALE</a> - <a class="item" href="/distill">Distill</a> - <a class="item" href="/tap">Tap</a> - <a class="item" href="/stout">Stout</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Docs</h4> - <div class="ui inverted link list"> - <a class="item" href="/docs/system">System</a> - <a class="item" href="/docs/userale">UserALE</a> - <a class="item" href="/docs/useralejs">UserAle.js</a> - <a class="item" href="/docs/useralepyqt">UserAle.pyqt</a> - <a class="item" href="/docs/distill">Distill</a> - <a class="item" href="/docs/tap">Tap</a> - <a class="item" href="/docs/stout">Stout</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Community</h4> - <div class="ui inverted link list"> - <a class="item" href="https://github.com/apache?q=senssoft";>GitHub</a> - <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a> - <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> - <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT";>Project Wiki</a> - <a class="item" href="https://twitter.com/apachesenssoft";>Twitter</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Apache</h4> - <div class="ui inverted link list"> - <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a> - <a class="item" href="http://www.apache.org/";>Apache Software Foundation</a> - <a class="item" href="http://incubator.apache.org/";>Apache Incubator</a> - <a class="item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsor Apache</a> - <a class="item" href="http://www.apache.org/foundation/thanks.html";>Thank you</a> - </div> - </div> - </div> - </div> - <div class="ui inverted vertical segment"> - <div class="ui two column middle aligned grid"> - <div class="column"> - Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. - </div> - <div class="center aligned column"> - <img class="component-image" src="/images/incubator-logo-white.png"> - <br> - Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc. - </div> - </div> - </div> -</div> - - - </body> - -</html> http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6a2b3459/_site/docs/useralepyqt/start.html ---------------------------------------------------------------------- diff --git a/_site/docs/useralepyqt/start.html b/_site/docs/useralepyqt/start.html deleted file mode 100644 index 4c6dd52..0000000 --- a/_site/docs/useralepyqt/start.html +++ /dev/null @@ -1,364 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - - <head> - <meta charset="utf-8"> - <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <meta name="viewport" content="width=device-width, initial-scale=1"> - - <title>Getting Started</title> - <meta name="description" content="Instrumenting Your Application Globally with Apache UserALE.PyQt5"> - - <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css"> - <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js";></script> - <script src="/semantic/dist/semantic.min.js"></script> - <script src="https://d3js.org/d3.v4.min.js";></script> - <script src="/js/main.js"></script> - - <link rel="stylesheet" href="/assets/main.css"> - <link rel="canonical" href="http://localhost:4000/docs/useralepyqt/start.html";> - <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml"> - - -</head> - - - <body> - - <div class="site-header"> - <div id="main-menu" class="ui inverted padded fixed top borderless menu"> - <a class="site-title" href="/"> - <h3 class="ui inverted header item">Apache SensSoft</h3> - </a> - - <div class="right menu"> - <div class="ui dropdown item"> - Components - <div class="menu"> - <a class="item" href="/system">System</a> - <a class="item" href="/userale">UserALE</a> - <a class="item" href="/distill">Distill</a> - <a class="item" href="/tap">Tap</a> - <a class="item" href="/stout">Stout</a> - </div> - </div> - <div class="ui dropdown item"> - <a href="/docs">Docs</a> - <div class="menu"> - <a class="item" href="/docs/system">System</a> - <a class="item" href="/docs/userale">UserALE</a> - <a class="item" href="/docs/useralejs">UserALE.js</a> - <a class="item" href="/docs/useralepyqt">UserALE.pyqt</a> - <a class="item" href="/docs/distill">Distill</a> - <a class="item" href="/docs/tap">Tap</a> - <a class="item" href="/docs/stout">Stout</a> - </div> - </div> - <a class="item" href="/releases">Releases</a> - <a class="item" href="/community">Community</a> - </div> - </div> -</div> - - - <div class="main-wrapper"> - <div class="docs-wrapper"> - <div class="docs-sidebar"> - - - - - - - - - -<!-- <div class="ui inverted list"> - <a class="item" href="/docs">About the Docs</a> -</div> --> -<div id="docs-nav" class="ui inverted accordion"> - - <div class="title"> - - <i class="dropdown icon"></i> - Apache SensSoft - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/">About the Docs</a> - - <a class="item" href="/docs/contributing.html">Contributing</a> - - </div> - </div> - - - - <div class="title"> - - <i class="dropdown icon"></i> - System - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/system/">Getting Started</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - UserALE - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/userale/">About UserALE</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - UserALE.js - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/useralejs/">Getting Started</a> - - <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a> - - <a class="item" href="/docs/useralejs/contributing.html">Contributing</a> - - </div> - </div> - - - <div class="active title"> - - <i class="dropdown icon"></i> - UserALE.pyqt - </div> - - <div class="active content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/useralepyqt/">Installation</a> - - <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a> - - <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a> - - <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Distill - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/distill/">Installation</a> - - <a class="item" href="/docs/distill/start.html">Getting Started</a> - - <a class="item" href="/docs/distill/api.html">API Documentation</a> - - <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a> - - <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a> - - <a class="item" href="/docs/distill/models.html">Apache Distill Models</a> - - <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a> - - <a class="item" href="/docs/distill/changelog.html">Changelog</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Tap - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/tap/">Getting Started</a> - - </div> - </div> - - - <div class="title"> - - <i class="dropdown icon"></i> - Stout - </div> - - <div class="content"> - - <div class="ui inverted bulleted list docs-list"> - - <a class="item" href="/docs/stout/">About Stout</a> - - <a class="item" href="/docs/stout/start.html">Getting Started</a> - - </div> - </div> -</div> - - </div> - <div class="docs-content"> - <h2 class="ui header">Getting Started</h2> - <h3 id="instrumenting-your-application-globally-with-apache-useralepyqt5">Instrumenting Your Application Globally with Apache UserALE.PyQt5</h3> - -<p>Itâs very simple to instrument a PyQt5 application with Apache UserALE.PyQt5. Simply import the Apache UserALE.PyQt5 library and register it with your application.</p> - -<p>Below is an example PyQt5 application taken from ZetCode PyQt5 tutorial instrumented with Apache UserALE.PyQt5.</p> - -<div class="language-python highlighter-rouge"><pre class="highlight"><code> <span class="kn">import</span> <span class="nn">sys</span> - <span class="kn">from</span> <span class="nn">PyQt5.QtWidgets</span> <span class="kn">import</span> <span class="n">QWidget</span><span class="p">,</span> <span class="n">QLabel</span><span class="p">,</span> <span class="n">QPushButton</span><span class="p">,</span> <span class="n">QApplication</span><span class="p">,</span> <span class="n">QMessageBox</span> - <span class="kn">from</span> <span class="nn">PyQt5.QtCore</span> <span class="kn">import</span> <span class="n">QCoreApplication</span><span class="p">,</span> <span class="n">QObject</span><span class="p">,</span> <span class="n">QEvent</span> - - <span class="kn">from</span> <span class="nn">userale.ale</span> <span class="kn">import</span> <span class="n">Ale</span> - - <span class="k">class</span> <span class="nc">TestApplication</span> <span class="p">(</span><span class="n">QWidget</span><span class="p">):</span> - - <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> - <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span> - <span class="bp">self</span><span class="o">.</span><span class="n">initUI</span><span class="p">()</span> - - <span class="k">def</span> <span class="nf">initUI</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> - <span class="n">qbtn</span> <span class="o">=</span> <span class="n">QPushButton</span><span class="p">(</span><span class="s">'Quit'</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span> - <span class="n">qbtn</span><span class="o">.</span><span class="n">setObjectName</span> <span class="p">(</span><span class="s">"testApplicationButton"</span><span class="p">)</span> - <span class="n">qbtn</span><span class="o">.</span><span class="n">clicked</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">QCoreApplication</span><span class="o">.</span><span class="n">instance</span><span class="p">()</span><span class="o">.</span><span class="n">quit</span><span class="p">)</span> - <span class="n">qbtn</span><span class="o">.</span><span class="n">resize</span><span class="p">(</span><span class="n">qbtn</span><span class="o">.</span><span class="n">sizeHint</span><span class="p">())</span> - <span class="n">qbtn</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="mi">50</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span> - - <span class="bp">self</span><span class="o">.</span><span class="n">setGeometry</span><span class="p">(</span><span class="mi">300</span><span class="p">,</span> <span class="mi">300</span><span class="p">,</span> <span class="mi">250</span><span class="p">,</span> <span class="mi">150</span><span class="p">)</span> - <span class="bp">self</span><span class="o">.</span><span class="n">setWindowTitle</span><span class="p">(</span><span class="s">'Quit button'</span><span class="p">)</span> - <span class="bp">self</span><span class="o">.</span><span class="n">show</span><span class="p">()</span> - - <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">'__main__'</span><span class="p">:</span> - <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="c"># Initiate Apache UserALE.PyQt5</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="s">"mouse.log"</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="s">"testUser"</span><span class="p">,</span> <span class="n">toolversion</span><span class="o">=</span><span class="s">"0.0.1"</span><span class="p">)</span> - <span class="c"># 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> - - <span class="n">sys</span><span class="o">.</span><span class="nb">exit</span> <span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">exec_</span><span class="p">())</span> -</code></pre> -</div> - -<p>Before we enter the mainloop of the application, UserAle needs to register the application to be instrumented. Simply instantiate Apache UserALE.PyQt5 and install it as an event filter in your application.</p> - -<div class="language-python highlighter-rouge"><pre class="highlight"><code> <span class="c"># 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="s">"mouse.log"</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="s">"testUser"</span><span class="p">,</span> <span class="n">toolversion</span><span class="o">=</span><span class="s">"0.0.1"</span><span class="p">)</span> - <span class="c"># 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> -</code></pre> -</div> - -<h3 id="instrumenting-your-application-manually-with-apache-useralepyqt5">Instrumenting Your Application Manually with Apache UserALE.PyQt5</h3> - -<p><em>Todo:</em> Write guidelines for instrumenting specific PyQt5 Widgets with Apache UserALE.PyQt5.</p> - - </div> -</div> - - </div> - - <div class="footer ui inverted very padded vertical segment"> - <div class="ui vertical segment"> - <div class="ui four column grid"> - <div class="column"> - <h4 class="ui inverted header">About</h4> - <div class="ui inverted link list"> - <a class="item" href="/system">System</a> - <a class="item" href="/userale">UserALE</a> - <a class="item" href="/distill">Distill</a> - <a class="item" href="/tap">Tap</a> - <a class="item" href="/stout">Stout</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Docs</h4> - <div class="ui inverted link list"> - <a class="item" href="/docs/system">System</a> - <a class="item" href="/docs/userale">UserALE</a> - <a class="item" href="/docs/useralejs">UserAle.js</a> - <a class="item" href="/docs/useralepyqt">UserAle.pyqt</a> - <a class="item" href="/docs/distill">Distill</a> - <a class="item" href="/docs/tap">Tap</a> - <a class="item" href="/docs/stout">Stout</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Community</h4> - <div class="ui inverted link list"> - <a class="item" href="https://github.com/apache?q=senssoft";>GitHub</a> - <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft";>StackOverflow</a> - <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT";>Jira Issue Tracker</a> - <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT";>Project Wiki</a> - <a class="item" href="https://twitter.com/apachesenssoft";>Twitter</a> - </div> - </div> - <div class="column"> - <h4 class="ui inverted header">Apache</h4> - <div class="ui inverted link list"> - <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html";>License</a> - <a class="item" href="http://www.apache.org/";>Apache Software Foundation</a> - <a class="item" href="http://incubator.apache.org/";>Apache Incubator</a> - <a class="item" href="http://www.apache.org/foundation/sponsorship.html";>Sponsor Apache</a> - <a class="item" href="http://www.apache.org/foundation/thanks.html";>Thank you</a> - </div> - </div> - </div> - </div> - <div class="ui inverted vertical segment"> - <div class="ui two column middle aligned grid"> - <div class="column"> - Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. - </div> - <div class="center aligned column"> - <img class="component-image" src="/images/incubator-logo-white.png"> - <br> - Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc. - </div> - </div> - </div> -</div> - - - </body> - -</html> http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6a2b3459/_site/feed.xml ---------------------------------------------------------------------- diff --git a/_site/feed.xml b/_site/feed.xml deleted file mode 100644 index 26421ae..0000000 --- a/_site/feed.xml +++ /dev/null @@ -1 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="http://localhost:4000/feed.xslt.xml";?><feed xmlns="http://www.w3.org/2005/Atom";><generator uri="http://jekyllrb.com"; version="3.3.1">Jekyll</generator><link href="http://localhost:4000/feed.xml"; rel="self" type="application/atom+xml" /><link href="http://localhost:4000/"; rel="alternate" type="text/html" /><updated>2017-01-25T18:49:49-05:00</updated><id>http://localhost:4000//</id><title type="html">Apache SensSoft</title><subtitle>The homepage for Apache SensSoft</subtitle></feed> http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6a2b3459/_site/feed.xslt.xml ---------------------------------------------------------------------- diff --git a/_site/feed.xslt.xml b/_site/feed.xslt.xml deleted file mode 100644 index 15901c1..0000000 --- a/_site/feed.xslt.xml +++ /dev/null @@ -1,4 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?><xsl:transform version="1.0" - xmlns:a="http://www.w3.org/2005/Atom"; - xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; -><xsl:strip-space elements="*"/><xsl:output method="text"/><xsl:template match="*"/><xsl:template match="a:feed"><xsl:text>Atom Feed:</xsl:text><xsl:value-of select="a:id"/><xsl:text> </xsl:text><xsl:apply-templates/></xsl:template><xsl:template match="a:entry"><xsl:text> ---------------------------------------- </xsl:text><xsl:text> Feed entry:</xsl:text><xsl:value-of select="a:id"/><xsl:text> </xsl:text><xsl:apply-templates/></xsl:template><xsl:template match="a:title"><xsl:if test="parent::a:entry"><xsl:value-of select="' '"/></xsl:if><xsl:value-of select="local-name()"/>:<xsl:apply-templates/><xsl:text> </xsl:text></xsl:template><xsl:template match="a:published|a:updated"><xsl:if test="parent::a:entry"><xsl:value-of select="' '"/></xsl:if><xsl:value-of select="local-name()"/>:<xsl:apply-templates/><xsl:text> </xsl:text></xsl:template></xsl:transform> http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6a2b3459/_site/images/distill.png ---------------------------------------------------------------------- diff --git a/_site/images/distill.png b/_site/images/distill.png deleted file mode 100644 index 0d215aa..0000000 Binary files a/_site/images/distill.png and /dev/null differ http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/6a2b3459/_site/images/distill_inverted.png ---------------------------------------------------------------------- diff --git a/_site/images/distill_inverted.png b/_site/images/distill_inverted.png deleted file mode 100644 index afaa8c9..0000000 Binary files a/_site/images/distill_inverted.png and /dev/null differ
