Simple shortcodes for Python.
Project description
shrtcodes
Simple shortcodes for Python.
pip install shrtcodes
Example
Text containing shortcodes.
img
- a shortcode.details
- a paired shortcode.
Foo bar baz.
{% img https://images.com/cutedog.jpg | A cute dog! %}
{% details Some extra info %}
This is some extra info.
{% enddetails %}
Foo bar baz.
Build a process
function:
# shortcodes.py
from shrtcodes.shrtcodes import make_process
# `img_handler` is a single line shortcode handler.
# * Arguments correspond to the shortcode parameters (pipe separated).
def img_handler(src, alt):
return f'<img src="{src}" alt="{alt}"/>'
# `details_handler` is a paired shortcode handler.
# * First argument is the contained block.
# * Subsequent arguments correspond to the shortcode parameters (pipe separated).
def details_handler(details, summary):
return f'<details><summary>{summary}</summary>{details}</details>'
# Call `make_process` with:
# * A dict of single line shortcode handlers.
# * A dict of paired shortcode handlers.
process = make_process({
'img': img_handler
}, {
'details': details_handler
})
Use your process
function:
from shortcodes import process
text = process('...')
Output:
Foo bar baz.
<img src="https://images.com/cutedog.jpg" alt="A cute dog!"/>
<details><summary>Some extra info</summary>This is some extra info.</details>
Foo bar baz.
Further examples
See the tests.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
shrtcodes-0.1.1.tar.gz
(3.2 kB
view hashes)
Built Distribution
Close
Hashes for shrtcodes-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2928239c299a407d46e24da5c5484fd0902041403a2a71661b5049c0d98c7a6 |
|
MD5 | 7f2f0deae3e22acc73a3c56c97431fa9 |
|
BLAKE2b-256 | 57b119e1bcdd324d573f9f6c5cfb9953e9f10349dd9fb573c6a194181a04b383 |