# Invoicing-Python-Package
> excel-invoice-to-pdf
## Overview
`excel-invoice-to-pdf` is a Python package that allows users to easily convert Excel invoices into PDF format. This package supports the processing of multiple Excel files stored in a directory, converting them into PDFs with the same filenames as the original Excel files. The PDF invoices include a company logo and display the total price of the products in a neatly formatted table.
This package is available on PyPI, and you can install it using:
```bash
pip install excel-invoice-to-pdf
```
## Features
- Converts multiple Excel invoices into PDFs.
- Preserves the exact names of the original Excel files in the generated PDFs.
- Includes a company logo on each invoice.
- Displays essential details like invoice number, date, and total price in the PDF.
- Automatically creates the destination directory for PDF files if it does not exist.
- Licensed under the MIT License.
## Installation
To install the package, simply run:
```bash
pip install excel-invoice-to-pdf
```
## Usage
After installing the package, you can import and use it in your Python project as follows:
```python
import invoicing
# or
from invoicing import invoice
```
## Example Usage
The `invoice` module contains a `generate` function that converts Excel invoices into PDF files. Here is how you can use it:
```python
from invoicing import invoice
invoice.generate(
invoices_path="path_to_excel_invoices_folder",
pdfs_path="path_to_output_pdfs_folder",
logo_image_path="path_to_company_logo_image",
product_id_col="Product ID",
product_name_col="Product Name",
amount_purchased_col="Amount Purchased",
price_per_unit_col="Price per Unit",
total_price_col="Total Price"
)
```
## Parameters
- `invoices_path`: The directory where Excel invoice files are stored.
- `pdfs_path`: The directory where the generated PDF invoices will be stored.
- `logo_image_path`: The path to the company logo image file to be included in the PDFs.
- `product_id_col`: The column name in the Excel files containing the product IDs.
- `product_name_col`: The column name in the Excel files containing the product names.
- `amount_purchased_col`: The column name in the Excel files containing the quantities of purchased products.
- `price_per_unit_col`: The column name in the Excel files containing the price per unit.
- `total_price_col`: The column name in the Excel files containing the total price of products.
The function will process all Excel files in the specified invoices_path, generate PDFs with the same names as the Excel files, and save them in the pdfs_path folder. If the pdfs_path directory does not exist, it will be created automatically.
## License
This package is open-source and available under the MIT License.
## Contribute
Developers are welcome to contribute, suggest new features, or report issues.
To contribute:
1. Fork the repository.
2. Create a new branch with your feature or fix.
3. Submit a pull request for review.
You can check out the source code and additional documentation on PyPI:
[excel-invoice-to-pdf on PyPI](https://pypi.org/project/excel-invoice-to-pdf/)
[excel-invoice-to-pdf on Github](https://github.com/Mahdi-Meyghani/Invoicing-Python-Package/)
Feel free to contribute and help improve the package!
Enjoy using `excel-invoice-to-pdf`!
Raw data
{
"_id": null,
"home_page": "https://github.com/Mahdi-Meyghani/Invoicing-Python-Package",
"name": "excel-invoice-to-pdf",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "invoice, excel, pdf",
"author": "Mahdi Meyghani",
"author_email": "mahdimeyghani02@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ef/7e/5db3757f04bac90b5728a998efed83d20cafc6e6008a29928e70636d29d5/excel-invoice-to-pdf-1.0.2.tar.gz",
"platform": null,
"description": "# Invoicing-Python-Package\r\n> excel-invoice-to-pdf\r\n\r\n\r\n## Overview\r\n\r\n`excel-invoice-to-pdf` is a Python package that allows users to easily convert Excel invoices into PDF format. This package supports the processing of multiple Excel files stored in a directory, converting them into PDFs with the same filenames as the original Excel files. The PDF invoices include a company logo and display the total price of the products in a neatly formatted table. \r\n\r\nThis package is available on PyPI, and you can install it using:\r\n\r\n```bash\r\npip install excel-invoice-to-pdf\r\n```\r\n## Features\r\n- Converts multiple Excel invoices into PDFs.\r\n- Preserves the exact names of the original Excel files in the generated PDFs.\r\n- Includes a company logo on each invoice.\r\n- Displays essential details like invoice number, date, and total price in the PDF.\r\n- Automatically creates the destination directory for PDF files if it does not exist.\r\n- Licensed under the MIT License.\r\n\r\n## Installation\r\nTo install the package, simply run:\r\n```bash\r\npip install excel-invoice-to-pdf\r\n```\r\n\r\n## Usage\r\nAfter installing the package, you can import and use it in your Python project as follows:\r\n\r\n```python\r\nimport invoicing\r\n# or\r\nfrom invoicing import invoice\r\n```\r\n\r\n## Example Usage\r\nThe `invoice` module contains a `generate` function that converts Excel invoices into PDF files. Here is how you can use it:\r\n```python\r\nfrom invoicing import invoice\r\n\r\ninvoice.generate(\r\n invoices_path=\"path_to_excel_invoices_folder\",\r\n pdfs_path=\"path_to_output_pdfs_folder\",\r\n logo_image_path=\"path_to_company_logo_image\",\r\n product_id_col=\"Product ID\",\r\n product_name_col=\"Product Name\",\r\n amount_purchased_col=\"Amount Purchased\",\r\n price_per_unit_col=\"Price per Unit\",\r\n total_price_col=\"Total Price\"\r\n)\r\n```\r\n\r\n## Parameters\r\n- `invoices_path`: The directory where Excel invoice files are stored.\r\n- `pdfs_path`: The directory where the generated PDF invoices will be stored.\r\n- `logo_image_path`: The path to the company logo image file to be included in the PDFs.\r\n- `product_id_col`: The column name in the Excel files containing the product IDs.\r\n- `product_name_col`: The column name in the Excel files containing the product names.\r\n- `amount_purchased_col`: The column name in the Excel files containing the quantities of purchased products.\r\n- `price_per_unit_col`: The column name in the Excel files containing the price per unit.\r\n- `total_price_col`: The column name in the Excel files containing the total price of products.\r\n\r\nThe function will process all Excel files in the specified invoices_path, generate PDFs with the same names as the Excel files, and save them in the pdfs_path folder. If the pdfs_path directory does not exist, it will be created automatically.\r\n\r\n## License\r\nThis package is open-source and available under the MIT License.\r\n\r\n## Contribute\r\n\r\nDevelopers are welcome to contribute, suggest new features, or report issues. \r\n\r\nTo contribute:\r\n\r\n1. Fork the repository.\r\n2. Create a new branch with your feature or fix.\r\n3. Submit a pull request for review.\r\n\r\nYou can check out the source code and additional documentation on PyPI:\r\n\r\n[excel-invoice-to-pdf on PyPI](https://pypi.org/project/excel-invoice-to-pdf/)\r\n\r\n[excel-invoice-to-pdf on Github](https://github.com/Mahdi-Meyghani/Invoicing-Python-Package/)\r\n\r\nFeel free to contribute and help improve the package!\r\n\r\nEnjoy using `excel-invoice-to-pdf`!\r\n\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Convert your Excel invoices into Pdf invoices.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/Mahdi-Meyghani/Invoicing-Python-Package"
},
"split_keywords": [
"invoice",
" excel",
" pdf"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef7e5db3757f04bac90b5728a998efed83d20cafc6e6008a29928e70636d29d5",
"md5": "1ab973c0158c75bfe0252b1d597cf850",
"sha256": "bccd9f90ffcd07ceccb0c0c0e5e26ee8cf47df3278d71e0ae91a68d39ac62ef7"
},
"downloads": -1,
"filename": "excel-invoice-to-pdf-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "1ab973c0158c75bfe0252b1d597cf850",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4686,
"upload_time": "2024-08-18T21:27:34",
"upload_time_iso_8601": "2024-08-18T21:27:34.465463Z",
"url": "https://files.pythonhosted.org/packages/ef/7e/5db3757f04bac90b5728a998efed83d20cafc6e6008a29928e70636d29d5/excel-invoice-to-pdf-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 21:27:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Mahdi-Meyghani",
"github_project": "Invoicing-Python-Package",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "excel-invoice-to-pdf"
}
JSON
