Simple shortcodes for Python.
Project description
shrtcodes
pip install shrtcodes
Simple shortcodes for Python.
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.
{% end_details %}
Foo bar baz.
Build your shortcodes:
# shortcodes.py
from shrtcodes.shrtcodes import Shrtcodes
shortcodes = Shrtcodes()
# `img_handler` is a shortcode handler.
# * Arguments correspond to the shortcode parameters.
@shortcodes.register('img')
def img_handler(src, alt):
return f'<img src="{src}" alt="{alt}"/>'
# `details_handler` is a paired shortcode handler.
# * Starting arguments correspond to the shortcode parameters.
# * Last argument is the contained block.
@shortcodes.register_paired('details')
def details_handler(summary, block):
return f'<details><summary>{summary}</summary>{block}</details>'
Use your shortcodes:
from shortcodes import shortcodes
text = shortcodes.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.4.0.tar.gz
(3.5 kB
view hashes)
Built Distribution
Close
Hashes for shrtcodes-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef07d6382327bcecd2cf4bddfaafc081358c4a19a94329aa6010bcba910eeada |
|
MD5 | f75bddb3c19dcd447903a5288c78147e |
|
BLAKE2b-256 | a3e5b05078e25197ef36c4ed8716f510e3e1d8659ab3185f8d89cd3afc524197 |