Package: django-svg-clip
Django-svg-clipDjango-svg-clip is a django template tags plugin for manipulating and rendering of svg and its attributes.FeaturesAdding static and dynamic attributes to svg icons.You don't have to paste the whole svg tag to add atrributes such as classes, inline-styles, WAI-arias.Make the templates look cleaner and shorter.Increases readability.InstallationInstall django-svg-clip from PyPI by running:# shellpipinstalldjango-svg-clipSetupAfter installing addsvg_cliptoINSTALLED_APPSin theDJANGO_SETTINGS_MODULE(e.g. settings.py).# settings.pyINSTALLED_APPS=[# ...'svg_clip',]Add SVG icons path toSVG_ICONS_DIRS:# settings.pySVG_ICONS_DIRS=[# path/to/icons# E.g:BASE_DIR/"static"/"heroicons"/"outline",BASE_DIR/"static/heroicons/solid",BASE_DIR/"static"/"icons",BASE_DIR/"static/icons",]Or you can use default icons by settingUSE_CLIP_ICONStoTrue.# settings.pyUSE_CLIP_ICONS=TrueUsageAfter adding the path of icons, use this tag{% clip 'icon-name' keyword_attrs="key word attrs" "non-keyword" "attrs" %}to add the icons to the django template.NOTE: Don't put.svgextension to the icons, it is automatically added during compilation.<!-- template.html --><!DOCTYPE html>{%loadsvg_clip%}<html><head><!-- ...  --></head><body><!-- ...  -->{%clip'academic-cap'%}{%clip'academic-cap'class="h-6w-6"%}{%clip'academic-cap-solid'class="h-6w-6"styles="display:block"%}{%clip'academic-cap'class="h-6w-6"styles="display:block""hidden"%}</body></html>Remarks: The defult icon set is heroicons-v2.0.13. To use the outline version, just use the icon name and for solid version, add'-solid'suffix to the icon name. For example, to use'academic-cap.svg'outline version, just use'academic-cap'and for solid version use'academic-cap-solid'.DevelopmentIssue Tracker:Github IssuesSource Code:Github repoNOTE: For contributing read theCONTRIBUTING.mdfile.SupportIf you are having issues, please let us know by opening an issue in our github repo. We warmly welcome you for any suggestion.LicenseThe project is licensed under the MIT license giving the community maximum priviledge to use. For more readLICENSE.mdfile.AuthorName:Dayal MoirangthemTwitter:@thisisdayalAcknowledgement and creditsHeroicons: By default, we use icon set provided by heroicons with a minimal tweaks in icon names. For example,academic-cap.svg, there is no modification for outline version, just useacademic-cap(without ".svg" extension) but for solid, you should useacademic-cap-solid(without ".svg" extension) .This is done to avoid naming conflicts with outline and solid versions.We'd like to show our regards to tailwindlabs team for availing those icons to community with an open source license.Python project template: We userochacbruno's python project template with little modification. It saves us a lot of time and headache during initial setup.MIT LicenseCopyright (c) 2023 Dayal MoirangthemPermission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.Changelog(unreleased)OtherChore: updated workflow files. [Dayal Moirangthem]1.0.1 (2023-02-15)OtherRelease: version 1.0.1 🚀 [Dayal Moirangthem]CI: updated main.yml to use latest actions. [Dayal Moirangthem]CI: updated release.yml and rename_project.yml to use latest actions. [Dayal Moirangthem]CI: added production environment to release.yml. [Dayal Moirangthem]Chore: update README.md. [Dayal Moirangthem]Delete static-pages.yml. [Dayal Moirangthem]Create static-pages.yml. [Dayal Moirangthem]Chore: README.md typo fix. [Dayal Moirangthem]1.0.0 (2023-02-15)FixUpdated kwargs_re to match all unicode characters. [Dayal Moirangthem]OtherRelease: version 1.0.0 🚀 [Dayal Moirangthem]Chore: minor fixes. [Dayal Moirangthem]Chore: minor fixes. [Dayal Moirangthem]Chore: added extra dependencies. [Dayal Moirangthem]Docs: added instructions in README.md and minor modifications to other files. [Dayal Moirangthem]Refactor: refactoring code for distribution build. [Dayal Moirangthem]added build method, Makefile.included VERSION and pylintrc in MANIFEST.in.added version detection in svg_clip package.updated conftest.py.refactored tests for better compliance to code formatters.Chore: tox.ini, requirements.txt, MANIFEST.in and Makefile are reconfigured. [Dayal Moirangthem]Test: removed vague tests. [Dayal Moirangthem]Removed tests for path returning multiple path (list or tuple) and removed malinformed argument test. Cannot find suitable test for malinformed argumentsRefactor: code refactoring. [Dayal Moirangthem]Reduced the number of variables for better design.Chore: added tox and Makefile is changed to use tox. [Dayal Moirangthem]Refactor: code refactoring. [Dayal Moirangthem]Dictionary concatenation for new attributes has been shortned. Variable old attrs has been removed. 'key' and 'value' has replaced 'k', 'v' respectively.Chore: updated .coverage file to test__repr__method. [Dayal Moirangthem]Refactor: remove test for multiple icon paths. [Dayal Moirangthem]Since we cannot find any case for path to return a list or tuple, this test is vague so removed from the testTest: test for almost all of the possible cases covering the whole source code. [Dayal Moirangthem]Chore: added .coveragerc for code coverage configurations. [Dayal Moirangthem]Refactor: 'svg_clip.py' returning multiple paths for an icon. [Dayal Moirangthem]0.1.0 (2023-02-11)FixClipNode must not have no child Nodes. [Dayal Moirangthem]ClipNode no longer accepts empty string value for svg_name. [Dayal Moirangthem]passing empty string value raises ValueErrorOtherRelease: version 0.1.0 🚀 [Dayal Moirangthem]Feat: added default icons. [Dayal Moirangthem]By default SVG clip uses heroiconsSVG's.set 'USE_CLIP_ICONS=True' in your 'DJANGO_SETTINGS_MODULE' to enable default icons.Wip: added compilation function for ClipNode. [Dayal Moirangthem]Implemented render method for rendering SVG markup with user provided attributes.Wip: added SVGParser for parsing SVG files and extract attributes. [Dayal Moirangthem]Wip: added custom exceptions. [Dayal Moirangthem]Test(passed)!:ClipNode repr test. [Dayal Moirangthem]test with all valid argumentstest with valid svg_name, empty args and kwargstest with empty string value for svg_nametest with no value for svg_nametest with no argumentsWip: created ClipNode for compilation function and added__repr__method. [Dayal Moirangthem]Chore: added templatetags module. [Dayal Moirangthem]Chore: deleted non-needed files__main__.py,base.py,cli.py[Dayal Moirangthem]Chore: updated different project files. [Dayal Moirangthem]✅ Ready to clone and code. [thisisdayal]Initial commit. [Dayal Moirangthem]