Skip to main content

No project description provided

Project description

Python interface for invoice generation

Simple utility for PDF invoice generation in Python

Setup

  1. Install the module
  2. Copy config/config.example.yaml from the repository to config/config.yaml and update parameter values as desired
  3. Optionally configure terms by creating a translations/terms.[language].yaml file, check out the example file config/terms.example.yaml

Usage

  1. Generate an invoice object eg. invoice = Invoice(invoice_id, invoice_date <YY-mm-dd>, customer_id, customer_name, customer_address, customer_postal_code, customer_city, customer_country, customer_vat_registered_number, vat_percentage)
  2. Set article lines by using the set_articles() method on the invoice object. Example [{'name': 'Pizza margherita', 'price': 9.99, 'amount': 1}, {'name': 'Pizza fungi', 'price': 11.99, 'amount': 1}]
  3. Generate an InvoicePDF object eg. pdf = InvoicePDF(invoice <the invoice object>, invoice_language <the desired print language>)
  4. Generate the PDF by running the generate_document() method on the invoicepdf object

Translations

Translations can be overwritten by copying the translation file into /translations folder

Contribution

Feel free or make proposals for code contributions and the addition of translation files for additional language support in this repository

Credits

Big thanks to Pluralsight (https://www.pluralsight.com) and Chart Explorers (https://www.youtube.com/@ChartExplorers) for the detailed descriptions on working with the used techniques

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pdf_invoice_util-0.0.1.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

pdf_invoice_util-0.0.1-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file pdf_invoice_util-0.0.1.tar.gz.

File metadata

  • Download URL: pdf_invoice_util-0.0.1.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pdf_invoice_util-0.0.1.tar.gz
Algorithm Hash digest
SHA256 1e06cc4212494ef8681f18912492f92ac224d6a3e56bd7eecc5c7782e1d4cd0e
MD5 ecf30650802c11a5b908917498ce2a0c
BLAKE2b-256 a3c6abae1e3d708f5b0f4b7a55c5ae62d34a656fab81414faf4f87cd29986101

See more details on using hashes here.

File details

Details for the file pdf_invoice_util-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pdf_invoice_util-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6b63498f13a6d5160ffd63ebc0715b1b041df477465313ba91c258af4984ceac
MD5 cd29033e409aba0e49bb0c16030d7d04
BLAKE2b-256 18360348e69fb302adcea979369daf8e070a8adcb5ec03f56dbc78ce36bf72b7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page