Merge branch 'analytics'

Conflicts:
	README.md
	hackertray/__init__.py
pull/26/head
Abhay Rana 8 years ago
commit 591f6454f2
  1. 1
      .travis.yml
  2. 5
      README.md
  3. 25
      hackertray/__init__.py
  4. 23
      hackertray/analytics.py
  5. 1
      setup.py

@ -5,6 +5,7 @@ python:
install:
- pip install requests
- pip install nose
- pip install mixpanel-py
# command to run tests, e.g. python setup.py test
script: nosetests --nocapture
notifications:

@ -58,9 +58,11 @@ HackerTray accepts its various options via the command line. Run `hackertray -h`
1. `-c`: Enables comments support. Clicking on links will also open the comments page on HN. Can be switched off via the UI, but the setting is not remembered.
2. `--chrome PROFILE_PATH`: Specifying a profile path to a chrome directory will make HackerTray read the Chrome History file to mark links as read. Links are checked once every 5 minutes, which is when the History file is copied (to override the lock in case Chrome is open), searched using sqlite and deleted. This feature is still experimental.
3. `--firefox PROFILE_PATH`: Specify path to a firefox profile directory. HackerTray will read your firefox history from this profile, and use it to mark links as read.
4. `--dnt`: Disable analytics. Hackertray will no longer collect any sort of analytics. I'd prefer it if you left out this switch, as it helps me improve hackertray by understanding how its being used.
Note that the `--chrome` and `--firefox` options are independent, and can be used together. However, they cannot be specified multiple times (so reading from 2 chrome profiles is not possible).
###Google Chrome Profile Path
Where your Profile is stored depends on which version of chrome you are using:
@ -96,6 +98,9 @@ To develop on hackertray, or to test out experimental versions, do the following
- Run `(sudo) python setup.py develop` in the hackertray root directory
- Run `hackertray` with the required command line options from anywhere.
##Analytics
To help improve the project and learn how its being used, I've added Analytics in hackertray. The `--dnt` switch disables all analytics so that you can opt-out if desired. All data is collected anonymously, with no machine id or user-identifying information being sent back. To learn more, and see which events are being tracked, see the [Analytics](https://github.com/captn3m0/hackertray/wiki/Analytics) wiki page.
##Credits
- Mark Rickert for [Hacker Bar](http://hackerbarapp.com/).

@ -2,6 +2,8 @@
import os
import requests
import platform
import subprocess
if(os.environ.get('TRAVIS')!='true'):
import pygtk
@ -27,11 +29,13 @@ from hackernews import HackerNews
from chrome import Chrome
from firefox import Firefox
from version import Version
from analytics import Analytics
class HackerNewsApp:
HN_URL_PREFIX = "https://news.ycombinator.com/item?id="
UPDATE_URL = "https://github.com/captn3m0/hackertray#upgrade"
ABOUT_URL = "https://github.com/captn3m0/hackertray"
MIXPANEL_TOKEN = "51a04e37dad59393c7371407e84a8050"
def __init__(self, args):
#Load the database
home = expanduser("~")
@ -43,6 +47,9 @@ class HackerNewsApp:
except ValueError:
self.db = set()
# Setup analytics
self.tracker = Analytics(args.dnt, HackerNewsApp.MIXPANEL_TOKEN)
# create an indicator applet
self.ind = appindicator.Indicator("Hacker Tray", "hacker-tray", appindicator.CATEGORY_APPLICATION_STATUS)
self.ind.set_status(appindicator.STATUS_ACTIVE)
@ -91,6 +98,18 @@ class HackerNewsApp:
self.ind.set_menu(self.menu)
self.refresh(chrome_data_directory=args.chrome, firefox_data_directory=args.firefox)
self.launch_analytics(args)
def launch_analytics(self, args):
# Now that we're all done with the boot, send a beacone home
launch_data = vars(args)
launch_data['version'] = Version.current()
launch_data['platform'] = platform.linux_distribution()
try:
launch_data['browser'] = subprocess.check_output(["xdg-settings","get","default-web-browser"]).strip()
except subprocess.CalledProcessError as e:
launch_data['browser'] = "unknown"
self.tracker.track('launch', launch_data)
def toggleComments(self, widget):
"""Whether comments page is opened or not"""
@ -101,11 +120,13 @@ class HackerNewsApp:
webbrowser.open(HackerNewsApp.UPDATE_URL)
# Remove the update button once clicked
self.menu.remove(widget)
self.tracker.visit(HackerNewsApp.UPDATE_URL)
def showAbout(self, widget):
"""Handle the about btn"""
webbrowser.open(HackerNewsApp.ABOUT_URL)
self.tracker.visit(HackerNewsApp.ABOUT_URL)
#ToDo: Handle keyboard interrupt properly
def quit(self, widget, data=None):
@ -118,6 +139,7 @@ class HackerNewsApp:
file.write(json.dumps(l))
gtk.main_quit()
self.tracker.track('quit')
def run(self):
signal.signal(signal.SIGINT, self.quit)
@ -138,6 +160,7 @@ class HackerNewsApp:
if self.commentState:
webbrowser.open(self.HN_URL_PREFIX + widget.hn_id)
self.tracker.visit(widget.url)
def addItem(self, item):
"""Adds an item to the menu"""
@ -203,7 +226,9 @@ def main():
parser.add_argument('-c','--comments', dest='comments',action='store_true', help="Load the HN comments link for the article as well")
parser.add_argument('--chrome', dest='chrome', help="Specify a Google Chrome Profile directory to use for matching chrome history")
parser.add_argument('--firefox', dest='firefox', help="Specify a Firefox Profile directory to use for matching firefox history")
parser.add_argument('--dnt', dest='dnt',action='store_true', help="Disable all analytics (Do Not Track)")
parser.set_defaults(comments=False)
parser.set_defaults(dnt=False)
args = parser.parse_args()
indicator = HackerNewsApp(args)
indicator.run()

@ -0,0 +1,23 @@
from mixpanel import Mixpanel
class Analytics:
# Setup analytics.
# dnt - do not track. Disables tracking if True
# token - The mixpanel token
def __init__(self, dnt, token):
self.dnt = dnt
self.tracker = Mixpanel(token)
if(self.dnt == True):
print "[+] Analytics disabled"
# Track an event
# event - string containing the event name
# data - data related to the event, defaults to {}
def track(self, event, data = {}):
if(self.dnt == False):
# All events are tracked anonymously
self.tracker.track("anonymous", event, data)
# Track a visit to a URL
# The url maybe an HN submission or
# some meta-url pertaining to hackertray
def visit(self, url):
self.track('visit', {"link":url})

@ -23,6 +23,7 @@ setup(name='hackertray',
},
install_requires=[
'requests>=2.2.1',
'mixpanel-py>=3.0.0'
],
entry_points={
'console_scripts': ['hackertray = hackertray:main'],

Loading…
Cancel
Save