Skip to content

Adding Cover Page, Setup Guide, Pluto Parser, Test Outputs, README, and Requirements

Hasan requested to merge codeIntrovert/python-pluto-pdf:main into main

Pull Request: Adding Pluto Parser, Test Outputs, README, and Requirements

Changes Made

  • Added "pluto-parser" directly in the project for easier setup.
  • Added test output as PDFs and SVGs in ./examples directory.
  • Added a README.md with detailed instructions for setting up the project.
  • Added requirements.txt for easier installation.
  • Added contributors.txt with my name and the name of the original author (JENS).
  • Ensured that generated PDFs have the flowchart and are human-readable as required.
  • [MINOR BUG FIX] changed line 15 of examples/test2.pluto from single line comment // Test2 to multiline comment /* Test2 */ this fixed the pluto.parse error while building flowchart
  • Added basic prototype Cover Page
  • Added terminal styling with colorama
  • Added Single Line support using latest pluto_parser (develop branch)

Description

This pull request addresses several enhancements and additions to the project, aimed at improving setup convenience, documentation, and testing capabilities.

Checklist

  • Added "pluto-parser" for easier setup.
  • Included test output as PDFs and SVGs.
  • Created a detailed README with setup instructions.
  • Provided a requirements file for easier installation.
  • Contributors information.
  • Ensured PDFs are human-readable with flowcharts.
  • Minor bug fix in test2.pluto script
  • Prototype Cover Page
  • New Terminal Styling with colorama
  • Single Line comment support // This is supported now

Screenshots

image image

Testing

The changes have been thoroughly tested locally to ensure everything works as expected. The following tests were performed:

  • Installed the project dependencies using requirements.txt.
  • Verified that "pluto-parser" integration works smoothly.
  • Ran tests to generate PDFs and SVGs in the ./examples directory.
  • Reviewed the README.md for clarity and completeness of setup instructions.
  • Confirmed that the contributors information is correctly added in contributors.txt.
  • Ensured that the generated PDFs contain the expected cover page, flowchart and pluto script are human-readable.
Edited by Hasan

Merge request reports