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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
adf669a6b17ab03846e4dcd4c6a596f6ecc408d87f5726533a5260d8b9d0c727
|
|
| MD5 |
d2fe86c3e13a1db1986bfacf83fab994
|
|
| BLAKE2b-256 |
b635b17eef382d7ff7d59217fd1d214ddd5dfcd9519eb4414e8fcb7a1e767e5b
|
Provenance
The following attestation bundles were made for kblight-0.1.0.tar.gz:
Publisher:
release.yml on NicholasCorniaOrpheus/kb-light
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
kblight-0.1.0.tar.gz -
Subject digest:
adf669a6b17ab03846e4dcd4c6a596f6ecc408d87f5726533a5260d8b9d0c727 - Sigstore transparency entry: 2614266026
- Sigstore integration time:
-
Permalink:
NicholasCorniaOrpheus/kb-light@eb077b321283262718fd38714d37f4b48a2420ec -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/NicholasCorniaOrpheus
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@eb077b321283262718fd38714d37f4b48a2420ec -
Trigger Event:
release
-
Statement type:
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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
101a899126ae189948a41b8d6bcb2146d904886de623e7410782b1a128369915
|
|
| MD5 |
238ec489c9d3df23dc75b55aae09830e
|
|
| BLAKE2b-256 |
af5d98ee0f1b69eb2cf8398ee0d4cfb9747249ae47d2865eda636aebca378af1
|
Provenance
The following attestation bundles were made for kblight-0.1.0-py3-none-any.whl:
Publisher:
release.yml on NicholasCorniaOrpheus/kb-light
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
kblight-0.1.0-py3-none-any.whl -
Subject digest:
101a899126ae189948a41b8d6bcb2146d904886de623e7410782b1a128369915 - Sigstore transparency entry: 2614266368
- Sigstore integration time:
-
Permalink:
NicholasCorniaOrpheus/kb-light@eb077b321283262718fd38714d37f4b48a2420ec -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/NicholasCorniaOrpheus
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@eb077b321283262718fd38714d37f4b48a2420ec -
Trigger Event:
release
-
Statement type: