gresiblos 0.6.0

A simple private blogging system

gresiblos

Introduction

gresiblos is a simple blogging system written in Python. gresiblos generates static HTML pages from optionally annotated text, markdown, or HTML files. gresiblos is the acronym for greyrat's simple blog system.

gresiblos reads blog entries from files that may include some meta information and embeds the contents into a template. Optionally, in addition, it generates a json-file with meta information about the entries. gresiblos comes with a php-file that realises browsing, as well as with a php-file that generates rss and atom feeds.

Background

I wanted to have a blog and I wanted it to use static pages. That's why I wrote it. gresiblos has some additional features — like the inclusion of custom JavaScript and CSS files — I needed for my own blog.

Usage

Write your blog entries as text, markdown or HTML.

Then run gresiblos on it:

python src\gresiblos.py entry1.txt

… and it will convert it into a complete HTML page using the default template stored in ./data/.

You may as well add some meta data, storing the blog entry contents under the contents key:

state:release
title:My first blog entry
filename:my-first-blog-entry
author:Daniel Krajzewicz
date:26.12.2024 19:25
topics:blog,example
abstract:A very first introduction into blogging
content:
<b>Hello there!</b><br/>
This is my very first blog post!
===

All information starts with a key that is separated from the value by a ‘:’. Multi-line values start with a new line after the key and the ‘:’ and are closed with ‘===’. Please note that the content is kept as-is in the current version.

Again, when starting gresiblos, the meta information and the contents will be stored at marked places within the template.

gresiblos templates support placeholders that be filled by meta information, as well as optional fields.

You may find further information at the gresiblos documentation pages.

License

gresiblos is licensed under the BSD license.

Installing gresiblos

The current version is gresiblos-0.6.0.

You may install gresiblos using

python -m pip install gresiblos

You may download a copy or fork the code at gresiblos's github page.

Besides, you may download the current release here:

• gresiblos-0.6.0.zip
• gresiblos-0.6.0.tar.gz

Further Documentation

• A complete documentation is located at https://gresiblos.readthedocs.io/en/latest/
• Discussions are open at https://github.com/dkrajzew/gresiblos/discussions
• The github repository is located at: https://github.com/dkrajzew/gresiblos
• The issue tracker is located at: https://github.com/dkrajzew/gresiblos/issues
• The PyPI page is located at: https://pypi.org/project/gresiblos/

Status

gresiblos works as intended for me, but lacks quite some features of enterprise systems.

The next steps to release 1.0 will involve some refactorings, including API changes.

Please let me know if you have any idea / feature request / question / whatever or contribute to gresiblos…

Examples

gresiblos is used at the following pages:

• https://www.krajzewicz.de/blog/index.php: my own blog

ChangeLog

gresiblos-0.6.0 (to come)

• improving the documentation
• changed the license from GPLv3 to BSD
• changes:
  • important: the replacement pattern for values within the template changed from %<FIELD_NAME>% to [[:<FIELD_NAME>:]]
  • topics are stored as list in the index file
  • the filenames in the index now include the extension
  • the state attribute was removed from the index file
  • replaced option --have-php-index by the option --topic-format <FORMAT> which directly defines how each of a blog entries topics shall be rendered when embedding it into the template
  • removed options --default-author <NAME>, --default-copyright-date <DATE>, --default-state <STATE> and introduced replacements with defaults instead
• new
  • the indentation level of the index file can now be set using the option --index-indent <INT>
  • you may use a different format for the date in your entries than the ISO-format by defining it using --date-format <DATE_FORMAT>
  • added the possibility to skip document parts using the begin/end tags [[:?<FIELD_NAME>:]] and [[:<FIELD_NAME>?:]] if <FIELD_NAME> is not set

Older versions

You may find the complete change log at the gresiblos documentation pages.

Closing

Well, have fun. If you have any comments / ideas / issues, please submit them to gresiblos' issue tracker on github or drop me a mail.

Don't forget to spend a star!