# Invoice Conversion Package
## Description
The `invoice_conversion` package provides a seamless way to convert Excel invoice files into a PDF format. Whether you have a business or personal invoices that need converting, this tool streamlines the process, presenting you with a professional-looking PDF invoice.
## Table of Contents
- [Invoice Conversion Package](#invoice-conversion-package)
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Future Enhancements](#future-enhancements)
- [Issues](#issues)
- [License](#license)
## Installation
To install the package, use `pip`:
```bash
pip install invoice_conversion
```
Please before you proceed, make sure you have the following dependencies installed:
- pandas
- fpdf
They can be installed using `pip`:
```bash
pip install pandas fpdf
```
## Usage
Here's a basic usage guide:
1. Import the package:
```python
from invoice_conversion import InvoicePDF
```
2. Instantiate the `InvoicePDF` class:
```python
invoice_pdf_generator = InvoicePDF(
invoices_path="path/to/excel/invoices",
pdfs_path="path/to/output/pdf",
company_name="Your Company Name",
logo_path="path/to/company/logo.png"
)
```
3. Next use the `generate_all` method to generate PDFs:
```python
invoice_pdf_generator.generate_all(
product_id="product_id_column_name",
product_name="product_name_column_name",
amount_purchased="amount_purchased_column_name",
price_per_unit="price_per_unit_column_name",
total_price="total_price_column_name"
)
```
Make sure to **replace the placeholders** in the function call with **appropriate paths** and **column names** from your **Excel invoices**.
## Contributing
We welcome contributions! If you'd like to contribute, please go ahead and fork the repository, make your suggested changes, and open a pull request.
## Future Enhancements
- Support for multiple currencies.
- OCR (Optical Character Recognition) integration to automatically detect columns in the Excel sheets.
- Customizable PDF templates to allow users more control over the appearance of the output PDF.
- A user-friendly GUI application for less tech-savvy users.
## Issues
If you encounter any issues while using the package or have any feature requests, please visit the [issues page](https://github.com/apotitech/invoice_conversion/issues) of our GitHub repository. We appreciate your feedback and will strive to address any concerns promptly.
## License
This project is licensed under the MIT License. For more details, please see the LICENSE file in the repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/apotitech/invoice_conversion",
"name": "invoice-conversion",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "excel,pdf,invoice,invoice converter,invoice conversion",
"author": "Lionel Tchami",
"author_email": "lionel@apotitech.com",
"download_url": "https://files.pythonhosted.org/packages/98/f8/2b28485be1e862313015499b4b2fb4d16e44dd4647fa73470de9b378671e/invoice_conversion-1.0.0.tar.gz",
"platform": null,
"description": "# Invoice Conversion Package\r\n\r\n## Description\r\n\r\nThe `invoice_conversion` package provides a seamless way to convert Excel invoice files into a PDF format. Whether you have a business or personal invoices that need converting, this tool streamlines the process, presenting you with a professional-looking PDF invoice.\r\n\r\n## Table of Contents\r\n\r\n- [Invoice Conversion Package](#invoice-conversion-package)\r\n - [Description](#description)\r\n - [Table of Contents](#table-of-contents)\r\n - [Installation](#installation)\r\n - [Usage](#usage)\r\n - [Contributing](#contributing)\r\n - [Future Enhancements](#future-enhancements)\r\n - [Issues](#issues)\r\n - [License](#license)\r\n\r\n## Installation\r\n\r\nTo install the package, use `pip`:\r\n\r\n```bash\r\npip install invoice_conversion\r\n```\r\n\r\nPlease before you proceed, make sure you have the following dependencies installed:\r\n\r\n- pandas\r\n- fpdf\r\n\r\nThey can be installed using `pip`:\r\n\r\n```bash\r\npip install pandas fpdf\r\n```\r\n\r\n## Usage\r\n\r\nHere's a basic usage guide:\r\n\r\n1. Import the package:\r\n \r\n ```python\r\n from invoice_conversion import InvoicePDF\r\n ```\r\n\r\n2. Instantiate the `InvoicePDF` class:\r\n\r\n ```python\r\n invoice_pdf_generator = InvoicePDF(\r\n invoices_path=\"path/to/excel/invoices\",\r\n pdfs_path=\"path/to/output/pdf\",\r\n company_name=\"Your Company Name\",\r\n logo_path=\"path/to/company/logo.png\"\r\n )\r\n ```\r\n\r\n3. Next use the `generate_all` method to generate PDFs:\r\n \r\n ```python\r\n invoice_pdf_generator.generate_all(\r\n product_id=\"product_id_column_name\",\r\n product_name=\"product_name_column_name\",\r\n amount_purchased=\"amount_purchased_column_name\",\r\n price_per_unit=\"price_per_unit_column_name\",\r\n total_price=\"total_price_column_name\"\r\n )\r\n ```\r\n\r\nMake sure to **replace the placeholders** in the function call with **appropriate paths** and **column names** from your **Excel invoices**.\r\n\r\n## Contributing\r\n\r\nWe welcome contributions! If you'd like to contribute, please go ahead and fork the repository, make your suggested changes, and open a pull request.\r\n\r\n## Future Enhancements\r\n\r\n- Support for multiple currencies.\r\n- OCR (Optical Character Recognition) integration to automatically detect columns in the Excel sheets.\r\n- Customizable PDF templates to allow users more control over the appearance of the output PDF.\r\n- A user-friendly GUI application for less tech-savvy users.\r\n\r\n## Issues\r\n\r\nIf you encounter any issues while using the package or have any feature requests, please visit the [issues page](https://github.com/apotitech/invoice_conversion/issues) of our GitHub repository. We appreciate your feedback and will strive to address any concerns promptly.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License. For more details, please see the LICENSE file in the repository.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A simple utility to convert Excel-based invoices to PDF format.",
"version": "1.0.0",
"project_urls": {
"Bug Reports": "https://github.com/apotitech/invoice_conversion/issues",
"Homepage": "https://github.com/apotitech/invoice_conversion",
"Source": "https://github.com/apotitech/invoice_conversion"
},
"split_keywords": [
"excel",
"pdf",
"invoice",
"invoice converter",
"invoice conversion"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98f82b28485be1e862313015499b4b2fb4d16e44dd4647fa73470de9b378671e",
"md5": "40d5ea8de4f550265fb082b31ea34019",
"sha256": "783232d704432fea0083a6d027b3c614e0bc9d4a17aa37aa2b60defbb1b3f4f1"
},
"downloads": -1,
"filename": "invoice_conversion-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "40d5ea8de4f550265fb082b31ea34019",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3988,
"upload_time": "2023-09-12T22:39:42",
"upload_time_iso_8601": "2023-09-12T22:39:42.852688Z",
"url": "https://files.pythonhosted.org/packages/98/f8/2b28485be1e862313015499b4b2fb4d16e44dd4647fa73470de9b378671e/invoice_conversion-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-12 22:39:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apotitech",
"github_project": "invoice_conversion",
"github_not_found": true,
"lcname": "invoice-conversion"
}
JSON
