Skip to main content

KBlight - Knowledge Base Light

A Python package that generates a static web application from your Obsidian vault notes. It is aimed at researchers in Digital Humanities wishing to publish their research in a sustaible, yet FAIR compatible manner.

Installation

The package is available via pip

pip install kblight

or via uv

uv add kblight

Projects using KBLight

Setting up your local knowledge base

The package transforms a local directory of Markdown files, with corresponding YAML metadata, into an elegant static website knowledge base that can be easily hosted on GitHub Pages or similar services for long-term longevity, without the need of costly infrastructures required by many softwares such as Wikibase.

We advise you to use Obsidian in order to create your interconnected Markdown files for your entities, but you are free to use any other softwares, even text editors or creating your own scripts in order to programmatically generate them.

The YAML metadata supports nested properties, similar to Wikidata qualifiers and references, that can be made manually or with the support of Metadata Menu Obsidian plugin.

Features

  • Static website is effortless built from Markdown pages via Mkdocs Material.
  • Simple search features and indexing at built using Lunr.js.
  • Custom Javascript advanced search feature, with filters based on properties, timestamps and classes.
  • Unique identifiers are assigned to each entity, according to the UUID standards via a truncated short identifier.
  • Custom Jinja2 templates in order to generate Markdown pages for each entity according to their class.
  • Serialization of data in a variety of format, such as JSON, YAML, RDF Turtle and JSON-LD and CSV.
  • Graph visualization of statements via D3.js.
  • Integrate digital assets via IIIF manifests or simple URLs rendered via OpenSeadragon.
  • TEI visualization via CETEIcean (still in development).
  • MEI visualization of music scores via Verovio (still in development).

Download files

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

Source Distribution

kblight-0.1.0.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kblight-0.1.0-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

File details

Details for the file kblight-0.1.0.tar.gz.

File metadata

  • Download URL: kblight-0.1.0.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kblight-0.1.0.tar.gz
Algorithm Hash digest
SHA256 adf669a6b17ab03846e4dcd4c6a596f6ecc408d87f5726533a5260d8b9d0c727
MD5 d2fe86c3e13a1db1986bfacf83fab994
BLAKE2b-256 b635b17eef382d7ff7d59217fd1d214ddd5dfcd9519eb4414e8fcb7a1e767e5b

See more details on using hashes here.

Provenance

The following attestation bundles were made for kblight-0.1.0.tar.gz:

Publisher: release.yml on NicholasCorniaOrpheus/kb-light

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kblight-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: kblight-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 24.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kblight-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 101a899126ae189948a41b8d6bcb2146d904886de623e7410782b1a128369915
MD5 238ec489c9d3df23dc75b55aae09830e
BLAKE2b-256 af5d98ee0f1b69eb2cf8398ee0d4cfb9747249ae47d2865eda636aebca378af1

See more details on using hashes here.

Provenance

The following attestation bundles were made for kblight-0.1.0-py3-none-any.whl:

Publisher: release.yml on NicholasCorniaOrpheus/kb-light

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page