Skip to main content

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()
idx = p.render_index()
```

## Environment

`DocHubProto` uses the following environment variables: `KEEPER_URL`,
`LOGLEVEL`, `TEMPLATE_DIR`, `UL_TEMPLATE_NAME`, `IDX_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`, `index.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, encoded as UTF-8. `render_index()` returns an HTML
document created from the document data, encoded as UTF-8.

* `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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqre-dochub-proto-0.0.2.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

sqre_dochub_proto-0.0.2-py2.py3-none-any.whl (13.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sqre-dochub-proto-0.0.2.tar.gz.

File metadata

File hashes

Hashes for sqre-dochub-proto-0.0.2.tar.gz
Algorithm Hash digest
SHA256 212e8b40c180ec281469cfe9b9ff33cdf5b884d5b1a4a1b2deb0fa8d0ea2d0a7
MD5 73280f2dd1926cec71d8deffd1acc384
BLAKE2b-256 be6c22ad3f3ac44ce9dc1ccf3a5ac0d3d15a9cd06d22451da0187d9326fd3f01

See more details on using hashes here.

File details

Details for the file sqre_dochub_proto-0.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sqre_dochub_proto-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7503f8e9071a84fb34a0b180c1f7c44770cc5e1d5a63e56fa1192f58f581e927
MD5 c1e3d39b96f6e1ad8074032e00670eaf
BLAKE2b-256 024cb73cf3930bbc030e433f691156630a62fb95b5bbda5f3e0e9e332d42e39f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page