{ "info": { "author": "Adam Thornton", "author_email": "athornton@lsst.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5" ], "description": "# dochub-prototype\nDocHub prototype - www.lsst.io.generator\n\n## Usage\n\n```python\n#/usr/bin/env python\nfrom dochubproto import DocHubProto\n\np = DocHubProto()\nidx = p.render_index()\n```\n\n## Environment\n\n`DocHubProto` uses the following environment variables: `KEEPER_URL`,\n`LOGLEVEL`, `TEMPLATE_DIR`, `UL_TEMPLATE_NAME`, `IDX_TEMPLATE_NAME`, and\n`MAX_DOCUMENT_DATA_AGE`. If those are not specified, the default values\nare, respectively, `https://keeper.lsst.codes`, `WARNING`, `templates`\nrelative to the `dochubproto` module, `doclist.jinja2`, `index.jinja2`,\nand `3600` (age is expressed in seconds and must be convertible to a\nPython float).\n\n## Methods\n\n* `check_state()` returns one of `STATE_EMPTY`, `STATE_READY`,\n `STATE_REFRESHING`, or `STATE_STALE`, which map to the strings\n `empty`, `ready`, `refreshing`, or `stale`, respectively. A stale\n document is one that has not been updated in more than the maximum\n document data age as specified at instance initialization (see above,\n default one hour).\n\n* `get_document_data()` and `get_fresh_document_data()` return a `dict`\n whose keys are document sections (e.g. `DMTN`) and within each\n section, a list ordered by document handle (e.g. `dmtn-038`).\n\n* `render()` returns an HTML unordered list entity created from the\n document data, encoded as UTF-8. `render_index()` returns an HTML\n document created from the document data, encoded as UTF-8.\n\n* `debug()`, `info()`, `warning()`, `error()`, and `critical()` each\n log a message at the specified level; it uses a `structlog` logger to\n log JSON output via `apikit`.\n\n\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/sqre-lsst/dochub-prototype", "keywords": "lsst", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sqre-dochub-proto", "package_url": "https://pypi.org/project/sqre-dochub-proto/", "platform": "", "project_url": "https://pypi.org/project/sqre-dochub-proto/", "project_urls": { "Homepage": "https://github.com/sqre-lsst/dochub-prototype" }, "release_url": "https://pypi.org/project/sqre-dochub-proto/0.0.2/", "requires_dist": [ "Jinja2 (<3.0.0,>=2.9)", "pyyaml (<4.0.0,>=3.12)", "requests (<3.0.0,>=2.13.0)", "sqre-apikit (>=0.1.1,<1.0.0)" ], "requires_python": "", "summary": "DocHubProto class for creating www.lsst.io index", "version": "0.0.2" }, "last_serial": 2721537, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "20af00fe3e8a9436cea562cafc486427", "sha256": "eab17e0c112d2f9adbd32b21d0f5cd82b12df6f7deba0e97e8c3716afc2bbd97" }, "downloads": -1, "filename": "sqre_dochub_proto-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "20af00fe3e8a9436cea562cafc486427", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8759, "upload_time": "2017-03-17T23:13:28", "url": "https://files.pythonhosted.org/packages/7f/4d/722a64599f001e5e9336bebac11ad8a8efabf77e710f41206ffd803721f5/sqre_dochub_proto-0.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d1f1c97c341da59749db2a82f2a06c02", "sha256": "a1aa28b4b8730416e587f1e8ef1b674aea262c1d2a16e730a1eb90b0e0ae17fc" }, "downloads": -1, "filename": "sqre-dochub-proto-0.0.1.tar.gz", "has_sig": false, "md5_digest": "d1f1c97c341da59749db2a82f2a06c02", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6818, "upload_time": "2017-03-17T23:13:30", "url": "https://files.pythonhosted.org/packages/21/11/b038013f940797bc8edf53519626fa4e7927abc3cc8f7d98b14c1562e0b0/sqre-dochub-proto-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "c1e3d39b96f6e1ad8074032e00670eaf", "sha256": "7503f8e9071a84fb34a0b180c1f7c44770cc5e1d5a63e56fa1192f58f581e927" }, "downloads": -1, "filename": "sqre_dochub_proto-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c1e3d39b96f6e1ad8074032e00670eaf", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13723, "upload_time": "2017-03-21T19:32:39", "url": "https://files.pythonhosted.org/packages/02/4c/b73cf3930bbc030e433f691156630a62fb95b5bbda5f3e0e9e332d42e39f/sqre_dochub_proto-0.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "73280f2dd1926cec71d8deffd1acc384", "sha256": "212e8b40c180ec281469cfe9b9ff33cdf5b884d5b1a4a1b2deb0fa8d0ea2d0a7" }, "downloads": -1, "filename": "sqre-dochub-proto-0.0.2.tar.gz", "has_sig": false, "md5_digest": "73280f2dd1926cec71d8deffd1acc384", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11129, "upload_time": "2017-03-21T19:32:41", "url": "https://files.pythonhosted.org/packages/be/6c/22ad3f3ac44ce9dc1ccf3a5ac0d3d15a9cd06d22451da0187d9326fd3f01/sqre-dochub-proto-0.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c1e3d39b96f6e1ad8074032e00670eaf", "sha256": "7503f8e9071a84fb34a0b180c1f7c44770cc5e1d5a63e56fa1192f58f581e927" }, "downloads": -1, "filename": "sqre_dochub_proto-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c1e3d39b96f6e1ad8074032e00670eaf", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13723, "upload_time": "2017-03-21T19:32:39", "url": "https://files.pythonhosted.org/packages/02/4c/b73cf3930bbc030e433f691156630a62fb95b5bbda5f3e0e9e332d42e39f/sqre_dochub_proto-0.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "73280f2dd1926cec71d8deffd1acc384", "sha256": "212e8b40c180ec281469cfe9b9ff33cdf5b884d5b1a4a1b2deb0fa8d0ea2d0a7" }, "downloads": -1, "filename": "sqre-dochub-proto-0.0.2.tar.gz", "has_sig": false, "md5_digest": "73280f2dd1926cec71d8deffd1acc384", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11129, "upload_time": "2017-03-21T19:32:41", "url": "https://files.pythonhosted.org/packages/be/6c/22ad3f3ac44ce9dc1ccf3a5ac0d3d15a9cd06d22451da0187d9326fd3f01/sqre-dochub-proto-0.0.2.tar.gz" } ] }