# Jinja2 Ansible Filters
## Overview
Jinja2 Ansible Filters is a port of the ansible filters provided by Ansible's templating engine.
This repository is not inteded to supplant ansible functionality however there are a lot of filters ansible provides that are not present in upstream Jinja2 so you may find these helpful.
### Included filters
- b64decode
- b64encode
- basename
- bool
- checksum
- comment
- dirname
- expanduser
- expandvars
- extract
- fileglob
- flatten
- from_json
- from_yaml
- from_yaml_all
- ans_groupby
- hash
- mandatory
- md5
- quote
- ans_random
- random_mac
- realpath
- regex_escape
- regex_findall
- regex_replace
- regex_search
- relpath
- sha1
- shuffle
- splitext
- strftime
- subelements
- ternary
- to_datetime
- to_json
- to_nice_json
- to_nice_yaml
- to_uuid
- to_yaml
- type_debug
- win_basename
- win_dirname
- win_splitdrive
### Renamed filters
Due to naming conflicts with Jinja2 builtin filters, these filters have been prefixed with ans_
- groupby
- random
so:
- ans_groupby
- ans_random
Additionally any filter naming collisions detected at runtime will be renamed to ans_filter and a warning message raised for each.
Several heavy filters have been omitted due to their extensive dependency on ansible core:
### Excluded Filters
- combine
- get_encrypted_password
- dict2items
- items2dict
## Install
`pip install jinja2-ansible-filters`
## Usage
### Typical usage with jinja2
```python
from jinja2 import Environment
...
env = Environment(extensions=['jinja2_ansible_filters.AnsibleCoreFiltersExtension'])
...
# OR
from jinja2_ansible_filters import AnsibleCoreFiltersExtension
env = Environment(extensions=[AnsibleCoreFiltersExtension])
...
```
### Include into cookiecutter
cookiecutter.json
```json
{
"_extensions": ["jinja2_ansible_filters.AnsibleCoreFiltersExtension"]
}
```
## License
Due to multiple licenses in the Ansible source the licenses have both been included in LICENSE as well as proper attribution. Additionally license stubs where preserved with the source files they covered in the origional ansible repository.
## [1.3.2](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.3.1...v1.3.2) (2022-06-30)
### Bug Fixes
* Add VERSION to MANIFEST.in ([6dfc56a](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/6dfc56a))
## [1.3.1](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.3.0...v1.3.1) (2022-04-14)
### Bug Fixes
* environmentfilter renamed to pass_environment in jinja2>=3.1 ([47f7173](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/47f7173))
# [1.3.0](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.2.1...v1.3.0) (2020-04-14)
### Features
* Adds Combine filter and tests ([085806b](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/085806b))
## [1.2.1](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.2.0...v1.2.1) (2019-11-15)
### Bug Fixes
* Fixed description by removing quotes ([2d29bff](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/2d29bff))
# [1.2.0](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.1.0...v1.2.0) (2019-11-07)
### Features
* removed six requirement from setup.cfg ([4902da9](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/4902da9))
# [1.1.0](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.0.0...v1.1.0) (2019-11-06)
### Features
* Added test coverage to satisfactory level ([f14ca2c](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/f14ca2c))
* Initial commit with full function and tests ([702e321](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/702e321))
# 1.0.0 (2019-11-06)
### Features
* Added test coverage to satisfactory level ([bbb0cb0](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/bbb0cb0))
* Initial commit with full function and tests ([529c606](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/529c606))
(c) 2019, Nick Shobe <nickshobe@gmail.com>
(c) 2016, Toshio Kuratomi <a.badger@gmail.com>
(c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>
This code is derived from Ansible's template Jinja2 filters
It contains source released under two licenses GPL3 and BSD license
Applicable licenses have been added to the respective files that they apply to.
This code is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This code is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Ansible. If not, see <http://www.gnu.org/licenses/>.
BSD License
Some of this code was ported from Ansible, but is an independent component.
This particular file snippet, and this file snippet only, is BSD licensed.
Modules you write using this snippet, which is embedded dynamically by Ansible
still belong to the author of the module, and may assign their own license
to the complete work.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters",
"name": "jinja2-ansible-filters",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Nick Shobe",
"author_email": "nickshobe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1a/27/fa186af4b246eb869ffca8ffa42d92b05abaec08c99329e74d88b2c46ec7/jinja2-ansible-filters-1.3.2.tar.gz",
"platform": null,
"description": "# Jinja2 Ansible Filters\n\n## Overview\n\nJinja2 Ansible Filters is a port of the ansible filters provided by Ansible's templating engine.\n\nThis repository is not inteded to supplant ansible functionality however there are a lot of filters ansible provides that are not present in upstream Jinja2 so you may find these helpful.\n\n### Included filters\n\n- b64decode\n- b64encode\n- basename\n- bool\n- checksum\n- comment\n- dirname\n- expanduser\n- expandvars\n- extract\n- fileglob\n- flatten\n- from_json\n- from_yaml\n- from_yaml_all\n- ans_groupby\n- hash\n- mandatory\n- md5\n- quote\n- ans_random\n- random_mac\n- realpath\n- regex_escape\n- regex_findall\n- regex_replace\n- regex_search\n- relpath\n- sha1\n- shuffle\n- splitext\n- strftime\n- subelements\n- ternary\n- to_datetime\n- to_json\n- to_nice_json\n- to_nice_yaml\n- to_uuid\n- to_yaml\n- type_debug\n- win_basename\n- win_dirname\n- win_splitdrive\n\n### Renamed filters\n\nDue to naming conflicts with Jinja2 builtin filters, these filters have been prefixed with ans_\n\n- groupby\n- random\n\nso:\n\n- ans_groupby\n- ans_random\n\nAdditionally any filter naming collisions detected at runtime will be renamed to ans_filter and a warning message raised for each.\n\nSeveral heavy filters have been omitted due to their extensive dependency on ansible core:\n\n### Excluded Filters\n\n- combine\n- get_encrypted_password\n- dict2items\n- items2dict\n\n## Install\n\n`pip install jinja2-ansible-filters`\n\n## Usage\n\n### Typical usage with jinja2\n\n```python\n from jinja2 import Environment\n\n...\n env = Environment(extensions=['jinja2_ansible_filters.AnsibleCoreFiltersExtension'])\n...\n# OR\n from jinja2_ansible_filters import AnsibleCoreFiltersExtension\n env = Environment(extensions=[AnsibleCoreFiltersExtension])\n...\n```\n\n### Include into cookiecutter\n\ncookiecutter.json\n\n```json\n{\n \"_extensions\": [\"jinja2_ansible_filters.AnsibleCoreFiltersExtension\"]\n}\n```\n\n## License\n\nDue to multiple licenses in the Ansible source the licenses have both been included in LICENSE as well as proper attribution. Additionally license stubs where preserved with the source files they covered in the origional ansible repository.\n\n## [1.3.2](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.3.1...v1.3.2) (2022-06-30)\n\n\n### Bug Fixes\n\n* Add VERSION to MANIFEST.in ([6dfc56a](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/6dfc56a))\n\n## [1.3.1](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.3.0...v1.3.1) (2022-04-14)\n\n\n### Bug Fixes\n\n* environmentfilter renamed to pass_environment in jinja2>=3.1 ([47f7173](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/47f7173))\n\n# [1.3.0](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.2.1...v1.3.0) (2020-04-14)\n\n\n### Features\n\n* Adds Combine filter and tests ([085806b](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/085806b))\n\n## [1.2.1](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.2.0...v1.2.1) (2019-11-15)\n\n\n### Bug Fixes\n\n* Fixed description by removing quotes ([2d29bff](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/2d29bff))\n\n# [1.2.0](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.1.0...v1.2.0) (2019-11-07)\n\n\n### Features\n\n* removed six requirement from setup.cfg ([4902da9](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/4902da9))\n\n# [1.1.0](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/compare/v1.0.0...v1.1.0) (2019-11-06)\n\n\n### Features\n\n* Added test coverage to satisfactory level ([f14ca2c](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/f14ca2c))\n* Initial commit with full function and tests ([702e321](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/702e321))\n\n# 1.0.0 (2019-11-06)\n\n\n### Features\n\n* Added test coverage to satisfactory level ([bbb0cb0](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/bbb0cb0))\n* Initial commit with full function and tests ([529c606](https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/commit/529c606))\n\n(c) 2019, Nick Shobe <nickshobe@gmail.com>\n(c) 2016, Toshio Kuratomi <a.badger@gmail.com>\n(c) 2012-2014, Michael DeHaan <michael.dehaan@gmail.com>\n\n\nThis code is derived from Ansible's template Jinja2 filters\n\nIt contains source released under two licenses GPL3 and BSD license\nApplicable licenses have been added to the respective files that they apply to.\n\n\nThis code is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis code is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with Ansible. If not, see <http://www.gnu.org/licenses/>.\n\n\nBSD License\n\nSome of this code was ported from Ansible, but is an independent component.\nThis particular file snippet, and this file snippet only, is BSD licensed.\nModules you write using this snippet, which is embedded dynamically by Ansible\nstill belong to the author of the module, and may assign their own license\nto the complete work.\n\nRedistribution and use in source and binary forms, with or without modification,\nare permitted provided that the following conditions are met:\n\n * Redistributions of source code must retain the above copyright\n notice, this list of conditions and the following disclaimer.\n * Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\nANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.\nIN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\nINCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\nPROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\nINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\nLIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE\nUSE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n",
"bugtrack_url": null,
"license": "GPL3",
"summary": "A port of Ansible's jinja2 filters without requiring ansible core.",
"version": "1.3.2",
"project_urls": {
"Homepage": "https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "72b9313e8f2f2e9517ae050a692ae7b3e4b3f17cc5e6dfea0db51fe14e586580",
"md5": "11dd16768b58d07a8b78952b847102cd",
"sha256": "e1082f5564917649c76fed239117820610516ec10f87735d0338688800a55b34"
},
"downloads": -1,
"filename": "jinja2_ansible_filters-1.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "11dd16768b58d07a8b78952b847102cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18975,
"upload_time": "2022-06-30T14:08:49",
"upload_time_iso_8601": "2022-06-30T14:08:49.571998Z",
"url": "https://files.pythonhosted.org/packages/72/b9/313e8f2f2e9517ae050a692ae7b3e4b3f17cc5e6dfea0db51fe14e586580/jinja2_ansible_filters-1.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a27fa186af4b246eb869ffca8ffa42d92b05abaec08c99329e74d88b2c46ec7",
"md5": "603f313438fc3460d17659848edacbb5",
"sha256": "07c10cf44d7073f4f01102ca12d9a2dc31b41d47e4c61ed92ef6a6d2669b356b"
},
"downloads": -1,
"filename": "jinja2-ansible-filters-1.3.2.tar.gz",
"has_sig": false,
"md5_digest": "603f313438fc3460d17659848edacbb5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16945,
"upload_time": "2022-06-30T14:08:50",
"upload_time_iso_8601": "2022-06-30T14:08:50.775604Z",
"url": "https://files.pythonhosted.org/packages/1a/27/fa186af4b246eb869ffca8ffa42d92b05abaec08c99329e74d88b2c46ec7/jinja2-ansible-filters-1.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-30 14:08:50",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "dreamer-labs",
"gitlab_project": "libraries",
"lcname": "jinja2-ansible-filters"
}
JSON