README.md

PyReports

PyReports is a python library that allows typing up html reports easily and quickly. It is done via a context managing. A simple example is

from PyReports import Section, Report, Grid  # containers
from PyReports import Txt, Img, Plt, Cde     # objects

report = Report('Test Report')  

with report:

  with Section('Introduction'):  
    Txt('This is a text')  
    Img('./image1.png') 
    
  with Section('Results', has_tex=True):
    Plt('./plotly_graph.html')
    Txt('''
        The plot along with necessary javascripts
        is embedded to the html report so it will
        be a standalone report
        ''')
    
    with Grid(2, 1, item_titles=['Image1', 'Image2']):
      Img('./image1.png')
      Img('./image2.png')
      
    Txt('''
        As with plots, the image will be embedded into the html.
        One can also put a latex formula using regular tex code:

        $\int exp^{-x^2} dx = ?? $
        
        Once has_tex is set to True, necessary javascripts will be 
        added to the report`s head.
        ''')
        
    with Section('Results Subsection'):
      Txt('''
          Subsections are created in the same way as sections:
          using the context manager within the main section
          as you used context manager to create section in reports.
          ''')
    
  with Section('Resources'):
    Cde('''
        Here goes some code which will
        be syntax highlighted formatted
        ''')
    
report.to_html('my_report.html)
    
 

Among other things, it also allows embedding plotly plots and antigenic cartography maps to your report. See the example_report.py for a much extended example and test_report for the end result.