sniptex 1.0.1

Python package for extracting tagged code snippets from local files or remote sources.

SnipTeX is a Python package for extracting tagged code snippets from local files or remote sources. It serves as the backend for the SnipTeX LaTeX package, enabling dynamic inclusion of code snippets directly in documents.

Quick example

Source file

# sniptex-start demo
def main():
    x = 1
    y = 2
    print(x + y)

    return 0
# sniptex-end demo

if __name__ == "__main__":
    import sys
    sys.exit(main())

CLI usage

sniptex --help

Write the snippet to stdout:

sniptex -s example.py -t demo

Write the snippet to a file:

sniptex -s example.py -t demo -o out/out.txt

Get snippet from URL:

sniptex -s https://raw.githubusercontent.com/brozrost/sniptex/main/docs/example.py -t demo

Python usage

from sniptex import extractor

snippet = extractor.extract_from_file("example.py", "demo")

Tag format

SnipTeX extracts code between two matching markers:

sniptex-start <tag>
...
sniptex-end <tag>

Tags are case-sensitive and markers must appear on separate lines.

Supported sources

• Local file paths
• Remote URLs (e.g. GitHub raw files)

Error handling

SnipTeX raises errors when:

• the tag is not found
• start/end markers are mismatched
• multiple start markers exist
• the source cannot be fetched