An extensible static site generator.
Project description
Pyndakaas
An extensible static site generator written in Python.
Features
- Extensible Handler System: Register custom file handlers for different content types
- Flexible Renderer System: Support for multiple rendering engines (Markdown, etc.)
- Template Support: Jinja2-based templating with metadata support
- File Metadata: JSON frontmatter parsing for rich content metadata
- Glob Matching: Template functions for filtering and selecting files
Installation
pip install pyndakaas
For development:
git clone https://github.com/rubenvannieuwpoort/pyndakaas
cd pyndakaas
pip install -e .
Quick Start
pyndakaas is meant to be used by calling process_dir with an input directory, output directory, and optionally a templates directory (if not provided, 'templates' is used). It uses Jinja templates. It is easiest to show how it works by example.
build.py:
import markdown
from pyndakaas import Handler, handler, process_dir
from pathlib import Path
@handler()
class Markdown(Handler):
@staticmethod
def should_handle(source_path: Path) -> bool:
return source_path.suffix == '.md'
def template(self) -> str:
return 'post'
def body(self) -> str:
return markdown.markdown(self.source)
# Using default 'templates' directory
process_dir(Path('src'), Path('build'))
src/posts/example.md:
{
"title": "This is the title of my first post"
}
# Hello, blog
I wanted to write a blog and `pyndakaas` makes it super easy!
src/index.html:
{
"title": "Welcome to my blog!",
"template": "index"
}
templates/post.jinja:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>{{front_matter.title}}</title>
</head>
<body>
{{body}}
</body>
</html>
templates/index.jinja:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>My blog</title>
</head>
<body>
<p>
My posts:
{% for post in root.glob('posts/*.md') %}
<ul>
<li><a href="{{post.output_path}}">{{ post.front_matter.title }}</a></li>
</ul>
{% endfor %}
</p>
</body>
</html>
Since version 0.3 it is also possible to process a single file:
process_file(Path('input/example.md'), Path('output'), Markdown)
Note that you specify the input file, but the output directory -- the base name of the input file will be used for the output file.
File Format
Source files use JSON frontmatter followed by content:
{
"title": "My Post",
"author": "John Doe",
"template": "custom-layout"
}
# My Content
This is the actual content that will be processed.
The template field in frontmatter will override the handler's default template specified in the template method of the handler.
Handlers
Handlers define how different file types are processed:
should_handle(): Static method to identify files this handler should processsuffix(): Method returning output file extension (defaults to '.html')body(): Method returning processed contenttemplate(): Method returning template name to use (or None to don't use a template and instead output the processed content)
Templates
Templates are Jinja2 files in the templates/ directory. They receive:
front_matter: Parsed JSON frontmatter from the source filebody: Processed content from the handler'sbody()methodfolder: Globber instance for filtering files relative to current fileroot: Globber instance for filtering files relative to the root of the input directory
License
MIT License - see LICENSE file for details.
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 pyndakaas-0.3.1.tar.gz.
File metadata
- Download URL: pyndakaas-0.3.1.tar.gz
- Upload date:
- Size: 5.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9cabaddfe8cd4c737e01e5b7e7a331a58f41bb2a801ef0593a53c3d966acc317
|
|
| MD5 |
661e7e98bbbf4c39ec1f23e3cc0ec9fd
|
|
| BLAKE2b-256 |
e703365334f546888340b875792531c27219443a40f78945256d00b98fcf45a1
|
File details
Details for the file pyndakaas-0.3.1-py3-none-any.whl.
File metadata
- Download URL: pyndakaas-0.3.1-py3-none-any.whl
- Upload date:
- Size: 6.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f0b62a2caf2fa04f3c7d314e360431602eebb75d636b8e214cd441ec31126b1
|
|
| MD5 |
71ec6140adaa564e7a829abbbb0e095e
|
|
| BLAKE2b-256 |
56cc4b2c730d6600fd3c8a23be5342a8fd2753c1005c5d239a47e845d23d55c9
|
