Fetch and deploy external resource files
========================================
Sorry, this file is outdated – will be updated soon. Don't read on. Thank you.
Installation
------------
#. Install this package (as editable or from the repository) into your virtual environment.
#. Install ``invoke``,
create a ``tasks.py`` file in the root directory of your project and insert these lines::
from external_resources.tasks import (
get_resources,
check_resource,
deploy_resources,
)
#. Create a file ``external_resources.yaml`` containing information about the external
resources that you will be needing. An example is supplied with this package.
#. Create (or edit) the file ``invoke.yaml`` (in the same directory as ``tasks.py``);
it should specify the path of your ``external_resources.yaml`` registry and
a list of resource names and optional version specifiers (like in a requirements file).
Example::
external_resources:
required:
- bootstrap5
- bootstrap5_js
- htmx ~= 1.7
- lineawesome13 ~= 1.3
config_file: external_resources.yaml
dir_name: static_external
The path to the ``config_file`` can either be an absolute path or relative to the
directory of ``invoke.yaml``.
The ``dir_name`` option should point to a directory where the external resources
will be installed (on your local host); depending on the kind of the resource they
will go into subdirectories ``css``, ``js``, or ``fonts``.
#. The invoke command ::
inv get-resources
will try to download the resources specified as ``required`` into the ``dir_name``
target directory.
If the integrity check code for a resource is not known, the command ::
inv check-resource NAME
will calculate and display this code which then can be pasted into the registry
to make sure the correct file was retrieved on a later download.
With ::
inv deploy-resources
the resources from the local ``dir_name`` directory (and its subdirectories) will
be rsync'ed to the target host specified by the ``target`` option in ``invoke.yaml``.
Raw data
{
"_id": null,
"home_page": null,
"name": "external-resources",
"maintainer": "Detlef Lannert",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Detlef Lannert <detlef@lannert.de>",
"keywords": "js, JavaScript, CSS, fonts, vendoring, web application, resources, web, installation",
"author": "Detlef Lannert",
"author_email": "Detlef Lannert <detlef@lannert.de>",
"download_url": "https://files.pythonhosted.org/packages/31/c3/ddfc62aabda7314f48230900d5cf025dc22661a956cd386f191f4b4d6b77/external_resources-0.4.0.tar.gz",
"platform": null,
"description": "Fetch and deploy external resource files\n========================================\n\nSorry, this file is outdated \u2013 will be updated soon. Don't read on. Thank you.\n\nInstallation\n------------\n\n#. Install this package (as editable or from the repository) into your virtual environment.\n\n#. Install ``invoke``,\n create a ``tasks.py`` file in the root directory of your project and insert these lines::\n\n from external_resources.tasks import (\n get_resources, \n check_resource,\n deploy_resources,\n )\n\n#. Create a file ``external_resources.yaml`` containing information about the external\n resources that you will be needing. An example is supplied with this package.\n\n#. Create (or edit) the file ``invoke.yaml`` (in the same directory as ``tasks.py``);\n it should specify the path of your ``external_resources.yaml`` registry and\n a list of resource names and optional version specifiers (like in a requirements file).\n \n Example::\n \n external_resources:\n required:\n - bootstrap5\n - bootstrap5_js\n - htmx ~= 1.7\n - lineawesome13 ~= 1.3\n config_file: external_resources.yaml\n dir_name: static_external\n\n The path to the ``config_file`` can either be an absolute path or relative to the\n directory of ``invoke.yaml``.\n \n The ``dir_name`` option should point to a directory where the external resources\n will be installed (on your local host); depending on the kind of the resource they\n will go into subdirectories ``css``, ``js``, or ``fonts``.\n\n#. The invoke command ::\n \n inv get-resources\n \n will try to download the resources specified as ``required`` into the ``dir_name``\n target directory.\n \n If the integrity check code for a resource is not known, the command ::\n \n inv check-resource NAME\n \n will calculate and display this code which then can be pasted into the registry\n to make sure the correct file was retrieved on a later download.\n \n With ::\n \n inv deploy-resources\n \n the resources from the local ``dir_name`` directory (and its subdirectories) will\n be rsync'ed to the target host specified by the ``target`` option in ``invoke.yaml``.\n",
"bugtrack_url": null,
"license": null,
"summary": "Fetch and deploy external resources (CSS, JS, Fonts) for web services",
"version": "0.4.0",
"project_urls": {
"Changelog": "https://github.com/detlefla/external_resources/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/detlefla/external_resources",
"Issues": "https://github.com/detlefla/external_resources/issues",
"Repository": "https://github.com/detlefla/external_resources.git"
},
"split_keywords": [
"js",
" javascript",
" css",
" fonts",
" vendoring",
" web application",
" resources",
" web",
" installation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e6c1d1d7d8a0947d50c6890a297be57ce61f2f156ac1166caeba1b868dddd8e3",
"md5": "d5545c00d13616a12db49c06d53a393c",
"sha256": "cd674ec8605f30d6c64e43e8e055eab374b6fdd5e47eec2e7dda17fe2abf118d"
},
"downloads": -1,
"filename": "external_resources-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5545c00d13616a12db49c06d53a393c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 30155,
"upload_time": "2025-09-08T11:37:53",
"upload_time_iso_8601": "2025-09-08T11:37:53.009942Z",
"url": "https://files.pythonhosted.org/packages/e6/c1/d1d7d8a0947d50c6890a297be57ce61f2f156ac1166caeba1b868dddd8e3/external_resources-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "31c3ddfc62aabda7314f48230900d5cf025dc22661a956cd386f191f4b4d6b77",
"md5": "4ad95ae0c97e1a02940518f72427f730",
"sha256": "f1e1373a56407b97d90779e88dc6f3ed00802da28ff098b541c7ac9c1389d4f8"
},
"downloads": -1,
"filename": "external_resources-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "4ad95ae0c97e1a02940518f72427f730",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 25225,
"upload_time": "2025-09-08T11:37:54",
"upload_time_iso_8601": "2025-09-08T11:37:54.219941Z",
"url": "https://files.pythonhosted.org/packages/31/c3/ddfc62aabda7314f48230900d5cf025dc22661a956cd386f191f4b4d6b77/external_resources-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-08 11:37:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "detlefla",
"github_project": "external_resources",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "external-resources"
}
JSON
