{ "info": { "author": "Michael Boulton", "author_email": "michael@overlock.io", "bugtrack_url": null, "classifiers": [], "description": "Overlock Python client library |Build Status| |Pypi|\n====================================================\n\nThe `Overlock`_ python library allows logging and instrumentation of\nprogram code as a drop in replacement for python logging, but with some\nextensions. Only for use with the Overlock Agent for linux.\n\nSee https://docs.overlock.io/libraries/python/ for instructions.\n\nPython versions supported:\n\n- 2.7\n- 3.4\n- 3.5\n- 3.6\n- pypy\n- pypy3\n\nUsing the library\n-----------------\n\nThe overlock library needs to be 'installed' in your code to configure\nand provide some details to the Overlock Agent:\n\n.. code:: python\n\n\n from overlock import install\n\n install(\n # The name of the application program, defaults to \"unknown\"\n process_name=\"sensor-reader\", \n # Any custom metadata for the app can be added here\n metadata={\n \"version\": \"2.0.1\",\n \"hardware_revision\": get_hardware_version()\n },\n )\n\n\nWhen installed, it can be used to log information from all parts of your\nsystem\n\n.. code:: python\n\n from overlock import OverlockLogger\n ol = OverlockLogger() # 1 - Import the logger\n\n def read_sensor():\n try:\n value = read_sensor()\n ol.set_state({\"sensor_value\": value}) # 2 - Use set_state to add state to the store\n ol.info(\"got a new reading for the sensor\") # 3a - Add a log message\n return value\n except SensorReadException as e:\n ol.set_state({\"sensor_value\": \"unknown\"})\n ol.exception(\"Error trying to get sensor value!\") # 3b - Log an exception\n\nRunning tests\n-------------\n\n1. Install tox: ``pip install tox``\n2. Run tests ``tox``\n\nNote: you may want to comment out some of the python versions if your\nsystem does not have them installed.\n\n.. |Pypi| image:: https://img.shields.io/pypi/v/overlock.svg\n :target: https://pypi.python.org/pypi/overlock\n\n.. _Overlock: https://overlock.io\n\n.. |Build Status| image:: https://travis-ci.org/OverlockIoT/overlock-python.svg?branch=master\n :target: https://travis-ci.org/OverlockIoT/overlock-python", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/overlockIoT/python", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/overlockIoT/python", "keywords": "iot,overlock", "license": "", "maintainer": "", "maintainer_email": "", "name": "overlock", "package_url": "https://pypi.org/project/overlock/", "platform": "", "project_url": "https://pypi.org/project/overlock/", "project_urls": { "Download": "https://github.com/overlockIoT/python", "Homepage": "https://github.com/overlockIoT/python" }, "release_url": "https://pypi.org/project/overlock/0.3.0/", "requires_dist": null, "requires_python": "", "summary": "Overlock client library for instrumenting code", "version": "0.3.0" }, "last_serial": 3676027, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "b93ee42c7a8c6d3da125eecf47fa3c6f", "sha256": "ef9496bbfe599e64ca365597d888cb47fe7ccbf8ebb611f7e2ebd2dde026706c" }, "downloads": -1, "filename": "overlock-0.0.1.tar.gz", "has_sig": false, "md5_digest": "b93ee42c7a8c6d3da125eecf47fa3c6f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1852, "upload_time": "2017-10-18T08:51:40", "url": "https://files.pythonhosted.org/packages/de/22/c607dedca4ef85214b6740ec54dcd8f0813e1730e52332cddd6e54b50c40/overlock-0.0.1.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "d7537cf5d63ec6876569a09d0eb25fb8", "sha256": "c15749bdbe5a26e69d24496ab9ae2c3222791e7c35e79e0a252e5be150ca172d" }, "downloads": -1, "filename": "overlock-0.1.0.tar.gz", "has_sig": false, "md5_digest": "d7537cf5d63ec6876569a09d0eb25fb8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5320, "upload_time": "2018-02-01T17:48:59", "url": "https://files.pythonhosted.org/packages/1c/d5/25758fa707c9841cbf68a2fb65ac51e05f11c62c6712baf2d85aefa257cf/overlock-0.1.0.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "104b738a989fa3e239e251b414da090b", "sha256": "253139f90554aee6742ce82dfb5d4e8662761facb4a930aa2eece9396e244efd" }, "downloads": -1, "filename": "overlock-0.1.2.tar.gz", "has_sig": false, "md5_digest": "104b738a989fa3e239e251b414da090b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6008, "upload_time": "2018-02-02T09:33:42", "url": "https://files.pythonhosted.org/packages/6b/cb/85b6deb3f7a988212d676c1661c754c0c79399c778dbd0634e3fdf9fac71/overlock-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "35bd428ae91c6f5a7f478447ee01391e", "sha256": "613a99719f6856ddaab6e3b219ebe5f9c01d4eeb9d0adc84da92b2423eeeab20" }, "downloads": -1, "filename": "overlock-0.1.3.tar.gz", "has_sig": false, "md5_digest": "35bd428ae91c6f5a7f478447ee01391e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6271, "upload_time": "2018-02-02T09:48:19", "url": "https://files.pythonhosted.org/packages/fe/81/150e720b1e603b0737aad01a67998faa1348b05c286279cb22f391fedfde/overlock-0.1.3.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "b5a68d0759866c036210ce96102100c1", "sha256": "95613f9cb846308b78d8dccb52ff0bb50a165cf829742870485e6b21e149b83b" }, "downloads": -1, "filename": "overlock-0.2.0.tar.gz", "has_sig": false, "md5_digest": "b5a68d0759866c036210ce96102100c1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6364, "upload_time": "2018-02-12T14:32:55", "url": "https://files.pythonhosted.org/packages/6e/26/797dd8f4fd3501868cca0588e17dfad063aadd7514948784ef61f3d9ddd3/overlock-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "2b7d1cc1b16ed9980cdda4b4f6c169b1", "sha256": "d8c6a89840254882a9c5f86bb0adc5b3f90759c1d68961bbdc97ded35dc30897" }, "downloads": -1, "filename": "overlock-0.2.1.tar.gz", "has_sig": false, "md5_digest": "2b7d1cc1b16ed9980cdda4b4f6c169b1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6364, "upload_time": "2018-02-13T11:31:58", "url": "https://files.pythonhosted.org/packages/bb/b0/12b42f74e31417dbf25e1a197013e9a8c2c46178bb344d6245c2420f8461/overlock-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "5bdfd752485589f9aa021f6725e41b20", "sha256": "5c64955f8a14822f7a083eb538f4e02e50491576da7f9c0e1571e338c059ae4c" }, "downloads": -1, "filename": "overlock-0.2.2.tar.gz", "has_sig": false, "md5_digest": "5bdfd752485589f9aa021f6725e41b20", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6440, "upload_time": "2018-02-13T11:29:20", "url": "https://files.pythonhosted.org/packages/a8/1c/a72924d7b2ccf811ff25977f63a80ac93ab7f039ba79cdc8a20ba7bfbdf4/overlock-0.2.2.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "fe70174f20ee166cc14fb053ef816eda", "sha256": "a284f97f76f92e399bc7fef9bc6bdffe760093ae111a89fca68302246c9396f8" }, "downloads": -1, "filename": "overlock-0.3.0.tar.gz", "has_sig": false, "md5_digest": "fe70174f20ee166cc14fb053ef816eda", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7004, "upload_time": "2018-03-16T12:02:33", "url": "https://files.pythonhosted.org/packages/a7/3b/beeb15b15ab712d7e3c1f8644ce2c39b4184088e93ed10c6041224edd723/overlock-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fe70174f20ee166cc14fb053ef816eda", "sha256": "a284f97f76f92e399bc7fef9bc6bdffe760093ae111a89fca68302246c9396f8" }, "downloads": -1, "filename": "overlock-0.3.0.tar.gz", "has_sig": false, "md5_digest": "fe70174f20ee166cc14fb053ef816eda", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7004, "upload_time": "2018-03-16T12:02:33", "url": "https://files.pythonhosted.org/packages/a7/3b/beeb15b15ab712d7e3c1f8644ce2c39b4184088e93ed10c6041224edd723/overlock-0.3.0.tar.gz" } ] }