Skip to main content

Commandline tool to generate HTML-based and PDF invoices.

Project description

PRs Welcome Code style: black

PyInvoicer

Commandline tool to generate HTML-based and PDF invoices.

PyInvoicer is a light-weight commandline tool written in Python to generate HTML-based and PDF invoices. The usage is very straightforward and easy to use: prepare your invoice content in YAML as the input of PyInvoicer. That's it!! No complicated setup like database is needed.

Quick highlights:

  • run locally
  • content of input in YAML
  • output html and pdf
  • use as less third party dependency as possible

Invoice Screenshot Generated by PyInvoicer.

Getting Started

Prerequisites

The release has been tested with Python 3.9.1.

Installation

The tool has been released to PyPI. You can install it directly from PyPI via pip.

pip install pyinvoicer

If you want to install from the source, you may need poetry, the package dependency management tool. This project is managed by poetry. Fetch the source and poetry install. See Contributing for more details.

Usage

invoicer <your content yaml>

You will get invoice.pdf in the same folder. The examples folder of the source shows an example of the content yaml.

Output in Different Format

For example, if you want to output your invoice in html, invoke:

invoicer <your content yaml> --format html

Output with Customized Name and Path

invoicer <your content yaml> /path/you/want/to/use/your-invoice.pdf

More Usage Options

Please refer to invoicer --help.

Contributing

See Contributing

Authors

Taihsiang Ho (tai271828) tai271828@gmail.com

Created from Lee-W/cookiecutter-python-template version 0.7.2

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

pyinvoicer-0.0.3.tar.gz (7.6 kB view hashes)

Uploaded Source

Built Distribution

pyinvoicer-0.0.3-py3-none-any.whl (8.1 kB view hashes)

Uploaded Python 3

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