Simple shortcodes for Python.
Project description
shrtcodes
pip install shrtcodes
Shortcodes for Python.
Example:
A toy example.
Define our shortcodes:
# example.py
from shrtcodes import Shrtcodes
shortcodes = Shrtcodes()
# {% img src alt %} will create an image.
@shortcodes.register_inline("img")
def handle_img(src, alt):
return f'<img src="{src}" alt="{alt}"/>'
# {% repeat n %}...{% / %} will repeat a block n times.
@shortcodes.register_block("repeat")
def handle_repeat(block, n):
return block * int(n)
# we can call process_text to get the final text.
in_text = "..."
out_text = shortcodes.process_text(in_text)
# or, we can make a general CLI.
shortcodes.create_cli()
python example.py --help
usage: example.py [-h] [--check_file CHECK_FILE] in_file
positional arguments:
in_file File to be processed
options:
-h, --help show this help message and exit
--check_file CHECK_FILE
Checks the output against this file and errors if
there is a diff
Write some text:
# example.txt
Hello!
{% img http://cutedogs.com/dog123.jpg "A very cute dog" %}
Foo bar baz...
{% repeat 3 %}
Woop
{% / %}
Bye!
Process the text:
python example.py example.txt
Hello!
<img src="http://cutedogs.com/dog123.jpg" alt="A very cute dog"/>
Foo bar baz...
Woop
Woop
Woop
Bye!
A more useful example would be the generation of this README itself.
See create_readme.py
and README.template.md
.
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-1.0.3.tar.gz
(3.8 kB
view hashes)
Built Distribution
Close
Hashes for shrtcodes-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23d413102e17600b86d6dc4171415f6c44ad13ebd2ca0408a968b26b24aeb8f0 |
|
MD5 | f17018151ff66ebb618d0be67c00f91b |
|
BLAKE2b-256 | 86deaf2a3706dcb9c13e9d5d399f1fa8d6914e325e1e0d9e12b3fc3b9cd43c9d |