invoicepy
CLI invoice tool, store and print invoices as pdf. save companies and customers for later use.
installation
pip install invoicepy
config
config stores companies and customers by alias and invoices. custom_templates_dir is available for customising templates.
write sample config with:
invoicepy sample-config
# then customize it in $HOME/.invoicepy.conf
examples
- print pdf saving it in current directory, result is invoice nr. BAR001
invoicepy pdf --company foo --customer bar --line '{"price":10, "qty": 20, "name":"1h services"}' --series BAR
when above is repeated twice, the invoices numers will increase, BAR002, BAR003. this is calculated per series. see below for more options.
- below example won't save invoice in config, open in in browser and use custom template specified in
custom_templates_dir:
invoicepy pdf --company foo --customer bar --line ... -b --no-save --series BAR --number 25 --curency USD --template my_custom_template.html
cli
invoicepy [OPTIONS] COMMAND [ARGS]...
Options:
-C, --config PATH
--help Show this message and exit.
Commands:
sample-config generate sample config in home dir
pdf prints pdf to given path
Options:
-l, --line TEXT json string of invoice line, can pass multiple. ex:
--line '{"price":15, "qty": 100, "name":"1h cleaning
services", "vat": 21}' --line ... [required]
The fields are as follows:
`price` - price of product
`qty` - quantity of product
`name` - name of product
`vat` - vat rate %
-c, --company TEXT company alias as in configuration. [required]
-r, --customer TEXT customer alias as in configuration. [required]
-d, --date TEXT invoice date, `create_date` field.
-e, --due-date TEXT If due date is not provided, `payment_term_days` is
used to calculate it.
-s, --series TEXT invoice series [required]
-n, --number INTEGER invoice number, if not provided, it will calculated
from company config for given series.
-u, --currency TEXT currency, default=EUR
-o, --output PATH output path, can be new filepath, directory. If it's
not provided the invoice pdf will be saved in current
directory.
-t, --template TEXT template name, ex. simple.html. `custom_templates_dir`
will be searched first, then package templates.
--save / --no-save decides whether to store invoice in config file.
-b, --browser open generated invoice in browser.
--help show this message and exit.
templates
currently two templates are available:
simple.html- simple english template (default).simple_lt.html- simple lithuanian/english template.
you can pass your own template name with -t. see custom_templates_dir (config section). have a look on schema below in case you want to write your own templates. templates are written in html and use jinja2 templating language.
schema
contributing
if you written cool new template or improved some features, feel free to fork and PR. See contributing guidelines.
to-dos
- use babel for translations and locale
- extend tests
- consider moving config to yaml
- backup copy config on start
- invoices should have unique ids (maybe companies and customers too?)
- view saved invoices
- reprint saved invoices (?)
- package for arch (AUR)
Credits
This package was created with Cookiecutter and the johanvergeer/cookiecutter-poetry project template.
Template taken from here and slightly modified: https://github.com/sparksuite/simple-html-invoice-template
Licence
Free software: MIT license
76 Dec 12, 2022
4.9k Jan 4, 2023
49 Nov 7, 2022
131 Dec 16, 2022
5 Apr 2, 2022
2.9k Jan 1, 2023
651 Jan 1, 2023
73 Dec 19, 2022
49 Dec 27, 2022
1 Feb 14, 2022
3 Apr 23, 2022
1 Nov 04, 2021
1.2k Jan 04, 2023
387 Dec 10, 2022
2 Apr 20, 2022
394 Dec 30, 2022
51 Sep 22, 2022
3 Mar 12, 2022
1 Nov 08, 2020
3.3k Jan 06, 2023
242 Jan 04, 2023
3 May 30, 2022
2 Dec 17, 2021
22 Nov 21, 2022
20 Nov 25, 2022
1 Nov 01, 2021