{ "info": { "author": "David Bain", "author_email": "david@alteroo.com", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Framework :: Plone", "Programming Language :: Python", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7" ], "description": "==================================\ncollective.awstats_hitcounter\n==================================\n\nGrabs hits, views and popular content based on awstats data and presents\nthis information in the context of your Plone site.\nProvides a \"Popular Content\" portlet for displaying popular content from\nawstats.\n\nInstallation & Usage\n------------------------\n\nAdd collective.awstats_hitcounter to your buildout\nand re-run bin/buildout\n\nThen install on your plone site under \"Site Setup\" > \"Add-ons\"\n\nOnce this is installed you know have the facility to dynamically pull in a counter.\n\nConfiguration\n---------------------\n\nAfter installation configure your awstats url.\nYou can do so by going to Site Setup > Awstats HitCounter Settings.\n\n.. image:: https://raw.githubusercontent.com/collective/collective.awstats_hitcounter/master/sitesettings.png\n\nSet the absolute url to look similar to this:\n\n.. image:: https://raw.githubusercontent.com/collective/collective.awstats_hitcounter/master/configure_url.png\n :width: 800 px\n\nConfiguring the Popular Content settings for the popular_content_view\n````````````````````````````````````````````````````````````````````````````\n\nIn order to make use of the built in @@popular_content_view you will need to register an \"awstats popular page\"\n\n\nIf you need to find the \"awstats popular page\" you will need to provide the url from your awstats installation that provides the full \nlist of Page URLs then follow the link to the \"Full list\"\nIt will look something like this:\n\n.. image:: https://raw.githubusercontent.com/collective/collective.awstats_hitcounter/master/awstats_fulllist_screenshot.png\n :width: 800 px\n\nAdd that url as the `awstats_hitcounter url_of_popular_page` value (see the image below).\n\n.. image:: https://raw.githubusercontent.com/collective/collective.awstats_hitcounter/master/portal_registry.png\n :width: 800 px\n\nDebugging with DUMP_RAW_AWSTATS_URLS\n---------------------------------------\n\nSometimes you want to make sure things are working.\nThe following can be done on a non-production server. \n\nDO NOT DO THIS ON A PRODUCTION SERVER.\n\nLaunch the instance with the env var DUMP_RAW_AWSTATS_URLS as follows::\n\n DUMP_RAW_AWSTATS_URLS=1 bin/instance fg \n\nThis tells the system to skip comparing awstats values to the site catalog.\nEffectively you'll just get a 'raw' dump of the URLs returned from AWSTATS.\nThis is very useful for troubleshooting and diagnosing if scraping is working\nat all.\n\n\nUsage\n---------\n\ncollective.awstats_hitcounter adds a viewlet with the id 'awstats_hitcounter' which pulls in the stats from awstats.\n\nAdd this javascript at the bottom of pages where you want the counter to show::\n\n $(\"#awstats_hitcounter\").load(window.location.pathname + \"/@@awstats_hitcounter_view\")\n\nThe screenshot below illustrates the expected behaviour\n\n.. image:: https://raw.githubusercontent.com/collective/collective.awstats_hitcounter/master/awstats_hitcounter_screenshot.png\n :width: 800 px\n\nThe Popular Content Portlet\n````````````````````````````\n\nThis add-on provides a \"Popular Content Portlet\". It can either make use of the global settings or use settings\nspecific to the portlet.\n\nThe portlet is used to present the most popular content\non your website, based on awstats.\n\n\nIf you prefer to configure all settings in the context of the portlet, you will need to provide the url from your \nawstats installation that provides the full list of Page URLs then follow the link to the \"Full list\"\nIt will look something like this:\n\n.. image:: https://raw.githubusercontent.com/collective/collective.awstats_hitcounter/master/awstats_fulllist_screenshot.png\n :width: 800 px\n\nCopy the url associated with that page, you'll need it when adding the portlet.\n\nDecide where in your site you want the portlet to be located and using the 'manage portlets' link add a new 'Popular Content Portlet'. You'll see a screen similar to this:\n\n\n.. image:: https://raw.githubusercontent.com/collective/collective.awstats_hitcounter/master/configuring_the_portlet.png\n :width: 800 px\n\nWe recommend that you leave the \"Read settings from the global registry\" option selected, this has the effect of \noverriding the values of the settings highlighted in orange below.\n(The global registry is also used for the Popular content view).\n\n.. image:: https://raw.githubusercontent.com/collective/collective.awstats_hitcounter/master/configuring_the_portlet-global-registry.png\n :width: 800 px\n\nUse the **Blacklist** to prevent particular URLs from showing up in popular content.\n\nUse the **White list** to specify what content types are allowed in the portlet.\n\nContributors\n============\n\n- David Bain, david@alteroo.com\n\n\nChangelog\n=========\n\n0.1.6\n------------\n\n- add on listens for the existence of the env var DUMP_RAW_AWSTATS_URLS,\n useful for testing and troubleshooting\n- @@popular_content_view can now be configured to say how many items should show\n on the page. This setting is managed in the registry. The default value is 150.\n \n0.1.5\n----------------\n\n- added a popular content view\n- added a popular content portlet\n- added a content type whitelist to the portlet\n- added a url black list to the portlet\n- added an option to filter out direct downloads from the portlet\n\n0.1.4\n----------------\n\n- added support for hits (not just page views)\n [pigeonflight]\n\n0.1.3\n----------------\n\n- moved the stats viewlet to the top of the portal footer viewlet manager\n [pigeonflight]\n\n0.1.2\n----------------\n\n- fixed a problem with the way the path was retrieved\n [pigeonflight]\n- now counts downloaded attachments different from views\n [pigeonflight]\n\n0.1.1\n----------------\n\n- moved the hitcounter viewlet to the viewlets.IPortalFooter\n- added custom app.js which asynchronously pulls stats from the 'awstats_hitcounter_view'\n- the stats view now returns the content type, creation date and number of views\n [pigeonflight]\n- update to use BeautifulSoup for scraping awstats\n [pigeonflight]\n\n0.1 \n----------------\n\n- Initial release.\n [pigeonflight]", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://pypi.python.org/pypi/collective.awstats_hitcounter", "keywords": "Python Plone", "license": "GPL", "maintainer": null, "maintainer_email": null, "name": "collective.awstats_hitcounter", "package_url": "https://pypi.org/project/collective.awstats_hitcounter/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/collective.awstats_hitcounter/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://pypi.python.org/pypi/collective.awstats_hitcounter" }, "release_url": "https://pypi.org/project/collective.awstats_hitcounter/0.1.6.1/", "requires_dist": null, "requires_python": null, "summary": "Grabs hit counts from awstats and returns as json formatted data", "version": "0.1.6.1" }, "last_serial": 1767319, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "14def88682b000d5c88570a9ebb4c48e", "sha256": "5bd41a365f56c66f3afd8ed523736a6ba34b46c1057e9fb978475343d688e341" }, "downloads": -1, "filename": "collective.awstats_hitcounter-0.1.tar.gz", "has_sig": false, "md5_digest": "14def88682b000d5c88570a9ebb4c48e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 459932, "upload_time": "2015-05-19T21:05:03", "url": "https://files.pythonhosted.org/packages/1b/dd/9e22da4d91dc64b52a2ce20c8ec3d43182808e153e632a0810492b1fd2b8/collective.awstats_hitcounter-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "dd52d3a7a828e19c8e92736fb0d4668d", "sha256": "866c7544ebc731011baeda2c96715b1cd1b42616ec89b2bc7673796f47f4a621" }, "downloads": -1, "filename": "collective.awstats_hitcounter-0.1.1.tar.gz", "has_sig": false, "md5_digest": "dd52d3a7a828e19c8e92736fb0d4668d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15181, "upload_time": "2015-06-09T21:20:20", "url": "https://files.pythonhosted.org/packages/c7/e6/aab69c9345b9c57ec324c850cadffb5e1afb4487fdb48db145db5996bb2f/collective.awstats_hitcounter-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "170b324fe1a20b56710ee7e65798b46d", "sha256": "a22ab1dfe26b74144cdb9c46ab1b47ecaff09b2e763f8839535060e9aed7eba0" }, "downloads": -1, "filename": "collective.awstats_hitcounter-0.1.2.tar.gz", "has_sig": false, "md5_digest": "170b324fe1a20b56710ee7e65798b46d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15634, "upload_time": "2015-06-11T21:29:28", "url": "https://files.pythonhosted.org/packages/e2/40/75dae310f9e6a55a2804e18488f3e4216992d6313ff57b0b0eb3a26cd7f0/collective.awstats_hitcounter-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "9d462aa3fd8d2e0a18d4cf9c2a709e63", "sha256": "3987cb0f240df004cb248b3b736e149456e90f19da9bc4674ebe48d5f2f41817" }, "downloads": -1, "filename": "collective.awstats_hitcounter-0.1.3.tar.gz", "has_sig": false, "md5_digest": "9d462aa3fd8d2e0a18d4cf9c2a709e63", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15792, "upload_time": "2015-06-18T16:03:39", "url": "https://files.pythonhosted.org/packages/fd/ab/960b60cba6acf3a377aaeca54192223e221adfaf04cb3da802d8ae320709/collective.awstats_hitcounter-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "feacb9b6285426e925f219010cbdd5b3", "sha256": "6cd58f59384985f2d40ead5490cf73d24784b7f403e7617d3dca67f6e63ab207" }, "downloads": -1, "filename": "collective.awstats_hitcounter-0.1.4.tar.gz", "has_sig": false, "md5_digest": "feacb9b6285426e925f219010cbdd5b3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16241, "upload_time": "2015-06-23T15:22:50", "url": "https://files.pythonhosted.org/packages/17/b8/fe847f15b314f5b1275b7f7a5ebc9e32a749270e615097cf7eeca9e07484/collective.awstats_hitcounter-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "aa2ed4e156474aa59f8251bc3963ddfd", "sha256": "735b013ac5e54e5bfbc1435f33fcfca54d7d688a5e0bf549b85eb50d1360ded7" }, "downloads": -1, "filename": "collective.awstats_hitcounter-0.1.5.tar.gz", "has_sig": false, "md5_digest": "aa2ed4e156474aa59f8251bc3963ddfd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27888, "upload_time": "2015-07-23T00:53:36", "url": "https://files.pythonhosted.org/packages/be/1a/c05a6696eacc61ed9f074ac744268b8b54d06ce2850b3929b380528deb10/collective.awstats_hitcounter-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "5852f048d586c0e370827e84b0a6ec48", "sha256": "e288aec808a9c3fa17e6283bd9f5c3779f026dd9586b64b33735a1274b4d4274" }, "downloads": -1, "filename": "collective.awstats_hitcounter-0.1.6.tar.gz", "has_sig": false, "md5_digest": "5852f048d586c0e370827e84b0a6ec48", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28810, "upload_time": "2015-07-23T14:09:00", "url": "https://files.pythonhosted.org/packages/07/4d/625c91b8ba4801ffc528cf97d677e2fe1594f2960275b170fcea967664c0/collective.awstats_hitcounter-0.1.6.tar.gz" } ], "0.1.6.1": [ { "comment_text": "", "digests": { "md5": "d81debf839dbfa5cb27552b9d284ff00", "sha256": "03aef54ae8f8c46de6c1b18941a7b341b973c5ef4cb15794c5ca8d7c6b7dc23c" }, "downloads": -1, "filename": "collective.awstats_hitcounter-0.1.6.1.tar.gz", "has_sig": false, "md5_digest": "d81debf839dbfa5cb27552b9d284ff00", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31371, "upload_time": "2015-10-13T20:27:55", "url": "https://files.pythonhosted.org/packages/8a/39/4784b005ce1cf2d9295ebf79881eba9edb1edbc32fd16f7416d66d524a4a/collective.awstats_hitcounter-0.1.6.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d81debf839dbfa5cb27552b9d284ff00", "sha256": "03aef54ae8f8c46de6c1b18941a7b341b973c5ef4cb15794c5ca8d7c6b7dc23c" }, "downloads": -1, "filename": "collective.awstats_hitcounter-0.1.6.1.tar.gz", "has_sig": false, "md5_digest": "d81debf839dbfa5cb27552b9d284ff00", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 31371, "upload_time": "2015-10-13T20:27:55", "url": "https://files.pythonhosted.org/packages/8a/39/4784b005ce1cf2d9295ebf79881eba9edb1edbc32fd16f7416d66d524a4a/collective.awstats_hitcounter-0.1.6.1.tar.gz" } ] }