School icons created by Freepik - Flaticon

school reports is a simple way to create, store and customize your reports.

Disclaimer

• Every student is responsible for their reports. No developer will take any blame if your reports do not fulfill the requirements of your school or institute.
• If you wish to change something or wish for a feature, please create a new issue here.
• On every pull your files could be changed. So if you want to work with the newest build please backup your data/config folder and reports.json since school reports currently does not offer automatic backups.

Requirements

This project does need Python and LaTeX to work corectly.

Python

Python can be installed through the provided installer or package on theri download page.

LaTeX

If you encounter problems building with your LaTeX installation please make sure to check for any updates and that pdflatex is in your path and accesible since this is the building command used for the reports.

Prepare

1. Firtly make sure you've installed all requirements.
2. After that you need a reports.json file. This file is your base file for all your reports and lies in the main directory of the software if you did not change the config.
3. With that said please review the file report_data.config in data/config and change the respective values to your needs.
4. If everything is working correctly try to run python setup.py --build for the console variant or python setup.py --gui for the GUI variant.
5. After a successful build there should be a .pdf file in your main directory.

Information & Tips

• If there are any characters which are not displayed correctly it could be due to incorrect backend handling. You can try to add backslashes before it.
  • '&' -> '\\&'
  • You need two backslashes because of the way the software works behind the scenes.
• Any entries starting the line with '$s' (you can replace 's' with x 'config_shortcut_x' which can be defined in the config.)
• Using '::' will replace theese caharacters with ' - ' and make the text before it bold.
• To use color you can use the following notation
  • \<color:red>Text\<color:end>