DocHubProto class for creating www.lsst.io index
Project description
# dochub-prototype
DocHub prototype - www.lsst.io.generator
## Usage
```python
#/usr/bin/env python
from dochubproto import DocHubProto
p = DocHubProto()
ul = p.render()
```
## Environment
`DocHubProto` uses the following environment variables: `KEEPER_URL`,
`LOGLEVEL`, `TEMPLATE_DIR`, `TEMPLATE_NAME`, and
`MAX_DOCUMENT_DATA_AGE`. If those are not specified, the default values
are, respectively, `https://keeper.lsst.codes`, `WARNING`, `templates`
relative to the `dochubproto` module, `doclist.jinja2`, and `3600` (age is
expressed in seconds and must be convertible to a Python float).
## Methods
* `check_state()` returns one of `STATE_EMPTY`, `STATE_READY`,
`STATE_REFRESHING`, or `STATE_STALE`, which map to the strings
`empty`, `ready`, `refreshing`, or `stale`, respectively. A stale
document is one that has not been updated in more than the maximum
document data age as specified at instance initialization (see above,
default one hour).
* `get_document_data()` and `get_fresh_document_data()` return a `dict`
whose keys are document sections (e.g. `DMTN`) and within each
section, a list ordered by document handle (e.g. `dmtn-038`).
* `render()` returns an HTML unordered list entity created from the
document data.
* `debug()`, `info()`, `warning()`, `error()`, and `critical()` each
log a message at the specified level; it uses a `structlog` logger to
log JSON output via `apikit`.
DocHub prototype - www.lsst.io.generator
## Usage
```python
#/usr/bin/env python
from dochubproto import DocHubProto
p = DocHubProto()
ul = p.render()
```
## Environment
`DocHubProto` uses the following environment variables: `KEEPER_URL`,
`LOGLEVEL`, `TEMPLATE_DIR`, `TEMPLATE_NAME`, and
`MAX_DOCUMENT_DATA_AGE`. If those are not specified, the default values
are, respectively, `https://keeper.lsst.codes`, `WARNING`, `templates`
relative to the `dochubproto` module, `doclist.jinja2`, and `3600` (age is
expressed in seconds and must be convertible to a Python float).
## Methods
* `check_state()` returns one of `STATE_EMPTY`, `STATE_READY`,
`STATE_REFRESHING`, or `STATE_STALE`, which map to the strings
`empty`, `ready`, `refreshing`, or `stale`, respectively. A stale
document is one that has not been updated in more than the maximum
document data age as specified at instance initialization (see above,
default one hour).
* `get_document_data()` and `get_fresh_document_data()` return a `dict`
whose keys are document sections (e.g. `DMTN`) and within each
section, a list ordered by document handle (e.g. `dmtn-038`).
* `render()` returns an HTML unordered list entity created from the
document data.
* `debug()`, `info()`, `warning()`, `error()`, and `critical()` each
log a message at the specified level; it uses a `structlog` logger to
log JSON output via `apikit`.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sqre_dochub_proto-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eab17e0c112d2f9adbd32b21d0f5cd82b12df6f7deba0e97e8c3716afc2bbd97 |
|
MD5 | 20af00fe3e8a9436cea562cafc486427 |
|
BLAKE2b-256 | 7f4d722a64599f001e5e9336bebac11ad8a8efabf77e710f41206ffd803721f5 |