Welcome to Article Generator

Release

Date

Apr 29, 2020

Welcome to the Article Generator documentation.

Article Generator is a tool that creates article stubs for blog posts written in Pelican. Yes, Article Generator is a terrible name.

Use Cases

Use Case 1:

I want to write a new blog post for my Pelican based web-site. In the past, I’ve kept a blank article saved on my hard drive. When I write a new article, I take the blank template, change the metadata, write the article and then do a “File: Save As” to save the new article. That’s not too tough, but being a bonehead, I often overwrite my blank article with the new filled in article, or I save it to the wrong folder, or I get the date wrong, you get the idea.

Use Case 2:

If you have additional authors that are writing articles for your web site, they may not be highly technical folks that want to deal with the intricacies of Pelican. In this case, you can set up a folder named “content” with some sub-folders with the categories for these authors. They can then use the Article Generator application to put together the article stub. This allows them to get get started with writing without a lot of technical set up.

Article Generator can help with these situations. It generates your empty article templates for you and takes care of some of the minor housekeeping.

I’m afraid, I’ll be getting more out of Article Generator than anyone that may stumble upon it and use it. Here’s all the learning that’s in it for me:

  • Write a complete application (Python)

  • Build the user interface (PySimpleGUI)

  • Write the accompanying documentation (Sphinx)

  • Build tests to go with the application (Pytest)

  • Release it as open source (Github)

  • Gain an understanding of the entire work flow

Indices and tables