Skip to content

Commit

Permalink
Removed setup.cfg and changed README to use reStructuredText for Pypi…
Browse files Browse the repository at this point in the history
… mardown compatibility.
  • Loading branch information
bhamodi committed Jul 7, 2015
1 parent 8a0cc34 commit fb77422
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 23 deletions.
18 changes: 0 additions & 18 deletions README.md

This file was deleted.

36 changes: 36 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
facebook-online-friend-tracker
==============================

Track the number of online friends you have on Facebook at any given
time!

Prerequisites
-------------

To be able to use this tool, you will need to point have a Facebook
account, an Excel sheet (``.xlsx``), and a server (or computer) that can
run a cron job / scheduled task.

Dependencies
------------

This tool uses `Selenium`_ to scrape the data and `Openpyxl`_ to store
the data in an Excel sheet.

How to Setup
------------

1. Install from `pip`_ by running:
``pip install facebook-online-friend-tracker``
2. Setup a `cron job`_ to run the tool at a certain frequency. (I used
15 minute intervals).
3. The command to run the tool is:
``facebook-online-friend-tracker --user 'example@example.com' --pass 'your_password' --path 'path/to/spreadsheet.xlsx'``
4. After a certain amount of time, you will be able to analyze the trend
in the Excel sheet you specified. (I waited 2 full weeks before
analyzing the data and finding the best time to post on Facebook.)

.. _Selenium: https://pypi.python.org/pypi/selenium
.. _Openpyxl: https://pypi.python.org/pypi/openpyxl
.. _pip: https://pypi.python.org/pypi/facebook-online-friend-tracker
.. _cron job: http://askubuntu.com/questions/2368/how-do-i-set-up-a-cron-job
2 changes: 0 additions & 2 deletions setup.cfg

This file was deleted.

7 changes: 4 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

setup(
name='facebook-online-friend-tracker',
version='1.0.5',
description='This tool tracks the number of online friends a user has on Facebook at a given time.',
version='1.0.6',
description='This tool tracks the number of online friends a user has on Facebook at any given time.',
long_description=open('README.rst').read(),
url='https://github.com/bhamodi/facebook-online-friend-tracker',
author='Baraa Hamodi',
author_email='bhamodi@uwaterloo.ca',
Expand All @@ -21,7 +22,7 @@
'Topic :: Software Development',
'Topic :: Utilities',
],
keywords='facebook tracker python scraper selenium',
keywords='facebook online friend tracker python scraper selenium analysis optimization',
packages=find_packages(),
install_requires=[
'selenium>=2.46.0',
Expand Down

0 comments on commit fb77422

Please sign in to comment.