==========
AutoLoader
==========
``AutoLoader`` is a plugin for `Pelican <http://docs.getpelican.com/>`_,
a static site generator written in Python.
``AutoLoader`` is designed to autoload the other Pelican plugins in my
namespaces (``minchin.pelican.plugins`` and ``minchin.pelican.readers``).
It can also be extended to autoload
plugins in other namespaces, for example, to autoload the ``pelican.plugins``
namespace on versions of Pelican before 4.5 (when autoloading to those plugins
was added to the Pelican core).
.. image:: https://img.shields.io/pypi/v/minchin.pelican.plugins.autoloader.svg?style=flat
:target: https://pypi.python.org/pypi/minchin.pelican.plugins.autoloader
:alt: PyPI version number
.. image:: https://img.shields.io/badge/-Changelog-success?style=flat
:target: https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader/blob/master/CHANGELOG.rst
:alt: Changelog
.. image:: https://img.shields.io/pypi/pyversions/minchin.pelican.plugins.autoloader?style=flat
:target: https://pypi.python.org/pypi/minchin.pelican.plugins.autoloader/
:alt: Supported Python version
.. image:: https://img.shields.io/pypi/l/minchin.pelican.plugins.autoloader.svg?style=flat&color=green
:target: https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader/blob/master/LICENSE.txt
:alt: License
.. image:: https://img.shields.io/pypi/dm/minchin.pelican.plugins.autoloader.svg?style=flat
:target: https://pypi.python.org/pypi/minchin.pelican.plugins.autoloader/
:alt: Download Count
Installation
============
The easiest way to install ``AutoLoader`` is through the use of pip. This
will also install the required dependencies automatically.
.. code-block:: sh
pip install minchin.pelican.plugins.autoloader
Further configuration will depend on the version of Pelican you are running. On
version 4.5 or newer and you haven't defined ``PLUGINS`` in your
``pelicanconf.py``, nothing more in needed. On earlier versions of Pelican, or
if you've defined ``PLUGINS``, you'll need to add the autoloader to your list
of plugins in your ``pelicanconf.py`` file:
.. code-block:: python
# pelicanconf.py
PLUGINS = [
# ...
'minchin.pelican.plugins.autoloader',
# ...
]
If you want to auto-load additional namespaces, you'll need to define the
``AUTOLOADER_NAMESPACES`` variable in your ``pelicanconf.py`` file:
.. code-block:: python
# pelicanconf.py
from minchin.pelican.plugins import autoloader
AUTOLOADER_NAMESPACES = autoloader.DEFAULT_NAMESPACE_LIST + [
"pelican.plugins",
# other namespaces
]
If you need to disallow auto-loading of certain plugins, you'll need to define
the ``AUTOLOADER_PLUGIN_BLACKLIST`` variable in your ``pelicanconf.py`` file.
This only works when autoloading from defined namespaces. E.g.:
.. code-block:: python
# pelicanconf.py
from minchin.pelican.plugins import autoloader
AUTOLOADER_PLUGIN_BLACKLIST = autoloader.DEFAULT_PLUGIN_BLACKLIST + [
"pelican.plugins.misbehaving_plugin",
# other plugins
]
Usage Notes
===========
- the plugins loaded by this plugin will not be shown when you run
``pelican-plugins``
Raw data
{
"_id": null,
"home_page": null,
"name": "minchin.pelican.plugins.autoloader",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "William Minchin <w_minchin@hotmail.com>",
"keywords": null,
"author": null,
"author_email": "William Minchin <w_minchin@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4f/bb/0365228e6f67238ae3a2fc5a07eda21c70c39e7473c251c46965519b79ff/minchin_pelican_plugins_autoloader-1.2.2.tar.gz",
"platform": null,
"description": "==========\r\nAutoLoader\r\n==========\r\n\r\n``AutoLoader`` is a plugin for `Pelican <http://docs.getpelican.com/>`_,\r\na static site generator written in Python.\r\n\r\n``AutoLoader`` is designed to autoload the other Pelican plugins in my\r\nnamespaces (``minchin.pelican.plugins`` and ``minchin.pelican.readers``).\r\nIt can also be extended to autoload\r\nplugins in other namespaces, for example, to autoload the ``pelican.plugins``\r\nnamespace on versions of Pelican before 4.5 (when autoloading to those plugins\r\nwas added to the Pelican core).\r\n\r\n.. image:: https://img.shields.io/pypi/v/minchin.pelican.plugins.autoloader.svg?style=flat\r\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.autoloader\r\n :alt: PyPI version number\r\n\r\n.. image:: https://img.shields.io/badge/-Changelog-success?style=flat\r\n :target: https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader/blob/master/CHANGELOG.rst\r\n :alt: Changelog\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/minchin.pelican.plugins.autoloader?style=flat\r\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.autoloader/\r\n :alt: Supported Python version\r\n\r\n.. image:: https://img.shields.io/pypi/l/minchin.pelican.plugins.autoloader.svg?style=flat&color=green\r\n :target: https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader/blob/master/LICENSE.txt\r\n :alt: License\r\n\r\n.. image:: https://img.shields.io/pypi/dm/minchin.pelican.plugins.autoloader.svg?style=flat\r\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.autoloader/\r\n :alt: Download Count\r\n\r\n\r\nInstallation\r\n============\r\n\r\nThe easiest way to install ``AutoLoader`` is through the use of pip. This\r\nwill also install the required dependencies automatically.\r\n\r\n.. code-block:: sh\r\n\r\n pip install minchin.pelican.plugins.autoloader\r\n\r\nFurther configuration will depend on the version of Pelican you are running. On\r\nversion 4.5 or newer and you haven't defined ``PLUGINS`` in your\r\n``pelicanconf.py``, nothing more in needed. On earlier versions of Pelican, or\r\nif you've defined ``PLUGINS``, you'll need to add the autoloader to your list\r\nof plugins in your ``pelicanconf.py`` file:\r\n\r\n.. code-block:: python\r\n\r\n # pelicanconf.py\r\n\r\n PLUGINS = [\r\n # ...\r\n 'minchin.pelican.plugins.autoloader',\r\n # ...\r\n ]\r\n\r\nIf you want to auto-load additional namespaces, you'll need to define the\r\n``AUTOLOADER_NAMESPACES`` variable in your ``pelicanconf.py`` file:\r\n\r\n.. code-block:: python\r\n\r\n # pelicanconf.py\r\n\r\n from minchin.pelican.plugins import autoloader\r\n\r\n AUTOLOADER_NAMESPACES = autoloader.DEFAULT_NAMESPACE_LIST + [\r\n \"pelican.plugins\",\r\n # other namespaces\r\n ]\r\n\r\nIf you need to disallow auto-loading of certain plugins, you'll need to define\r\nthe ``AUTOLOADER_PLUGIN_BLACKLIST`` variable in your ``pelicanconf.py`` file.\r\nThis only works when autoloading from defined namespaces. E.g.:\r\n\r\n.. code-block:: python\r\n\r\n # pelicanconf.py\r\n\r\n from minchin.pelican.plugins import autoloader\r\n\r\n AUTOLOADER_PLUGIN_BLACKLIST = autoloader.DEFAULT_PLUGIN_BLACKLIST + [\r\n \"pelican.plugins.misbehaving_plugin\",\r\n # other plugins\r\n ]\r\n\r\nUsage Notes\r\n===========\r\n\r\n- the plugins loaded by this plugin will not be shown when you run\r\n ``pelican-plugins``\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Pelican plugin, used to auto-load my other plugins.",
"version": "1.2.2",
"project_urls": {
"Bug Tracker": "https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader/issues",
"Changelog": "https://github.com/minchinweb/minchin.pelican.plugins.autoloader/blob/master/CHANGELOG.rst",
"Repository": "https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ea2414b8b96bf144d683a07f98f71251f71e0e0950ae002784c05c05fa3998d3",
"md5": "46c77897e0456270b4a887a6b397e2a4",
"sha256": "8cb868b464732af5699c58a6556795b3f56ff641f6ee568eebdc4da4ea807948"
},
"downloads": -1,
"filename": "minchin_pelican_plugins_autoloader-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46c77897e0456270b4a887a6b397e2a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5582,
"upload_time": "2025-10-25T01:29:38",
"upload_time_iso_8601": "2025-10-25T01:29:38.070396Z",
"url": "https://files.pythonhosted.org/packages/ea/24/14b8b96bf144d683a07f98f71251f71e0e0950ae002784c05c05fa3998d3/minchin_pelican_plugins_autoloader-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4fbb0365228e6f67238ae3a2fc5a07eda21c70c39e7473c251c46965519b79ff",
"md5": "f7a0f99a3c98dda1a1a22300b55d1412",
"sha256": "1a7ed7e54e4e8b859b7a1a1fc986a2f54e4cd20659d2d5bf99c6157bd783366e"
},
"downloads": -1,
"filename": "minchin_pelican_plugins_autoloader-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "f7a0f99a3c98dda1a1a22300b55d1412",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7278,
"upload_time": "2025-10-25T01:27:54",
"upload_time_iso_8601": "2025-10-25T01:27:54.689514Z",
"url": "https://files.pythonhosted.org/packages/4f/bb/0365228e6f67238ae3a2fc5a07eda21c70c39e7473c251c46965519b79ff/minchin_pelican_plugins_autoloader-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-25 01:27:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MinchinWeb",
"github_project": "minchin.pelican.plugins.autoloader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "anyio",
"specs": [
[
"==",
"4.11.0"
]
]
},
{
"name": "blinker",
"specs": [
[
"==",
"1.9.0"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.22.2"
]
]
},
{
"name": "feedgenerator",
"specs": [
[
"==",
"2.2.1"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.11"
]
]
},
{
"name": "jinja2",
"specs": [
[
"==",
"3.1.6"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"4.0.0"
]
]
},
{
"name": "markupsafe",
"specs": [
[
"==",
"3.0.3"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "ordered-set",
"specs": [
[
"==",
"4.1.0"
]
]
},
{
"name": "pelican",
"specs": [
[
"==",
"4.11.0"
]
]
},
{
"name": "pygments",
"specs": [
[
"==",
"2.18.0"
]
]
},
{
"name": "python-dateutil",
"specs": [
[
"==",
"2.9.0.post0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"14.2.0"
]
]
},
{
"name": "semantic-version",
"specs": [
[
"==",
"2.10.0"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.17.0"
]
]
},
{
"name": "sniffio",
"specs": [
[
"==",
"1.3.1"
]
]
},
{
"name": "tzdata",
"specs": [
[
"==",
"2025.2"
]
]
},
{
"name": "unidecode",
"specs": [
[
"==",
"1.4.0"
]
]
},
{
"name": "watchfiles",
"specs": [
[
"==",
"1.1.1"
]
]
}
],
"lcname": "minchin.pelican.plugins.autoloader"
}
JSON
