{ "info": { "author": "hbc", "author_email": "bcxxxxxx@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3" ], "description": "# Check\n\n[![Build Status](https://travis-ci.org/bcho/check.svg)](https://travis-ci.org/bcho/check)\n\nCheck your server like a boss.\n\n\n\n## Usage\n\n```bash\n$ check -c config.json\n```\n\n\n## Config.json\n\n```json\n{\n \"in_charge\": [\n {\n \"name\": \"Travis Bickle\",\n \"email\": \"travis.bickle@example.com\"\n },\n {\n \"name\": \"Besty\",\n \"email\": \"besty@example.com\"\n }\n ],\n \"reporters\": {\n \"email\": {\n \"crendential\": {\n \"username\": \"watchmen@example.com\",\n \"password\": \"watchmen-passw0rd\",\n \"smtp\": \"smtp.example.com:587\"\n },\n \"formats\": {\n \"short\": \"Site {site['name']} is down!\",\n \"long\": \"Your site {site['name']} is down since {happened_at}!\"\n }\n },\n \"cli\": {\n \"formats\": {\n \"short\": \"Site {site['name']} is down!\",\n \"long\": \"Check time: {happened_at}\"\n }\n }\n },\n \"sites\": [\n {\n \"name\": \"My Cool Site\",\n \"url\": \"http://cool.example.com\"\n },\n {\n \"name\": \"Goole is Down\",\n \"url\": \"https://google.com\"\n }\n ]\n}\n```\n\n### `in_charge`\n\nSpecify list of people you want to notify when a incident happened here.\n\n##### Fields:\n\n| name | description | required? |\n|:------:|:-------------:|:-----------:|\n| name | alias name | yes |\n| email | receiver's email address | no |\n\n- `email`: If user's `email` is provided, they will receive a warning email for the incident.\n\n\n### `reporters`\n\nEnabled report generators. Each generator can customize the `incident report` format.\n\n\n##### Report Format Fields\n\n| name | description | required? |\n|:------:|:-------------:|:-----------:|\n| short | summarize report | yes |\n| long | detailed report | yes |\n\nEach `incident report` will contain:\n\n- site name\n- site url\n- incident happened time string, format is [ISO8601][iso8601].\n\n```python\nincident_report = {\n 'site': {\n 'name': 'test',\n 'url': 'http://test.domain'\n },\n 'happened_at': '2014-11-01T15:42:00.000000+00:00'\n}\n```\n\n\n[iso8601]: http://en.wikipedia.org/wiki/ISO_8601\n\n#### Email Handler\n\nIf you want to use email handler, you should provide email sender's crendential\nsettings.\n\n##### Fields:\n\n| name | description | required? |\n|:------:|:-------------:|:-----------:|\n| username | login name | yes |\n| password | login password | yes |\n| smtp | smtp server | yes |\n\n\n### `sites`\n\nList of sites you want to monitor.\n\n##### Fields:\n\n| name | description | required? |\n|:------:|:-------------:|:-----------:|\n| url | site's url | yes |\n| name | alias name | no, defaults to `url`|\n\n\n## TODO\n\n- [ ] refine data structure.\n- [ ] add more check methods (like ping).\n\n\n## LICENSE\n\nSee [LICENSE.md](LICENSE.md).\n\n# Changelog\n\n## 0.1 \u5c0f\u5149\u68cd\u8282 Mr. Single, Jr. (2014/11/1)\n\n- Initial version.", "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/bcho/check", "keywords": null, "license": "SMPPL", "maintainer": null, "maintainer_email": null, "name": "check", "package_url": "https://pypi.org/project/check/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/check/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/bcho/check" }, "release_url": "https://pypi.org/project/check/0.1/", "requires_dist": null, "requires_python": null, "summary": "Check your server like a boss.", "version": "0.1" }, "last_serial": 1290938, "releases": { "0.1": [] }, "urls": [] }