# Invoice PDF Generator
[](https://github.com/emads22/invoice-pdfgen-python/blob/main/LICENSE)
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:
```bash
pip install invoice_pdfgen
```
For more information and usage instructions, visit the [PyPI page](https://pypi.org/project/invoice-pdfgen/).
## Usage
To use the Invoice PDF Generator package, follow these steps:
1. Import the `PDFInvoiceGenerator` class from the package.
2. Create an instance of the `PDFInvoiceGenerator` class, providing the paths to the Excel invoice file and the company logo.
3. Generate the PDF invoice using the `generate()` method.
```python
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](https://github.com/emads22/invoice-pdfgen-python/blob/main/examples) directory.
## Documentation
For more detailed documentation, including API references and usage examples, please visit the [documentation](https://github.com/emads22/invoice-pdfgen-python/blob/main/docs/index.md).
## Examples
Check out the [examples](https://github.com/emads22/invoice-pdfgen-python/blob/main/examples) directory for usage examples of the Invoice PDF Generator package.
## Tests
The tests for the package can be found in the [tests](https://github.com/emads22/invoice-pdfgen-python/blob/main/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
- Emad E>
[<img src="https://img.shields.io/badge/GitHub-Profile-blue?logo=github" width="150">](https://github.com/emads22)
## 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](https://github.com/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](https://github.com/emads22/invoice-pdfgen-python/blob/main/LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/emads22/invoice-pdfgen-python",
"name": "invoice-pdfgen",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "invoice, excel, pdf, invoice_pdf_gen, invoice_gen",
"author": "Emad",
"author_email": "emadsaab222@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c7/42/90b9a97fc3fa669b7267160d8f6fdf4bf49fc84116b54e94a3e07f433fd2/invoice_pdfgen-1.2.3.tar.gz",
"platform": null,
"description": "# Invoice PDF Generator\r\n\r\n[](https://github.com/emads22/invoice-pdfgen-python/blob/main/LICENSE)\r\n\r\n\r\n\r\nThe 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.\r\n\r\n## Features\r\n- **Easy to Use**: Generate PDF invoices with just a few lines of Python code.\r\n- **Customizable**: Customize the appearance of your invoices by specifying fonts, colors, and layouts.\r\n- **Excel Integration**: Read invoice data directly from Excel files, making it easy to manage and update invoice information.\r\n- **Total Amount Calculation**: Automatically calculate the total amount due based on the invoice data.\r\n- **Logo Support**: Add your company logo to the invoice for branding purposes.\r\n- **Cross-Platform**: Works seamlessly on Windows, macOS, and Linux.\r\n\r\n## Technologies Used\r\n- **fpdf**: A library for creating PDF documents.\r\n- **openpyxl**: A library for reading and writing Excel files.\r\n- **pandas**: A data manipulation and analysis library.\r\n- **setuptools**: A package development and distribution library.\r\n- **twine**: A utility for publishing Python packages to PyPI.\r\n\r\n## Installation\r\nYou can install the Invoice PDF Generator package via pip:\r\n\r\n```bash\r\npip install invoice_pdfgen\r\n```\r\n\r\nFor more information and usage instructions, visit the [PyPI page](https://pypi.org/project/invoice-pdfgen/).\r\n\r\n## Usage\r\nTo use the Invoice PDF Generator package, follow these steps:\r\n\r\n1. Import the `PDFInvoiceGenerator` class from the package.\r\n2. Create an instance of the `PDFInvoiceGenerator` class, providing the paths to the Excel invoice file and the company logo.\r\n3. Generate the PDF invoice using the `generate()` method.\r\n\r\n```python\r\nfrom invoice_pdfgen import PDFInvoiceGenerator\r\n\r\n# Create an instance of PDFInvoiceGenerator\r\ngenerator = PDFInvoiceGenerator(excel_filepath='invoice_data.xlsx', logo_filepath='company_logo.png')\r\n\r\n# Generate the PDF invoice\r\ngenerator.generate()\r\n```\r\n\r\nFor more detailed usage instructions and examples, please refer to the [examples](https://github.com/emads22/invoice-pdfgen-python/blob/main/examples) directory.\r\n\r\n## Documentation\r\nFor more detailed documentation, including API references and usage examples, please visit the [documentation](https://github.com/emads22/invoice-pdfgen-python/blob/main/docs/index.md).\r\n\r\n## Examples\r\nCheck out the [examples](https://github.com/emads22/invoice-pdfgen-python/blob/main/examples) directory for usage examples of the Invoice PDF Generator package.\r\n\r\n## Tests\r\nThe tests for the package can be found in the [tests](https://github.com/emads22/invoice-pdfgen-python/blob/main/tests) directory. You can run the tests using your preferred testing framework.\r\n\r\n## Contributing\r\nContributions are welcome! Here are some ways you can contribute to the project:\r\n- Report bugs and issues\r\n- Suggest new features or improvements\r\n- Submit pull requests with bug fixes or enhancements\r\n\r\n## Author\r\n- Emad E>\r\n \r\n [<img src=\"https://img.shields.io/badge/GitHub-Profile-blue?logo=github\" width=\"150\">](https://github.com/emads22)\r\n\r\n## License\r\nThis 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](https://github.com/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.\r\n\r\nPlease see the [LICENSE](https://github.com/emads22/invoice-pdfgen-python/blob/main/LICENSE) file for more details.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "This package can be used for generating PDF invoices from Excel invoices.",
"version": "1.2.3",
"project_urls": {
"Homepage": "https://github.com/emads22/invoice-pdfgen-python"
},
"split_keywords": [
"invoice",
" excel",
" pdf",
" invoice_pdf_gen",
" invoice_gen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d36c0715a3e5e39228c6d10c5db43562df1700817a8b98d3d5c22188c032c8b",
"md5": "c52b1f78818fc64e61885ff747f5d923",
"sha256": "a57eec905d946acde4b036db753338c4e2de0c1d0bfc67b32c85b6b1688cf51c"
},
"downloads": -1,
"filename": "invoice_pdfgen-1.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c52b1f78818fc64e61885ff747f5d923",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5762,
"upload_time": "2024-07-12T14:02:12",
"upload_time_iso_8601": "2024-07-12T14:02:12.385544Z",
"url": "https://files.pythonhosted.org/packages/1d/36/c0715a3e5e39228c6d10c5db43562df1700817a8b98d3d5c22188c032c8b/invoice_pdfgen-1.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c74290b9a97fc3fa669b7267160d8f6fdf4bf49fc84116b54e94a3e07f433fd2",
"md5": "622032703224ce25895853dcf6e12f63",
"sha256": "f801204f772280deaa810a65d55c66f28ed402dca562ed6a9cd700969c8e9ef4"
},
"downloads": -1,
"filename": "invoice_pdfgen-1.2.3.tar.gz",
"has_sig": false,
"md5_digest": "622032703224ce25895853dcf6e12f63",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5865,
"upload_time": "2024-07-12T14:02:14",
"upload_time_iso_8601": "2024-07-12T14:02:14.269084Z",
"url": "https://files.pythonhosted.org/packages/c7/42/90b9a97fc3fa669b7267160d8f6fdf4bf49fc84116b54e94a3e07f433fd2/invoice_pdfgen-1.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-12 14:02:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "emads22",
"github_project": "invoice-pdfgen-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "invoice-pdfgen"
}
JSON
