Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.42 KB

dev-docs.md

File metadata and controls

30 lines (21 loc) · 1.42 KB

Developer Documentation

run main.py to start the complete app

Building

To build the app as an executable for production:

pyinstaller --name word-2-pdf --icon=assets/app-icon.ico --onefile --windowed main.py

GitHub release

steps to do once ready to release new version:

  • update the version in readme
  • commit only this change, and the commit message will be the release description
  • tag this commit with git tag <version> with the right version number
  • do git push and git push origin <version>

Pushing a tag to master with the form 'vX.X.X' will trigger a release action, if version is 0.1.2, then tag it as 'v0.1.2'. GitHub Actions will make a windows exe with pyinstaller and include it in the release assets.

Architecture

ui contains all stuff about the graphical user interface with tkinter.

word2pptx contains all stuff about handling the parsing of the word file, to making the PDF file. To build the PDF, it uses the software Prince, that converts html to PDF. This program first generate html code that is passed to Prince to make a PDF file.

Références