{ "info": { "author": "tiredpixel", "author_email": "tp@tiredpixel.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: System Administrators", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4" ], "description": "# Pikka Bird Server (Python)\n\n[![Build Status](https://travis-ci.org/tiredpixel/pikka-bird-server-py.png?branch=master,stable)](https://travis-ci.org/tiredpixel/pikka-bird-server-py)\n\nPikka Bird ops monitoring tool Server component.\n\nPikka Bird Server provides an API to which [Pikka Bird Collector][collector]\nsends metrics reports, storing in a [PostgreSQL][postgresql] database. Pikka\nBird Server is a [Python][python] [Flask][flask] application.\n\nOne of the design goals of Pikka Bird is to enable production-suitable setup in\na minimum of steps and configuration. To support this, Pikka Bird Server uses\n[Gunicorn][gunicorn] to provide concurrent request workers. Other setups can be\nused if preferred, however.\n\nPikka Bird is currently in a draft phase, which means that payloads and schemas\nmight be changed in a backwards-incompatible fashion. Although it is unlikely,\nin extreme cases this could require you to reinstall with an empty database. If\nthis upsets you too much, please wave and come back later. :) Currently, it is\nnot recommended that you use Pikka Bird as a replacement for any of your usual\nmonitoring tools.\n\nPikka Bird Server can currently only collect metrics and store them in the\ndatabase. There is no serving metrics via the API, no aggregation, no reporting, \nno alerting -- you get the idea. :)\n\nMore sleep lost by [tiredpixel](https://www.tiredpixel.com/).\n\n\n## Installation\n\nInstall the following externals:\n\n- [Python][python]\n \n The default version supported is defined in `.python-version`. Any other\n versions supported as defined in `.travis.yml`.\n\n- [PostgreSQL][postgresql]\n \n This is specific dependency, as extensive use is made of PostgreSQL-specific\n functionality which may not be available in other databases.\n\nInstall using [Pip][pip]:\n\n pip install pikka-bird-server\n\nThere are currently no released server packages (stay tuned).\n\nMigrate the database:\n\n bin/pikka-bird-server -c database-migrate\n\n\n## Usage\n\nTo run the API:\n\n bin/pikka-bird-server\n\nRun [Pikka Bird Collector][collector].\n\nLook at your database. :P\n\nHelp is at hand:\n\n bin/pikka-bird-server -h\n\n\n## Development\n\nCopy the example configuration for development, adjusting to taste:\n\n cp .env.example .env\n\nCopy the example configuration for testing, adjusting to taste, adding the\nenvironment variable `CI=true` (the tests are destructive to the database):\n\n cp .env.example .test.env\n\nInstall locally using [Pip][pip] editable mode:\n\n pip install -r requirements.txt\n pip install -e .\n\nStart a server using [Honcho][honcho], which reads `Procfile`:\n\n honcho start\n\nRun the tests, which use [py.test][py_test]:\n\n honcho run -e .test.env py.test\n\n\n## Stay Tuned\n\nWe have a [Librelist][librelist] mailing list!\nTo subscribe, send an email to .\nTo unsubscribe, send an email to .\nThere be [archives](http://librelist.com/browser/pikka.bird/).\n\nYou can also become a\n[watcher](https://github.com/tiredpixel/pikka-bird-server/watchers)\non GitHub. And don't forget you can become a\n[stargazer](https://github.com/tiredpixel/pikka-bird-server/stargazers)\nif you are so minded. :D\n\n\n## Contributions\n\nContributions are embraced with much love and affection! <3 Please fork the\nrepository and wizard your magic, preferably with plenty of fairy-dust sprinkled\nover the tests. Then send me a pull request. :) If you're thinking about\nworking on something involved, it would be great if you could wave via the\nissue tracker or mailing list; I'd hate for good effort to be wasted!\n\nDo whatever makes you happy. We'll probably still like you. :)\n\n\n## Blessing\n\nMay you find peace, and help others to do likewise.\n\n\n## Licence\n\n\u00a9 [tiredpixel](https://www.tiredpixel.com/) 2015.\nIt is free software, released under the MIT License, and may be redistributed\nunder the terms specified in `LICENSE.txt`.\n\n\n[collector]: https://github.com/tiredpixel/pikka-bird-collector-py\n[flask]: http://flask.pocoo.org/\n[gunicorn]: http://gunicorn.org/\n[honcho]: https://github.com/nickstenning/honcho\n[librelist]: http://librelist.com/\n[pip]: https://pypi.python.org/pypi/pip\n[postgresql]: http://www.postgresql.org/\n[py_test]: http://pytest.org/latest/\n[python]: https://www.python.org/\n", "description_content_type": null, "docs_url": null, "download_url": null, "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/tiredpixel/pikka-bird-server-py", "keywords": "ops monitoring sysadmin", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "pikka-bird-server", "package_url": "https://pypi.org/project/pikka-bird-server/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/pikka-bird-server/", "project_urls": { "Homepage": "https://github.com/tiredpixel/pikka-bird-server-py" }, "release_url": "https://pypi.org/project/pikka-bird-server/0.1.0/", "requires_dist": null, "requires_python": null, "summary": "Pikka Bird ops monitoring tool Server component.", "version": "0.1.0" }, "last_serial": 1521768, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "fd1e2ce1476e8792ac4fbbb4bb918a22", "sha256": "5a762f5589b72c5cdcfaf9790feab0aaf88be48f467af3af6e707c701608cb07" }, "downloads": -1, "filename": "pikka_bird_server-0.1.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "fd1e2ce1476e8792ac4fbbb4bb918a22", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16936, "upload_time": "2015-04-26T15:51:55", "url": "https://files.pythonhosted.org/packages/cf/6d/396db45731224ea0cfe6cb4664b5e6e9cd3065b567c8c5d2c339a5665d26/pikka_bird_server-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4ae24a106a1ce2378e954072e2456437", "sha256": "9fdb13ff6d22042331aeefbf8ed737f1398bc43b7c6098ed2679ddf514259af7" }, "downloads": -1, "filename": "pikka-bird-server-0.1.0.tar.gz", "has_sig": true, "md5_digest": "4ae24a106a1ce2378e954072e2456437", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12631, "upload_time": "2015-04-26T15:51:50", "url": "https://files.pythonhosted.org/packages/c4/5c/832edd838fc7121c2fc547a0363cf719c0e5f49310ee6284fd723b2d4b02/pikka-bird-server-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fd1e2ce1476e8792ac4fbbb4bb918a22", "sha256": "5a762f5589b72c5cdcfaf9790feab0aaf88be48f467af3af6e707c701608cb07" }, "downloads": -1, "filename": "pikka_bird_server-0.1.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "fd1e2ce1476e8792ac4fbbb4bb918a22", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16936, "upload_time": "2015-04-26T15:51:55", "url": "https://files.pythonhosted.org/packages/cf/6d/396db45731224ea0cfe6cb4664b5e6e9cd3065b567c8c5d2c339a5665d26/pikka_bird_server-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4ae24a106a1ce2378e954072e2456437", "sha256": "9fdb13ff6d22042331aeefbf8ed737f1398bc43b7c6098ed2679ddf514259af7" }, "downloads": -1, "filename": "pikka-bird-server-0.1.0.tar.gz", "has_sig": true, "md5_digest": "4ae24a106a1ce2378e954072e2456437", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12631, "upload_time": "2015-04-26T15:51:50", "url": "https://files.pythonhosted.org/packages/c4/5c/832edd838fc7121c2fc547a0363cf719c0e5f49310ee6284fd723b2d4b02/pikka-bird-server-0.1.0.tar.gz" } ] }