Skip to main content

Helper for creating presentation slides for developers. Markdown + graphs + html = big fun.

Project description

xslide

Tool for creating presentations.

Accepts content specified in:

  • markdown

  • grot - graphviz syntax overlay for generating graphs

  • plain python strings

  • xplant syntax (can build arbitrary html code)

Outputs:

  • static html

Basic usage:

import xslide

slide = xslide.XSlide("Title of example from README")

slide.markdown("""
# xslide

- Can accept a `markdown`
- Can draw graphs in `grot` (`graphviz` overlay)
- Can use HTML in `xplant`

Author: [Michal Kaczmarczyk](mailto:michal.s.kaczmarczyk@gmail.com),

""")

slide.next("Header of the next slide")
slide.markdown("This one contains a graph:")

with slide.make_graph("this_dot_name", html_style="max-width: 55%;") as g:
    stage_1 = g.node("Stage 1", shape="box3d")
    stage_2 = g.node("Stage\n2", shape="circle", penwidth="3.1")
    g.edge(stage_1, stage_2, penwidth="2.6")
    sink = g.node("This\nsinks\nall")

    for n in ["alfa", "beta", "gamma", "delta"]:
        if n == "gamma":
            g.edge(stage_2, n, sink, penwidth="2.6", color="#314289")
        else:
            g.edge(stage_2, n, sink, color="#aabbcc", style="dashed")

slide.flush()  # makes a break
slide.markdown("""
*Markdown* with `nice_code` formatting. This example generates such a files:

\`\`\`
    >$ tree XSLIDE/examples/output/readme_example
    XSLIDE/examples/output/readme_example
    |-- index.html
    |-- readme_example_01.html
    |-- readme_example_01.html_this_dot_name.dot
    |-- readme_example_01.html_this_dot_name.dot.svg
    |-- readme_example_02.html
    |-- serve.py
    `-- xslide.css
\`\`\`
""")

# don't forget to:
slide.store()
Result can be seen in gitlab in:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

xslide-0.1.2-py2.py3-none-any.whl (9.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file xslide-0.1.2-py2.py3-none-any.whl.

File metadata

  • Download URL: xslide-0.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.0 CPython/2.7.13

File hashes

Hashes for xslide-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9ee3d559f7eaa2b43273acd4f6c1d3036c03c2e5170577b962e99aaf260b1821
MD5 ed8ebd0a351ceb8667fbd7f891ce10e9
BLAKE2b-256 56d7833bb95f1a88c8430f909a2b1c81ef502cf6a7b83601385ace7cc3fb85fd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page