Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
Fixing documentation.
  • Loading branch information
mooshu1x2 committed Jul 26, 2016
1 parent e2f6de8 commit dbd4a633b43c73d7f00eb289c9d8bcbad1a0a7b9
Showing 6 changed files with 18 additions and 37 deletions.
@@ -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 ()
ale = Ale (output="mouse.log", user="testUser", version="0.0.1")
# install globally
app.installEventFilter (ale)

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

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

This file was deleted.

This file was deleted.

@@ -1,13 +1,15 @@
API
---
.. _api:

.. toctree::

userale.api
ALE Library
===========
UserALE intercepts all application events by letting the developer install an event filter in their PyQT5 application to generate detailed user logs. UserAle does not capture system level logs or events generated by a non-user (a.k.a. system and signals sent between QObjects).

Logger
------
UserAle
-------

.. automodule:: userale.ale
:members:
:undoc-members:
:show-inheritance:

.. toctree::

userale.logger
@@ -22,11 +22,7 @@
_ = StructuredMessage

class Ale (QObject):
"""
UserALE intercepts all application events by letting the developer install an event filter in their PyQT5 application to
generate detailed user logs. UserAle does not capture system level logs or events generated by a non-user
(a.k.a. system and signals sent between QObjects).
"""

def __init__(self,
output="userale.log",
autostart=True,
@@ -51,13 +47,13 @@ def __init__(self,
.. code-block:: python
{
'target': ,
'target': 'testLineEdit',
'path': ['Example', 'testLineEdit'],
'clientTime': ,
'location': {'x': 82, 'y': 0},
'type': 'dragstart',
'type': 'mouseHover',
'userAction': 'true',
'details' : [ ],
'details' : [],
'userId': 'userABC1234',
'toolVersion': 'myApplication',
'useraleVersion': '1.0.0 alpha'
@@ -1,6 +1,3 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Copyright 2016 The Charles Stark Draper Laboratory, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");

0 comments on commit dbd4a63

Please sign in to comment.