{ "info": { "author": "Cuttlesoft, LLC", "author_email": "engineering@cuttlesoft.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "===============\nFlask-Bitmapist\n===============\n\n.. image:: https://travis-ci.org/cuttlesoft/flask-bitmapist.svg?branch=master\n\t:target: https://travis-ci.org/cuttlesoft/flask-bitmapist\n\n.. image:: https://coveralls.io/repos/github/cuttlesoft/flask-bitmapist/badge.svg?branch=master\n\t:target: https://coveralls.io/github/cuttlesoft/flask-bitmapist?branch=master\n\nFlask extension that creates a simple interface to the Bitmapist analytics library.\n\n\nAbout\n-----\n\n`Bitmapist `_ is:\n\n [A] Python library [that] makes it possible to implement real-time, highly scalable analytics that can answer the following questions:\n\n - Has user 123 been online today? This week? This month?\n - Has user 123 performed action \"X\"?\n - How many users have been active this month? This hour?\n - How many unique users have performed action \"X\" this week?\n - What % of users that were active last week are still active?\n - What % of users that were active last month are still active this month?\n - Which users performed action \"X\"?\n\n\nInstallation\n------------\n\n::\n\n $ pip install flask-bitmapist\n\n\nUsage\n-----\n\nExample app:\n\n.. code-block:: python\n\n from flask import Flask\n from flask_bitmapist import FlaskBitmapist, mark\n\n app = Flask(__name__)\n\n flaskbitmapist = FlaskBitmapist()\n flaskbitmapist.init_app(app)\n\n @app.route('/')\n @mark('index:visited', 1) # current_user.id\n def index():\n \"\"\"using the mark decorator, the first argument is the event\n and the second is the id of the current_user\n \"\"\"\n return 'Hello, world!'\n\n if __name__ == '__main__':\n app.run()\n\n\nFor documentation on the ``mark`` decorator, look at the ``mark_event`` `Bitmapist function `_.\n\n\nConfig\n------\n\n=============================== =========== ======================================================================\nName Type Description\n=============================== =========== ======================================================================\n``BITMAPIST_REDIS_SYSTEM`` ``string`` Name of Redis System; defaults to ``default``\n``BITMAPIST_REDIS_URL`` ``string`` URL to connect to Redis server; defaults to ``redis://localhost:6379``\n``BITMAPIST_TRACK_HOURLY`` ``boolean`` Tells Bitmapist to track hourly; can also be passed to ``mark`` (e.g., ``@mark('active', 1, track_hourly=False)``)\n\n``BITMAPIST_DISABLE_BLUEPRINT`` ``boolean`` Disables registration of default Bitmapist Blueprint\n=============================== =========== ======================================================================\n\n\nCohort Blueprint\n----------------\n\nOne of the nice things about Bitmapist is its simple bit operations API and the data cohort that you get.\nFor more information about the cohort, visit the `Bitmapist README `_.\n\nWhen you initialize the ``flask-bitmapist`` extension, a blueprint is registered with the application.\n\n======== ===================== ============================================\nName Path Description\n======== ===================== ============================================\n`index` ``/bitmapist/`` Default Bitmapist index\n`cohort` ``/bitmapist/cohort`` Demo cohort retrieval and heatmap generation\n======== ===================== ============================================\n\n\nTests\n-----\n\nTo run the tests, ensure that you have Redis running on port 6399::\n\n $ redis-server --port 6399\n\n\nThen you can simply run::\n\n $ python setup.py test\n\n\nTo seed fake data for testing, run::\n\n $ python scripts/seed.py\n\n\nDocumentation\n-------------\n\nThe full Flask-Bitmapist documentation is available at `ReadTheDocs `_.\n\n\nContributing\n------------\n\nIf you're interested in contributing to Flask-Bitmapist, get started by creating an issue `here `_. Thanks!\n\n\n.. :changelog:\n\nRelease History\n---------------\n\n0.1.0 (2016-03-30)\n++++++++++++++++++\n\n- First release.", "description_content_type": null, "docs_url": "https://pythonhosted.org/Flask-Bitmapist/", "download_url": "https://github.com/cuttlesoft/flask-bitmapist/tarball/0.1.2", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/cuttlesoft/flask-bitmapist", "keywords": "Flask,Bitmapist", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "Flask-Bitmapist", "package_url": "https://pypi.org/project/Flask-Bitmapist/", "platform": "any", "project_url": "https://pypi.org/project/Flask-Bitmapist/", "project_urls": { "Download": "https://github.com/cuttlesoft/flask-bitmapist/tarball/0.1.2", "Homepage": "http://github.com/cuttlesoft/flask-bitmapist" }, "release_url": "https://pypi.org/project/Flask-Bitmapist/0.1.2/", "requires_dist": null, "requires_python": "", "summary": "Flask extension that creates a simple interface to Bitmapist analytics library", "version": "0.1.2" }, "last_serial": 2342753, "releases": { "0.1.0": [], "0.1.1": [ { "comment_text": "", "digests": { "md5": "6dcfa455fb2e831852c3c523c3947134", "sha256": "1882b5f63530cd2fa1d671a9559550ae8d981468da0654a9ab18fc65e1f4b7b7" }, "downloads": -1, "filename": "Flask-Bitmapist-0.1.1.tar.gz", "has_sig": false, "md5_digest": "6dcfa455fb2e831852c3c523c3947134", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14253, "upload_time": "2016-08-24T21:28:40", "url": "https://files.pythonhosted.org/packages/0c/bd/3b3fe6392b680d02fba243deb2ea0c6c368b4eb4f0057aafd21a1af054bf/Flask-Bitmapist-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "86288bd0e8471c64dcbb1f3849ff0a52", "sha256": "1d5ea2907e478197f37717d1e5d1a6889239cc6ee4931482d4465dd29ef10d1f" }, "downloads": -1, "filename": "Flask-Bitmapist-0.1.2.tar.gz", "has_sig": false, "md5_digest": "86288bd0e8471c64dcbb1f3849ff0a52", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16950, "upload_time": "2016-09-14T17:49:41", "url": "https://files.pythonhosted.org/packages/a8/9b/703eaccb0e2b56fe04678315e23fc90e0fe85b9e17cb2cc27c13318ac624/Flask-Bitmapist-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "86288bd0e8471c64dcbb1f3849ff0a52", "sha256": "1d5ea2907e478197f37717d1e5d1a6889239cc6ee4931482d4465dd29ef10d1f" }, "downloads": -1, "filename": "Flask-Bitmapist-0.1.2.tar.gz", "has_sig": false, "md5_digest": "86288bd0e8471c64dcbb1f3849ff0a52", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16950, "upload_time": "2016-09-14T17:49:41", "url": "https://files.pythonhosted.org/packages/a8/9b/703eaccb0e2b56fe04678315e23fc90e0fe85b9e17cb2cc27c13318ac624/Flask-Bitmapist-0.1.2.tar.gz" } ] }