/invoice-generator

An invoice generator app that calculates consumption from inverter yield and export data

Primary LanguageRustGNU General Public License v3.0GPL-3.0

Invoice Generator

This invoice generator is a binary application that calculates power consumption based on inverter yield and export data. The front end was made using the GTK-RS library.

Installation (for MacOSX)

  1. From the Terminal, download Rustup and install Rust.

  2. Download and install the GTK 4 and Libadwaita packages (requires Homebrew).

brew install gtk4 libadwaita

Compilation

  • Change the current directory to the project directory and build the app (for the host platform):
cd <project-directory>
cargo build --release

To compile the app in debug mode, omit the --release flag. To compile and run the app in debug mode execute cargo run.

Usage

Preparation

  • Combine all the required yield and revenue summaries into a single MS Excel workbook (XSLX file extension) with the same shared headers.

Interacting with the App

  • Go to <project-directory>/target/release and run the executable.

Main window

  • Open the respective combined summary workbook by clicking on Open Records.
  • Open a new window where hours can be entered by clicking on Enter Hours, or open an existing CSV file containing the respective hour values and headings. This must match the layout seen in the Hours window.
  • The text entries next to or below each button will populate with the path to the respective files. These entries are read-only.
  • Click the Generate button to generate an invoice from the given data, selecting a location for the saved file from the dialog that pops up.
  • The Generate button will not become sensitive until both entries are populated with paths to files with appropriate file extensions (i.e., XLSX for records and CSV for hours).

Hours window

  • Enter peak and off-peak hours in the table, providing start and end values for each day.
  • Off-peak start and off-peak end hours are required for each day.
  • Hour values are relative to the 24-hour clock; thus a value of 0 corresponds to 00h00 (12 a.m.) and value of 23 corresponds to 23h00 (11 p.m.), etc.
  • Click the Save button to save an hours file, selecting its location from the dialog that pops up.
  • The Save button will not become sensitive until these entries are populated with valid hour values (i.e., numbers from 0 to 23).

License

GNU GPLv3