{ "info": { "author": "Dean Malmgren", "author_email": "dean.malmgren@datascopeanalytics.com", "bugtrack_url": null, "classifiers": [], "description": "Here's the situation. You're on a website and you think to yourself,\n\"whoa, this site is gnarly! I'd really like to stay up to date with\nthis.\" You hesitate. Will you be inundated with irrelevant content on\nTwitter, etc.?\n\nAlthough this information is readily available and often a click or\ntwo away, these additional clicks create an unnecessary barrier to\nentry. The goal of ``flux`` is to make it possible to quickly\nassess the utility of following a particular feed of content and\nwhether the `flux `_ of relevant\ncontent will be useful for you. Currently, ``flux`` supports:\n\n* Twitter via `python-twitter `_\n* RSS via `feedparser `_\n* Facebook via `fbconsole `_\n* LinkedIn via `oauth2 `_\n\nQuick start\n===========\n\n#. Install ``flux`` with `pip `_::\n\n [shell]$ pip install django-flux\n\n#. Add ``flux`` to the `INSTALLED_APPS\n `_\n in `settings.py` of your django project::\n\n INSTALLED_APPS += ('flux', )\n\n#. Run ``syncdb`` to create the necessary tables::\n\n [shell]$ python manage.py syncdb\n\n#. Make sure the `admin is enabled\n `_\n on your site and add accounts to monitor by visiting the admin page\n of your site (e.g., http://localhost:8000/admin/flux/account/add)\n\n#. Run the ``update_flux`` management command::\n\n [shell]$ python manage.py update_flux\n\n#. Use the ``flux_timeseries`` template tag on ``Account`` instances\n (``account`` below) in your templates::\n\n \n\n {% load flux %}\n {% flux_timeseries account %}\n\n and you should see something like this:\n\n .. image:: https://github.com/datascopeanalytics/django-flux/raw/master/docs/basic_view.png\n :alt: default flux timeseries view\n :align: center\n\n#. Customize the styling and layout by altering the CSS, and content\n accordingly or by taking advantage of any of the other ways of\n displaying the flux information:\n\nLabels on mouseover with bars\n-----------------------------\n\nOptionally include labels for the bars with `d3.js `_\nby including the following in your templates::\n\n \n \n\n {% load flux %}\n {% flux_timeseries account %}\n\n \n \n \n\nand you should see something like this:\n\n.. image:: https://github.com/datascopeanalytics/django-flux/raw/master/docs/bar_labelled.png\n :alt: labelled bars in the timeseries view\n :align: center\n\nSparklines\n----------\n\nOptionally include `sparklines\n`_ with `d3.js\n`_ by including the following in your templates::\n \n \n \n\n {% load flux %}\n {% flux_timeseries account %}\n\n \n \n \n\nand you should see something like this:\n\n.. image:: https://github.com/datascopeanalytics/django-flux/raw/master/docs/sparkline.png\n :alt: sparkline view\n :align: center\n\nLabels on mouseover of sparkline\n--------------------------------\n\nOptionally include labels for each `sparkline\n`_ with `d3.js\n`_ by including the following in your templates::\n \n \n \n\n {% load flux %}\n {% flux_timeseries account %}\n\n \n \n \n \n\nand you should see something like this:\n\n.. image:: https://github.com/datascopeanalytics/django-flux/raw/master/docs/sparkline_labelled.png\n :alt: labelled sparkline in the timeseries view\n :align: center\n\n\nProduction usage\n================\n\nTo have the Accounts monitored be continuously updated, add the\nfollowing line to your `crontab `_\non your production server::\n\n 0 0 * * * python /path/to/manage.py update_flux\n\nAccount configuration\n=====================\n\nAccount.type=\"twitter\"\n----------------------\n\nAccount.name is the Twitter username (*e.g.*, for\nhttp://twitter.com/DsAtweet, Account.name=\"DsAtweet\").\n\nNo additional information is needed to access Twitter Accounts and\nAccount.other is ignored.\n\nAccount.type=\"rss\"\n------------------\n\nAccount.name is the full URL of the RSS feed you want to\ntrack (*e.g.*, for http://datascopeanalytics.com/rss/,\nAccount.name=\"http://datascopeanalytics.com/rss/\").\n\nNo additional information is needed to access Twitter Accounts and\nAccount.other is ignored.\n\nAccount.type=\"facebook\"\n-----------------------\n\nAccount.name is the name of the Facebook page that you want to track\n(*e.g.*, for http://facebook.com/datascopeanalytics,\nAccount.name=\"datascopeanalytics\")\n\nThe Account.other JSON must also include several attributes in order\nto authenticate to the `Facebook API\n`_ using `fbconsole\n`_ with something like::\n\n {\n \"app_id\":\"123456789012345\", // [0-9]+\n \"client_secret\": \"1234567890abcdef1234567890abcdef\", // [0-9a-f]+\n \"scope\": [\"read_stream\"], \n \"email\":\"facebook.email@here.com\", \n \"password\": \"this.is.your.facebook.password\"\n }\n\nAccount.type=\"linkedin\"\n-----------------------\n\nAccount.name is the name of the LinkedIn company page that you want to\ntrack (*e.g.*, for http://linkedin.com/company/datascope-analytics-llc,\nAccount.name=\"datascope-analytics-llc\")\n\nThe Account.other JSON must also include several attributes in order\nto authenticate to the `LinkedIn API\n`_ with\nsomething like::\n\n {\n \"api_key\": \"1234567890ab\", // [0-9a-f]+\n \"api_secret\": \"1234567890ABCDEF\", // [0-9a-zA-Z]+\n \"token\":\"12345678-90ab-cdef-1234-567890abcdef\", // [0-9a-f\\-]+\n \"secret\":\"12345678-90ab-cdef-1234-567890abcdef\" // [0-9a-f\\-]+\n }\n\nContribute!\n===========\n\n#. Clone the code from `github\n `_\n\n#. Setup the virtualenv by following the instructions in\n `example_project/virtualenv_requirements.txt `_\n\n#. Edit, test, and share your code. See the `issues page\n `_ for\n inspiration and to coordinate with the community.", "description_content_type": null, "docs_url": null, "download_url": "http://github.com/datascopeanalytics/django-flux/archives/master", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/datascopeanalytics/django-flux", "keywords": null, "license": "MIT, see LICENSE.rst", "maintainer": null, "maintainer_email": null, "name": "django-flux", "package_url": "https://pypi.org/project/django-flux/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-flux/", "project_urls": { "Download": "http://github.com/datascopeanalytics/django-flux/archives/master", "Homepage": "http://github.com/datascopeanalytics/django-flux" }, "release_url": "https://pypi.org/project/django-flux/0.3.0/", "requires_dist": null, "requires_python": null, "summary": "locally fetch, store, and present social media flux", "version": "0.3.0" }, "last_serial": 789675, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "e754a10c97e4c9de6e566cb4f77232bb", "sha256": "ef544d5c7a711707ad03f5b429fe7606c16b61d5ba364a2fe6783152d41c5e45" }, "downloads": -1, "filename": "django-flux-0.1.0.tar.gz", "has_sig": false, "md5_digest": "e754a10c97e4c9de6e566cb4f77232bb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15936, "upload_time": "2012-12-04T00:36:31", "url": "https://files.pythonhosted.org/packages/ec/d5/07d3ebe43a2c0e8ba814ced28cc12a2f5d9691defa1378e153ea784638a7/django-flux-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "4628b2f730e6af6ae90229338b2b4594", "sha256": "de34b0b616f7d02b19f1c9344fb6c0ad5af4b72256967fa3a1d0eb50a2f9fd3d" }, "downloads": -1, "filename": "django-flux-0.1.1.tar.gz", "has_sig": false, "md5_digest": "4628b2f730e6af6ae90229338b2b4594", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16080, "upload_time": "2012-12-04T02:30:18", "url": "https://files.pythonhosted.org/packages/0a/73/174cc4cd26f51a118b5f3605d516a624e2e32564193558518c734981104e/django-flux-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "7e4eff71e278d742ed0c241a75cae666", "sha256": "e51d271d1b08f47a6bf983764b763f7364a3c43cfcc8fb1bbdec8b5e4e799699" }, "downloads": -1, "filename": "django-flux-0.1.2.tar.gz", "has_sig": false, "md5_digest": "7e4eff71e278d742ed0c241a75cae666", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16186, "upload_time": "2012-12-04T23:15:50", "url": "https://files.pythonhosted.org/packages/60/84/0d19ea24bf8afc5e9c1752cdeb9c5aba1c78a7ce2251512d95a43393533c/django-flux-0.1.2.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "25b6898e68298f60923cbf475ac0cd75", "sha256": "0b25fc102fecc9e77706332a5465b34bc4c3f6e219c8d3efdc26955d55215dbe" }, "downloads": -1, "filename": "django-flux-0.2.0.tar.gz", "has_sig": false, "md5_digest": "25b6898e68298f60923cbf475ac0cd75", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16626, "upload_time": "2012-12-08T04:32:24", "url": "https://files.pythonhosted.org/packages/67/16/5f7c4db339836d4d261eabee137d1c92726818b318b4f2e6a982be6ba8ef/django-flux-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "a94c476f31473405ffdbe339197ae3b6", "sha256": "1de8782d41b81c7d56a5a122e08dcb86df9033b3d935135391080128dc309a5b" }, "downloads": -1, "filename": "django-flux-0.3.0.tar.gz", "has_sig": false, "md5_digest": "a94c476f31473405ffdbe339197ae3b6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19009, "upload_time": "2013-02-05T13:10:53", "url": "https://files.pythonhosted.org/packages/07/23/5f936523f1f57adb9e6680fbccf4b05b690d2e13bcd5e6a0fc5f38954b0c/django-flux-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a94c476f31473405ffdbe339197ae3b6", "sha256": "1de8782d41b81c7d56a5a122e08dcb86df9033b3d935135391080128dc309a5b" }, "downloads": -1, "filename": "django-flux-0.3.0.tar.gz", "has_sig": false, "md5_digest": "a94c476f31473405ffdbe339197ae3b6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19009, "upload_time": "2013-02-05T13:10:53", "url": "https://files.pythonhosted.org/packages/07/23/5f936523f1f57adb9e6680fbccf4b05b690d2e13bcd5e6a0fc5f38954b0c/django-flux-0.3.0.tar.gz" } ] }