==========
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": "https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader",
"name": "minchin.pelican.plugins.autoloader",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "W. Minchin",
"author_email": "w_minchin@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/b0/4f/42a95cf7c37fd4b4f00df3872488294713d0a5e4827a4c8648fca1f35cf4/minchin.pelican.plugins.autoloader-1.2.1.tar.gz",
"platform": "any",
"description": "==========\nAutoLoader\n==========\n\n``AutoLoader`` is a plugin for `Pelican <http://docs.getpelican.com/>`_,\na static site generator written in Python.\n\n``AutoLoader`` is designed to autoload the other Pelican plugins in my\nnamespaces (``minchin.pelican.plugins`` and ``minchin.pelican.readers``).\nIt can also be extended to autoload\nplugins in other namespaces, for example, to autoload the ``pelican.plugins``\nnamespace on versions of Pelican before 4.5 (when autoloading to those plugins\nwas added to the Pelican core).\n\n.. image:: https://img.shields.io/pypi/v/minchin.pelican.plugins.autoloader.svg?style=flat\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.autoloader\n :alt: PyPI version number\n\n.. image:: https://img.shields.io/badge/-Changelog-success?style=flat\n :target: https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader/blob/master/CHANGELOG.rst\n :alt: Changelog\n\n.. image:: https://img.shields.io/pypi/pyversions/minchin.pelican.plugins.autoloader?style=flat\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.autoloader/\n :alt: Supported Python version\n\n.. image:: https://img.shields.io/pypi/l/minchin.pelican.plugins.autoloader.svg?style=flat&color=green\n :target: https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader/blob/master/LICENSE.txt\n :alt: License\n\n.. image:: https://img.shields.io/pypi/dm/minchin.pelican.plugins.autoloader.svg?style=flat\n :target: https://pypi.python.org/pypi/minchin.pelican.plugins.autoloader/\n :alt: Download Count\n\n\nInstallation\n============\n\nThe easiest way to install ``AutoLoader`` is through the use of pip. This\nwill also install the required dependencies automatically.\n\n.. code-block:: sh\n\n pip install minchin.pelican.plugins.autoloader\n\nFurther configuration will depend on the version of Pelican you are running. On\nversion 4.5 or newer and you haven't defined ``PLUGINS`` in your\n``pelicanconf.py``, nothing more in needed. On earlier versions of Pelican, or\nif you've defined ``PLUGINS``, you'll need to add the autoloader to your list\nof plugins in your ``pelicanconf.py`` file:\n\n.. code-block:: python\n\n # pelicanconf.py\n\n PLUGINS = [\n # ...\n 'minchin.pelican.plugins.autoloader',\n # ...\n ]\n\nIf you want to auto-load additional namespaces, you'll need to define the\n``AUTOLOADER_NAMESPACES`` variable in your ``pelicanconf.py`` file:\n\n.. code-block:: python\n\n # pelicanconf.py\n\n from minchin.pelican.plugins import autoloader\n\n AUTOLOADER_NAMESPACES = autoloader.DEFAULT_NAMESPACE_LIST + [\n \"pelican.plugins\",\n # other namespaces\n ]\n\nIf you need to disallow auto-loading of certain plugins, you'll need to define\nthe ``AUTOLOADER_PLUGIN_BLACKLIST`` variable in your ``pelicanconf.py`` file.\nThis only works when autoloading from defined namespaces. E.g.:\n\n.. code-block:: python\n\n # pelicanconf.py\n\n from minchin.pelican.plugins import autoloader\n\n AUTOLOADER_PLUGIN_BLACKLIST = autoloader.DEFAULT_PLUGIN_BLACKLIST + [\n \"pelican.plugins.misbehaving_plugin\",\n # other plugins\n ]\n\nUsage Notes\n===========\n\n- the plugins loaded by this plugin will not be shown when you run\n ``pelican-plugins``\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Pelican plugin, used to auto-load my other plugins.",
"version": "1.2.1",
"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",
"Homepage": "https://github.com/MinchinWeb/minchin.pelican.plugins.autoloader"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0f5899693e37dc3abf7a0cd022090c666fca79c6a556eb921bed41717e7ad70c",
"md5": "6e08338ed40158abb8d8438f99792ca1",
"sha256": "d73cec6b28ab6d83356415f99b2d899e0737d7f8955f8c2938f363e442ee035a"
},
"downloads": -1,
"filename": "minchin.pelican.plugins.autoloader-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e08338ed40158abb8d8438f99792ca1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7361,
"upload_time": "2023-08-03T20:39:50",
"upload_time_iso_8601": "2023-08-03T20:39:50.688985Z",
"url": "https://files.pythonhosted.org/packages/0f/58/99693e37dc3abf7a0cd022090c666fca79c6a556eb921bed41717e7ad70c/minchin.pelican.plugins.autoloader-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b04f42a95cf7c37fd4b4f00df3872488294713d0a5e4827a4c8648fca1f35cf4",
"md5": "e5730fd0c67bfa5f9edefeb7e0a0e8e6",
"sha256": "74a7e9bdac33461900b8bdb81c33423409e35c9c7cece193491abf7356d9cd95"
},
"downloads": -1,
"filename": "minchin.pelican.plugins.autoloader-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "e5730fd0c67bfa5f9edefeb7e0a0e8e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7472,
"upload_time": "2023-08-03T20:40:24",
"upload_time_iso_8601": "2023-08-03T20:40:24.120629Z",
"url": "https://files.pythonhosted.org/packages/b0/4f/42a95cf7c37fd4b4f00df3872488294713d0a5e4827a4c8648fca1f35cf4/minchin.pelican.plugins.autoloader-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-03 20:40:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MinchinWeb",
"github_project": "minchin.pelican.plugins.autoloader",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "minchin.pelican.plugins.autoloader"
}
JSON
