{ "info": { "author": "Numan Sachwani", "author_email": "numan856@gmail.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "Intended Audience :: System Administrators", "Programming Language :: Python", "Topic :: Software Development", "Topic :: Utilities" ], "description": "py-analytics\n============\n\n.. image:: https://secure.travis-ci.org/numan/py-analytics.png?branch=master\n :target: https://secure.travis-ci.org/numan/py-analytics\n\nPy-Analytics is a library designed to make it easy to provide analytics as part of any project.\n\nThe project's goal is to make it easy to store and retrieve analytics data. It does not provide\nany means to visualize this data.\n\nCurrently, only ``Redis`` is supported for storing data.\n\nInstall\n--------\n\nYou can install the latest official stable version using pypi:\n\n >>> pip install analytics\n\n\nOr get the latest version directly from github:\n\n\n >>> pip install -e git+https://github.com/numan/py-analytics.git#egg=analytics\n\n\n\nRequirements\n------------\n\nRequired\n~~~~~~~~\n\nRequirements **should** be handled by setuptools, but if they are not, you will need the following Python packages:\n\n* nydus\n* redis\n* dateutil\n\nOptional\n~~~~~~~~\n\n* hiredis\n\nanalytics.create_analytic_backend\n----------------------------------\n\nCreates an analytics object that allows to to store and retrieve metrics::\n\n >>> from analytics import create_analytic_backend\n >>>\n >>> analytics = create_analytic_backend({\n >>> 'backend': 'analytics.backends.redis.Redis',\n >>> 'settings': {\n >>> 'defaults': {\n >>> 'host': 'localhost',\n >>> 'port': 6379,\n >>> 'db': 0,\n >>> },\n >>> 'hosts': [{'db': 0}, {'db': 1}, {'host': 'redis.example.org'}]\n >>> },\n >>> })\n\nInternally, the ``Redis`` analytics backend uses ``nydus`` to distribute your metrics data over your cluster of redis instances.\n\nThere are two required arguements:\n\n* ``backend``: full path to the backend class, which should extend analytics.backends.base.BaseAnalyticsBackend\n* ``settings``: settings required to initialize the backend. For the ``Redis`` backend, this is a list of hosts in your redis cluster.\n\nExample Usage\n-------------\n\n::\n\n from analytics import create_analytic_backend\n import datetime\n\n analytics = create_analytic_backend({\n \"backend\": \"analytics.backends.redis.Redis\",\n \"settings\": {\n \"hosts\": [{\"db\": 5}]\n },\n })\n\n year_ago = datetime.date.today() - datetime.timedelta(days=365)\n\n #create some analytics data\n analytics.track_metric(\"user:1234\", \"comment\", year_ago)\n analytics.track_metric(\"user:1234\", \"comment\", year_ago, inc_amt=3)\n #we can even track multiple metrics at the same time for a particular user\n analytics.track_metric(\"user:1234\", [\"comments\", \"likes\"], year_ago)\n #or track the same metric for multiple users (or a combination or both)\n analytics.track_metric([\"user:1234\", \"user:4567\"], \"comment\", year_ago)\n\n #retrieve analytics data:\n analytics.get_metric_by_day(\"user:1234\", \"comment\", year_ago, limit=20)\n analytics.get_metric_by_week(\"user:1234\", \"comment\", year_ago, limit=10)\n analytics.get_metric_by_month(\"user:1234\", \"comment\", year_ago, limit=6)\n\n #create a counter\n analytics.track_count(\"user:1245\", \"login\")\n analytics.track_count(\"user:1245\", \"login\", inc_amt=3)\n\n #retrieve multiple metrics at the same time\n #group_by is one of ``month``, ``week`` or ``day``\n analytics.get_metrics([(\"user:1234\", \"login\",), (\"user:4567\", \"login\",)], year_ago, group_by=\"day\")\n >> [....]\n\n #set a metric count for a day\n analytics.set_metric_by_day(\"user:1245\", \"login\", year_ago, 100)\n\n #sync metrics for week and month after setting day\n analytics.sync_agg_metric(\"user:1245\", \"login\", year_ago, datetime.date.today())\n\n #retrieve a count\n analytics.get_count(\"user:1245\", \"login\")\n\n #retrieve a count between 2 dates\n analytics.get_count(\"user:1245\", \"login\", start_date=datetime.date(month=1, day=5, year=2011), end_date=datetime.date(month=5, day=15, year=2011))\n\n #retrieve counts\n analytics.get_counts([(\"user:1245\", \"login\",), (\"user:1245\", \"logout\",)])\n\n #clear out everything we created\n analytics.clear_all()\n\n\nBACKWARDS INCOMPATIBLE CHANGES\n-------------------------------\n\nV0.6.0\n~~~~~~\n* This version introduces prefixes. Any old analytics data will be unaccessable.\n\nv0.5.2\n~~~~~~\n* ``get_metric_by_day``, ``get_metric_by_week`` and ``get_metric_by_month`` return ``series`` as a set of strings instead of a list of date/datetime objects\n\n\nTODO\n----\n\n* Add more backends possibly...?\n* Add an API so it can be deployed as a stand alone service (http, protocolbuffers, ...)", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/numan/py-analytics", "keywords": null, "license": "Apache License 2.0", "maintainer": null, "maintainer_email": null, "name": "analytics", "package_url": "https://pypi.org/project/analytics/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/analytics/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/numan/py-analytics" }, "release_url": "https://pypi.org/project/analytics/0.6.5/", "requires_dist": null, "requires_python": null, "summary": "Library for efficiently adding analytics to your project.", "version": "0.6.5" }, "last_serial": 901036, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "9daf6cf0bbf4d5031ce7eea1d8f18140", "sha256": "4a67fceef5cc13f3640e050c818f6d7eacdaca366a954ab6209962113a7b32b6" }, "downloads": -1, "filename": "analytics-0.2.0.tar.gz", "has_sig": false, "md5_digest": "9daf6cf0bbf4d5031ce7eea1d8f18140", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7480, "upload_time": "2012-05-23T21:47:24", "url": "https://files.pythonhosted.org/packages/dc/0b/77371d251896eca8b0b5d34faefa4973626833ebc408a1eea63e35553c72/analytics-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "16e1e9982ff9ce2bedf3aad003cb22f1", "sha256": "0dbc11227395cbd5381d71d94ccd1b47d86a7bbe71c4e9d3017aa4d29b11edc9" }, "downloads": -1, "filename": "analytics-0.2.1.tar.gz", "has_sig": false, "md5_digest": "16e1e9982ff9ce2bedf3aad003cb22f1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7808, "upload_time": "2012-05-23T22:29:34", "url": "https://files.pythonhosted.org/packages/16/e3/360c36b7eb35013628c66c339b6dd42fdb7bfc2095230e3d8210ae280f78/analytics-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "built for Linux-3.0.0-20-generic-x86_64-with-glibc2.4", "digests": { "md5": "9748e154e14553739861e562facfe939", "sha256": "290e29f277adea02fa382a58b41eeb414d747da18a46d8b93a481ab0969de912" }, "downloads": -1, "filename": "analytics-0.3.0.linux-x86_64.tar.gz", "has_sig": false, "md5_digest": "9748e154e14553739861e562facfe939", "packagetype": "bdist_dumb", "python_version": "any", "requires_python": null, "size": 16522, "upload_time": "2012-06-05T20:42:00", "url": "https://files.pythonhosted.org/packages/26/1e/760bf575bedf49cfe228b4d8e8263a99369f426edd0d6ce89d9a57478fb1/analytics-0.3.0.linux-x86_64.tar.gz" }, { "comment_text": "", "digests": { "md5": "9325c1acb980a8cadb8b6eb1aa76c17c", "sha256": "d46cb1180ba375ce386faac63351aaa71ba6f1134719f983261babbfa26495ac" }, "downloads": -1, "filename": "analytics-0.3.0.tar.gz", "has_sig": false, "md5_digest": "9325c1acb980a8cadb8b6eb1aa76c17c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9207, "upload_time": "2012-06-03T03:38:28", "url": "https://files.pythonhosted.org/packages/42/f8/7e3332330259b5d6189b8f876a2ba9c9ba3b5f527b65cde0809facffebb5/analytics-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "499f950eb31415986627106fed09b8de", "sha256": "3af222d9c9439545cd8d23cda99fd61a4bac3058dd1a06f187c5eab806dcd67c" }, "downloads": -1, "filename": "analytics-0.3.1.tar.gz", "has_sig": false, "md5_digest": "499f950eb31415986627106fed09b8de", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9213, "upload_time": "2012-06-05T20:45:30", "url": "https://files.pythonhosted.org/packages/8f/49/b87c07047e5f8cebbec4ef0915c5e56abc43cca8f1ae0d1c719cf10ad695/analytics-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "9cf2c6b7b6066180b0b56823274fa68f", "sha256": "18a266a1885e72b8ca917676765347ca1c212b77b5c8392eb95e65ed2e7c9d00" }, "downloads": -1, "filename": "analytics-0.3.2.tar.gz", "has_sig": false, "md5_digest": "9cf2c6b7b6066180b0b56823274fa68f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13494, "upload_time": "2012-06-05T20:56:22", "url": "https://files.pythonhosted.org/packages/63/fd/b1126e9f4542d8aa5705e793d6b3dee46322443ab8ba59c7d9cfc1069e3a/analytics-0.3.2.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "5d52439bc4fe775163a86e84d4bfe771", "sha256": "04736cd699cd5527a829f9e8e4df050a246694af821492cff845a7d526f0f284" }, "downloads": -1, "filename": "analytics-0.4.0.tar.gz", "has_sig": false, "md5_digest": "5d52439bc4fe775163a86e84d4bfe771", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14086, "upload_time": "2012-06-08T19:39:50", "url": "https://files.pythonhosted.org/packages/4f/ef/9c713f33556e8e1fa020dd89c3e712cdddbed8a96c0a268db7c0e1f3faf0/analytics-0.4.0.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "202f861a488f57f06bf7a26b022f8358", "sha256": "e4a657c7a3f99a12eacaac787dcae595abedaed5c479755dc3fbe907e8d2302a" }, "downloads": -1, "filename": "analytics-0.5.0.tar.gz", "has_sig": false, "md5_digest": "202f861a488f57f06bf7a26b022f8358", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14829, "upload_time": "2012-09-06T21:17:15", "url": "https://files.pythonhosted.org/packages/88/7b/0213e1cb641957b84cd0c73d58dcc3a4c3d9b0a9c0225d33f17070b99628/analytics-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "057fa4f613b7d55a258f5450fd455aba", "sha256": "4fd681ca5b6421777b06524e7a4cae6aac99b461920194bc06968047c1d11ad2" }, "downloads": -1, "filename": "analytics-0.5.1.tar.gz", "has_sig": false, "md5_digest": "057fa4f613b7d55a258f5450fd455aba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14897, "upload_time": "2012-09-11T20:01:56", "url": "https://files.pythonhosted.org/packages/16/d9/d74741600faeb1316620cdc209174b91a9275832787037d1ef79d6929a84/analytics-0.5.1.tar.gz" } ], "0.5.2": [ { "comment_text": "", "digests": { "md5": "592af21e4106e4a08f8e08448819acc8", "sha256": "002ddb1e74ef1d23adff1c04edb664ab992b975804d3763800552715b5b6030b" }, "downloads": -1, "filename": "analytics-0.5.2.tar.gz", "has_sig": false, "md5_digest": "592af21e4106e4a08f8e08448819acc8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15306, "upload_time": "2012-09-13T17:36:40", "url": "https://files.pythonhosted.org/packages/8f/c0/e3403ed8f02f94217d16c9e54d5b2221804f58ec4ca3651b63191b105f07/analytics-0.5.2.tar.gz" } ], "0.5.3": [ { "comment_text": "", "digests": { "md5": "a2ffb6a6419bef821608db02adcbdedb", "sha256": "02435d0277c663fe054efd98cd553dff4c66bf74877b6e86af8ad6b92ab20e2e" }, "downloads": -1, "filename": "analytics-0.5.3.tar.gz", "has_sig": false, "md5_digest": "a2ffb6a6419bef821608db02adcbdedb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13590, "upload_time": "2013-03-02T23:29:46", "url": "https://files.pythonhosted.org/packages/97/45/51779655dd068e22c99fbb36e813401c9cc6857275929b221c47b1fd0662/analytics-0.5.3.tar.gz" } ], "0.5.4": [ { "comment_text": "", "digests": { "md5": "ff5cb1bd43662f30778e2dd161a6d040", "sha256": "649c3016c4ed795d6f81c78cb8a9473d494d55fa3bc2dac85d5501015c776b57" }, "downloads": -1, "filename": "analytics-0.5.4.tar.gz", "has_sig": false, "md5_digest": "ff5cb1bd43662f30778e2dd161a6d040", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13726, "upload_time": "2013-04-13T23:09:52", "url": "https://files.pythonhosted.org/packages/6a/c5/484c6f7ea52594b774d1fd1407f43c18646fcc8a4c035592d81f4c3f48da/analytics-0.5.4.tar.gz" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "888b5edb4bd7e3188c830ae6b17f0d0a", "sha256": "2303f9e885e303aca3fad51b282f812d1ea7a219da77f4c3903a4a263556c906" }, "downloads": -1, "filename": "analytics-0.6.0.tar.gz", "has_sig": false, "md5_digest": "888b5edb4bd7e3188c830ae6b17f0d0a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14213, "upload_time": "2013-04-18T18:45:25", "url": "https://files.pythonhosted.org/packages/1f/be/b416abdcb0334934d9ef872bb42d44f592f199cd32b6409c4fbff4fc1263/analytics-0.6.0.tar.gz" } ], "0.6.1": [ { "comment_text": "", "digests": { "md5": "f7cf639d9d6e763984aa995e8620abcf", "sha256": "6bb576b7f19ae32e0d2856783438b20659d2e2cde46222762650b631431dc1ca" }, "downloads": -1, "filename": "analytics-0.6.1.tar.gz", "has_sig": false, "md5_digest": "f7cf639d9d6e763984aa995e8620abcf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14222, "upload_time": "2013-04-19T20:19:39", "url": "https://files.pythonhosted.org/packages/73/ba/2f6079d2b35dbf75678c593feaf9c03f547eb26d971746683b85abe7b631/analytics-0.6.1.tar.gz" } ], "0.6.2": [ { "comment_text": "", "digests": { "md5": "9aa039914244b30350a0c636f393d56a", "sha256": "8bcb48dd91f4751bf24d91ebc7c644b0626476d42313c98f44cbef009989945f" }, "downloads": -1, "filename": "analytics-0.6.2.tar.gz", "has_sig": false, "md5_digest": "9aa039914244b30350a0c636f393d56a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14223, "upload_time": "2013-05-10T18:25:20", "url": "https://files.pythonhosted.org/packages/b1/90/5f6e9f29cbaff21281337b8f1bfff4e119bbe79d3dd8e70c0df636202187/analytics-0.6.2.tar.gz" } ], "0.6.3": [ { "comment_text": "", "digests": { "md5": "0c98b036ae3c56701abb8559d23fc264", "sha256": "41b3007149c9cf1e199f82f274d24beb302dcb0eeffeab37318e544c324f6824" }, "downloads": -1, "filename": "analytics-0.6.3.tar.gz", "has_sig": false, "md5_digest": "0c98b036ae3c56701abb8559d23fc264", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16309, "upload_time": "2013-08-09T18:23:53", "url": "https://files.pythonhosted.org/packages/47/20/52f79e1d8fd4b8b43d744770bb09555991b07a93a2afe790aa166b5f1567/analytics-0.6.3.tar.gz" } ], "0.6.4": [ { "comment_text": "", "digests": { "md5": "336accf906a4eaebffe53094e9164101", "sha256": "742fddf5347a8f807654a734d27a300a904a5c02e151e3805f9823b0cbecdfda" }, "downloads": -1, "filename": "analytics-0.6.4.tar.gz", "has_sig": false, "md5_digest": "336accf906a4eaebffe53094e9164101", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16454, "upload_time": "2013-10-22T21:56:11", "url": "https://files.pythonhosted.org/packages/aa/f7/b229ab30f73232e42544d966f5ed845519c8d293c10987c8d05276d5b205/analytics-0.6.4.tar.gz" } ], "0.6.5": [ { "comment_text": "", "digests": { "md5": "1ca9fb8367bb7d30df2366f0266b7151", "sha256": "a70e2728505c93b8f9682aa2a5c6e6562b02c4cbbbd0f877d761da5fc0dcab6a" }, "downloads": -1, "filename": "analytics-0.6.5.tar.gz", "has_sig": false, "md5_digest": "1ca9fb8367bb7d30df2366f0266b7151", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16418, "upload_time": "2013-10-22T22:54:29", "url": "https://files.pythonhosted.org/packages/e2/55/3291ed900c1cd6daf8ec5a5fa10c1cffe5c58839f6f9da288f332e22acc5/analytics-0.6.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1ca9fb8367bb7d30df2366f0266b7151", "sha256": "a70e2728505c93b8f9682aa2a5c6e6562b02c4cbbbd0f877d761da5fc0dcab6a" }, "downloads": -1, "filename": "analytics-0.6.5.tar.gz", "has_sig": false, "md5_digest": "1ca9fb8367bb7d30df2366f0266b7151", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16418, "upload_time": "2013-10-22T22:54:29", "url": "https://files.pythonhosted.org/packages/e2/55/3291ed900c1cd6daf8ec5a5fa10c1cffe5c58839f6f9da288f332e22acc5/analytics-0.6.5.tar.gz" } ] }