Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/strzibny/invoice_printer
Super simple PDF invoicing
https://github.com/strzibny/invoice_printer
command-line-tool invoice invoice-pdf pdf-generation pdf-invoice prawn server
Last synced: about 19 hours ago
JSON representation
Super simple PDF invoicing
- Host: GitHub
- URL: https://github.com/strzibny/invoice_printer
- Owner: strzibny
- License: mit
- Created: 2015-12-12T20:46:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-11T03:08:04.000Z (4 months ago)
- Last Synced: 2024-10-11T12:09:12.181Z (2 months ago)
- Topics: command-line-tool, invoice, invoice-pdf, pdf-generation, pdf-invoice, prawn, server
- Language: Ruby
- Homepage:
- Size: 4.6 MB
- Stars: 877
- Watchers: 23
- Forks: 71
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-ruby - InvoicePrinter - Super simple PDF invoicing in Ruby (built on top of Prawn). (PDF)
- awesome-pdf - printer
- Open-Source-Ruby-and-Rails-Apps - invoice_printer - Super simple PDF invoicing 🔥 ✅ 🚀 (Happy Exploring 🤘)
- awesome-starred - strzibny/invoice_printer - Super simple PDF invoicing (server)
README
Â
**Super simple PDF invoicing.** InvoicePrinter is a server, command line program and pure Ruby library to generate PDF invoices in no time. You can use Ruby or JSON as the invoice representation to build the final PDF.
## Philosophy
- **Simple**, no styling required, no calculation, no money formatting (bring your own)
- **Pure Ruby**, no dependency on system libraries or browsers
- **Fast**, so you can render invoices on the fly during requests
## Examples
| Simple invoice |
| -------------- |
| 
|
See more usecases in the `examples/` directory.
## Features
- A4 and US letter paper size
- Invoice/document name and number
- Purchaser and provider boxes with addresses and identificaton numbers
- Payment method box showing banking details including SWIFT and IBAN fields
- Issue/due dates box
- Configurable items' table with item description, breakdown, quantity, unit, price per unit, tax and item's total amount fields
- Description above the table
- Final subtotal/tax/total info box
- Page numbers
- Configurable field labels & sublabels (optional little labels)
- Configurable font file
- Logotype (as image scaled to fit 50px of height)
- Background (as image)
- Stamp & signature (as image)
- Note
- JSON format
- CLI
- Server
- Well tested
## Documentation
- [Installation](./docs/INSTALLATION.md)
- [Ruby library](./docs/LIBRARY.md)
- [Server](./docs/SERVER.md)
- [Command line](./docs/COMMAND_LINE.md)
## Support
I am developing InvoicePrinter as a free and MIT-licensed library for several years now.
Please consider [buying my book](https://deploymentfromscratch.com/) or [my Rails starter kit](https://businessclasskit.com/) so I can work more on Open Source.
## Contributing
Contributions are welcome. Make sure the tests are passing before submitting a PR:
```bash
$ bundle && bundle exec rake test
```
You can also quickly regenerate the examples if necessary:
```bash
$ ruby regenerate.rb
```
## Copyright
Copyright 2015-2024 © [Josef Strzibny](http://strzibny.name/). MIT licensed.