SPUK (Static PUblisher of Knowledge)

Description

SPUK is a Static Site Generator (SSG) designed for RDF Knowledge Graphs. It transforms RDF data into a browsable, static HTML website.

Live Demo

https://sbrzt.github.io/spuk/

Installation

1. Create a virtual environment to manage the project's dependencies:

   TODO

2. Activate the virtual environment:

   • On Windows:

     .\.venv\Scripts\activate
     

   • On macOS and Linux:

     source .venv/bin/activate
     

3. Install the required dependencies:

   TODO
   

Usage

SPUK generates static HTML pages from an RDF Knowledge Graph (KG), allowing users to explore the data through a web browser.

Start the site

TODO

Examples

TODO

Testing

TODO

---

🚧 Roadmap

🧠 Entity Pages

• Integrate graph visualization
• Show directed property relationships
• Display subject–property triples

📂 Indexes & Listings

• Implement pagination
  • Optimize pagination
  • Clean entities.html once dev server works
• Implement search functionality
• Improve entity listing layout
• Enhance data visualizations:
  • Add literal components (datatypes and languages)
  • Add subject RDF node types
  • Add object RDF node types
  • Add combined node types
  • Add IRI lengths
  • Add literal lengths
  • Add most referenced subjects?
  • Add most referenced objects?
  • Add chart type generalisation
  • Add download option
  • Add visible values without hover
  • Test: Define personalized data stats via config file
  • Test: Define personalized data charts via config file
• Consider listing entity properties

📚 Documentation

• Add optional documentation pages
  • Add markdown support
• Improve internal documentation:
  • Add docstrings
  • Add README files

🔍 Query Interface

• Create query page
• Allow SPARQL query presets via config file

⚙️ General Improvements

• Reengineer codebase structure
• Introduce centralized config file
• Delete /docs/ directory at generation
• Solve problem with /docs/data/ not regenerated after a change
• Improve developer experience:
  • Add dev server with file watching & caching
  • Avoid full rebuild at each change
  • Enable auto-reload on changes
  • Add dev-specific config parameters
• Redesign footer
• Consider adding API support for advanced use cases
• Add CITATION.cff

Author

Barzaghi, Sebastian (https://orcid.org/0000-0002-0799-1527).

Citation

@software{barzaghi_spuk_2025,
  author       = {Sebastian B.},
  title        = {SPUK: v0.1.0},
  month        = may,
  year         = 2025,
  publisher    = {Zenodo},
  version      = {v0.1.0},
  doi          = {10.5281/zenodo.15389756},
  url          = {https://doi.org/10.5281/zenodo.15389756},
  swhid        = {swh:1:dir:13091e52df66e92690aa1f7d9beac02b0d5acaa4
                   ;origin=https://doi.org/10.5281/zenodo.15389755;vi
                   sit=swh:1:snp:26950210a2176283cdda0ea18c9fda2e0318
                   d697;anchor=swh:1:rel:3303c580deefd97c6b78c48c438e
                   ead829256a51;path=sbrzt-spuk-a7d3250
                  },
}