Skip to main content

simple generator of complex html reports

Project description

Build Status Documentation Status GitHub issues PyPI - Python Version PyPI - Development Status PyPI - Package Format PyPI GitHub license

Yawrap is a powerful, lightweight, pythonic pseudo-static HTML builder that works with:

  • python2.7,

  • python3.5-python.3.8

  • pypy, pypy3.

The name comes from something like Yet Another Wrapper (of HTML code).

Repo:

https://gitlab.com/kamichal/yawrap

OldRepo:

https://github.com/kamichal/yarap

OldRepo:

https://bitbucket.org/gandowin/yarap (goes obsolete)

Docs:

http://yawrap.readthedocs.io

Pypi:

https://pypi.python.org/pypi/yawrap

Author:

Michał Kaczmarczyk from Poland

Email:

michal.skaczmarczy.k at gmail.com

Yawrap features

  • Very nice syntax

    No more headache caused by closing and indentation of HTML elements! Just write python code.

    Yawrap reflects python scopes in HTML perfectly - with no mistakes and indents it natively for free.

  • Handle CSS and JS how you like. It can be sourced either

    • from local file

    • from url

    • from python string

    And it can be placed: - as internal content - as external file - as linked resource.

    From single “All in one” HTML file to multi-page documents sharing CSS&JS resources. Yawrap takes care for handling them properly.

  • SVG support

    Don’t care about defining SVG structure, just write its main contents. Yawrap will take care about the whole rest. Also typical SVG attributes which are problematic from python keyword-arguments point of view have it’s convenience feature.

  • Linking local files

    You can reference local files by passing its absolute path on python side and it will appear under links relative to the current document. And you don’t have to calculate the paths.

  • Defining page style and scripts on python class level

    Page styles can be defined by deriving Yawrap classes. This makes possibility to get the styles shared / inherited / override in well known pythonic way.

  • Multi-page structure

    Define multiple pages (even in complex directory structure) and don’t care about the paths. Not existing directories will be automatically created, you just define the path of target file.

  • Automatic navigation

    That’s ultra-nice. Probably the cutest yawrap’s feature. Create multiple pages and see how yawrap joins them in navigation panel created for each generated page. Everything happens behind the curtains.

    The only one thing you need to do is to care for the navigation’s CSS style (if you don’t like the default navigation style provided by Yawrap).

  • Bookmarking

    Create intra-page bookmarks with just one command during document definition and see how they are inserted in correct subsection of the page navigation.

Download files

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

Source Distribution

yawrap-0.4.10.tar.gz (17.3 kB view hashes)

Uploaded Source

Built Distribution

yawrap-0.4.10-py2.py3-none-any.whl (37.5 kB view hashes)

Uploaded Python 2 Python 3

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