This package can be used for generating PDF invoices from Excel invoices.
Project description
Invoice PDF Generator
The Invoice PDF Generator is a Python package designed to simplify the process of creating PDF invoices from Excel invoice data. With this package, you can quickly generate professional-looking invoices for your business needs.
Features
- Easy to Use: Generate PDF invoices with just a few lines of Python code.
- Customizable: Customize the appearance of your invoices by specifying fonts, colors, and layouts.
- Excel Integration: Read invoice data directly from Excel files, making it easy to manage and update invoice information.
- Total Amount Calculation: Automatically calculate the total amount due based on the invoice data.
- Logo Support: Add your company logo to the invoice for branding purposes.
- Cross-Platform: Works seamlessly on Windows, macOS, and Linux.
Technologies Used
- fpdf: A library for creating PDF documents.
- openpyxl: A library for reading and writing Excel files.
- pandas: A data manipulation and analysis library.
- setuptools: A package development and distribution library.
- twine: A utility for publishing Python packages to PyPI.
Installation
You can install the Invoice PDF Generator package via pip:
pip install invoice_pdfgen
For more information and usage instructions, visit the PyPI page.
Usage
To use the Invoice PDF Generator package, follow these steps:
- Import the
PDFInvoiceGenerator
class from the package. - Create an instance of the
PDFInvoiceGenerator
class, providing the paths to the Excel invoice file and the company logo. - Generate the PDF invoice using the
generate()
method.
from invoice_pdfgen import PDFInvoiceGenerator
# Create an instance of PDFInvoiceGenerator
generator = PDFInvoiceGenerator(excel_filepath='invoice_data.xlsx', logo_filepath='company_logo.png')
# Generate the PDF invoice
generator.generate()
For more detailed usage instructions and examples, please refer to the examples directory.
Documentation
For more detailed documentation, including API references and usage examples, please visit the documentation.
Examples
Check out the examples directory for usage examples of the Invoice PDF Generator package.
Tests
The tests for the package can be found in the tests directory. You can run the tests using your preferred testing framework.
Contributing
Contributions are welcome! Here are some ways you can contribute to the project:
- Report bugs and issues
- Suggest new features or improvements
- Submit pull requests with bug fixes or enhancements
Author
License
This project is licensed under the MIT License, which grants permission for free use, modification, distribution, and sublicense of the code, provided that the copyright notice (attributed to emads22) and permission notice are included in all copies or substantial portions of the software. This license is permissive and allows users to utilize the code for both commercial and non-commercial purposes.
Please see the LICENSE file for more details.
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
Built Distribution
File details
Details for the file invoice_pdfgen-1.2.2.tar.gz
.
File metadata
- Download URL: invoice_pdfgen-1.2.2.tar.gz
- Upload date:
- Size: 5.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5d2cf042a867ff1a1506b936e5a0ca5b77f68bfdf6ef1e1505e2ff3e67b817e |
|
MD5 | f1855027a66cecf81ffacef807afc93d |
|
BLAKE2b-256 | afcb07a72fb82b1bd0cb40114a838e3b42fe46d914c1a18971a2a8b5d207a194 |
File details
Details for the file invoice_pdfgen-1.2.2-py3-none-any.whl
.
File metadata
- Download URL: invoice_pdfgen-1.2.2-py3-none-any.whl
- Upload date:
- Size: 5.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c661ab161431c98205f46e73cb739778efa3664f44b562a0f67889ab909cb8d5 |
|
MD5 | 954268499890d1b8cfba3e4c96e3866f |
|
BLAKE2b-256 | 5b7ba24538bf30ded8cfb2bf68af067fa279169db77f28baeabc61a08b005356 |