https://github.com/adamwojt/invoicepy
personal accounting CLI tool
https://github.com/adamwojt/invoicepy
accounting cli finance invoice python tools
Last synced: 6 months ago
JSON representation
personal accounting CLI tool
- Host: GitHub
- URL: https://github.com/adamwojt/invoicepy
- Owner: adamwojt
- License: mit
- Created: 2021-11-23T02:12:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-29T18:24:40.000Z (over 4 years ago)
- Last Synced: 2025-10-27T09:27:34.429Z (8 months ago)
- Topics: accounting, cli, finance, invoice, python, tools
- Language: Python
- Homepage:
- Size: 188 KB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
invoicepy
=========
**CLI** invoice tool, store and print invoices as *pdf*. save companies and
customers for later use.
installation
------------
``` {.sourceCode .bash}
pip install invoicepy
```
> *see troubleshooting section below for common problems*
config
------
[config](src/invoicepy/schema/config.json) stores `companies` and `customers` by alias and [invoices](src/invoicepy/schema/invoice.json).
`custom_templates_dir` is available for customising templates.
write [sample config](src/invoicepy/config/sample_config.json) with:
``` {.sourceCode .bash}
invoicepy sample-config
# then customize it in $HOME/.invoicepy.conf
```
examples
--------
1. print pdf saving it in current directory, result is invoice nr. BAR001
``` {.sourceCode .bash}
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.
2. below example won't save invoice in config, open in it 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
---
``` {.sourceCode .}
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
```
**pdf**
```
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. `yyyy-mm-dd` format
-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](https://jinja.palletsprojects.com/en/3.0.x/) templating language.
schema
------
- [schema/invoice.json](src/invoicepy/schema/invoice.json)
- [schema/config.json](src/invoicepy/schema/config.json)
troubleshooting
---------------
| Problem|Solution|
|--------|--------|
| `invoicepy: command not found`| Your distro didn't append python bin folder to your PATH. You can check where package lives with `pip3 show invoicepy` and add appropriate path. Example in your .bashrc: `export PATH="$PATH:$HOME/.local/bin"`|
|`OSError: encoder jpeg2k not available`| This is caused by pillow needing some extra libs, on Ubuntu: `sudo apt-get install libjpeg8-dev` then `pip install --no-cache-dir -I pillow`. On other distros find `libjpeg8-dev` equiavilent or google around for solutions regarding pillow.|
|`sample-config` says `Aborting` and exists| Fixed in `0.1.1`|
contributing
------------
if you written cool new template or improved some features, feel free to fork and PR. See [contributing guidelines](CONTRIBUTING.md).
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](https://github.com/audreyr/cookiecutter) and the
[johanvergeer/cookiecutter-poetry](https://github.com/johanvergeer/cookiecutter-poetry)
project template.
Template taken from here and slightly modified:
Licence
-------
Free software: MIT license