PlasticMetal.pyLabOn

View at PyPI

Light-weight tool to generate markdown-formatted lab reports. For python.

Setup

pip install pylabon

You may need to install some tex engines by your self.

Usage

Create a report

from pyLabOn import Report

# Name can be anything you like; 
# you may specific path if the report files should not be generated in ./
my_report=Report("demo")

Add content to report

# You can also add formula, code, and anything
my_report.add_plain_content("Hello, pyLabOn")

Add a sub paragraph

# The return value of .add_sub_paragraph() is the sub paragraph created
# You can add sub paragraphs to sub paragraph in the same way
sub_para=my_report.add_sub_paragraph("SubParagraph")

# Add contents to the sub paragraph just like to the report
sub_para.add_plain_content("There is a Table")

Add a table

# Add a Table to the sub paragraph
# (List,List[List] [,Align=0])->Table
# Align: 0=Central, -1=Left, 1=Right
# Align can be a list or a single int
# The return value of .add_table() is the table created
sub_para.add_table(["index"],[[i] for i in range(0,10)])

Save to Markdown and Compile to PDF

# This command generates .md to my_report.MarkdownFilePath, and .pdf to my_report.PDFPath
# You can customize your engine, font and template
# If you just want a Markdown file, use my_report.save_to_file() instead
my_report.compile()