https://github.com/MinchinWeb/minchin.pelican.plugins.post_stats

A Pelican plugin which calculates various statistics about a post and store them in an article.stats dictionary.
https://github.com/MinchinWeb/minchin.pelican.plugins.post_stats

pelican pelican-plugins

Last synced: about 2 months ago
JSON representation

A Pelican plugin which calculates various statistics about a post and store them in an article.stats dictionary.

• Host: GitHub
• URL: https://github.com/MinchinWeb/minchin.pelican.plugins.post_stats
• Owner: MinchinWeb
• License: agpl-3.0
• Created: 2017-02-22T04:07:44.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-08-09T20:47:23.000Z (over 1 year ago)
• Last Synced: 2024-07-12T13:28:27.475Z (7 months ago)
• Topics: pelican, pelican-plugins
• Language: Python
• Homepage:
• Size: 32.2 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome - MinchinWeb/minchin.pelican.plugins.post_stats - A Pelican plugin which calculates various statistics about a post and store them in an article.stats dictionary. (Python)

README

        
===============

Post Statistics

===============

``Post Stats`` is a plugin for `Pelican `_,

a static site generator written in Python.

``Post Stats`` calculates various statistics about a post and store them in

an article.stats dictionary:

- ``wc``: how many words

- ``read_mins``: how many minutes would it take to read this article, based

  on 250 wpm

  (`source `_)

- ``word_counts``: frquency count of all the words in the article; can be

  used for tag/word clouds

- ``fi``: Flesch-Kincaid Index/Reading Ease

  (`more info `_)

- ``fk``: Flesch-Kincaid Grade Level

.. image:: https://img.shields.io/pypi/v/minchin.pelican.plugins.post-stats.svg?style=flat

    :target: https://pypi.python.org/pypi/minchin.pelican.plugins.post-stats/

    :alt: PyPI version number

.. image:: https://img.shields.io/badge/-Changelog-success

   :target: https://github.com/MinchinWeb/minchin.pelican.plugins.post_stats/blob/master/CHANGELOG.rst

   :alt: Changelog

.. image:: https://img.shields.io/pypi/pyversions/minchin.pelican.plugins.post-stats?style=flat

    :target: https://pypi.python.org/pypi/minchin.pelican.plugins.post-stats/

    :alt: Supported Python version

.. image:: https://img.shields.io/pypi/l/minchin.pelican.plugins.post-stats.svg?style=flat&color=green

    :target: https://github.com/MinchinWeb/minchin.pelican.plugins.post_stats/blob/master/LICENSE.txt

    :alt: License

.. image:: https://img.shields.io/pypi/dm/minchin.pelican.plugins.post-stats.svg?style=flat

    :target: https://pypi.python.org/pypi/minchin.pelican.plugins.post-stats/

    :alt: Download Count

Installation

============

The easiest way to install ``Post Stats`` is through the use of pip. This

will also install the required dependencies automatically.

.. code-block:: sh

  pip install minchin.pelican.plugins.post_stats

On Pelican versions 4.5 and later, the plugin will automatically activate

itself!

You may also need to configure your template to make use of the statistics

generated.

Requirements

============

``Post Stats`` depends on (and is really only useful with) Pelican. The

plugin also requries Beautiful Soup 4 to process your content. If the plugin

is installed from pip, these will automatically be installed. These can also

be manually installed with pip:

.. code-block:: sh

   pip install pelican

   pip install beautifulsoup4

Configuration and Usage

=======================

This plugin calculates various statistics about a post and store them in

an article.stats dictionary.

Example:

.. code-block:: python

    {

        'wc': 2760,

        'fi': '65.94',

        'fk': '7.65',

        'word_counts': Counter({u'to': 98, u'a': 90, u'the': 83, u'of': 50, ...}),

        'read_mins': 12

    }

This allows you to output these values in your templates, like this, for

example:

.. code-block:: html+jinja

	
~{{ article.stats['read_mins'] }} min read

	


	    
Flesch-kincaid Index/ Reading Ease: {{ article.stats['fi'] }}

	    
Flesch-kincaid Grade Level: {{ article.stats['fk'] }}

	


The ``word_counts`` variable is a python ``Counter`` dictionary and looks

something like this, with each unique word and it's frequency:

.. code-block:: python

	Counter({u'to': 98, u'a': 90, u'the': 83, u'of': 50, u'karma': 50, .....

and can be used to create a tag/word cloud for a post.

There are no user-configurable settings.

Credits

=======

`Original plugin `_

by Duncan Lock (`@dflock `_) and

posted to the `Pelican-Plugins repo

`_.

License

=======

The plugin code is assumed to be under the AGPLv3 license (this is the

license of the Pelican-Plugins repo).