https://github.com/guyzmo/clait
Command Line Accounting & Invoicing Tool
https://github.com/guyzmo/clait
Last synced: 9 months ago
JSON representation
Command Line Accounting & Invoicing Tool
- Host: GitHub
- URL: https://github.com/guyzmo/clait
- Owner: guyzmo
- License: gpl-3.0
- Created: 2016-10-07T21:52:46.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-04-29T22:50:34.000Z (over 5 years ago)
- Last Synced: 2025-03-24T05:05:18.113Z (10 months ago)
- Language: Python
- Homepage:
- Size: 111 KB
- Stars: 13
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Clait
A tool to generate nicely formatted and LaTeX generated invoices.
## How to install?
just run:
pip3 install .
## How to develop?
virtualenv var
var/bin/pip3 install -r requirements.txt
var/bin/pip3 install -e .
you'll find the tool in:
var/bin/clait
## External dependency
you need to make sure you have installed the texlive suite, along with
the `pdflatex` tool. No special LaTeX library is needed.
## How to use?
create a directory such as `paperwork`, within it create two files:
`invoices_config.yaml`:
that will contain the name of the template (`format` key) the path to the pdflatex tool,
and in `source` all the custom information for your billing.
```
format: french
prefix:
invoice: FA
quote: DV
source:
name: Ford Prefect
address:
- Hyperspace bypass
- Earth
telephone: +44 777 7777 7777
website: http://mostly.harmless.com
email: ford.prefect@mostly.harmless.com
siren: 111 222 333
ape: 9602A
payment_delay: 30 jours
bank:
rib:
- 00001
- 00002
- 00000000001
- 42
iban: FR42 0000 1000 0200 0000 0000 142
bics: FOOBARFUBAR
tools:
pdflatex: /usr/local/texlive/2014/bin/universal-darwin/pdflatex
```
`invoices_list.yaml`:
that will contain a list of `!invoice` objects. The `iid` will be the unique reference
of the invoice. Then all the elements are as defined by the template.
```
- !invoice
iid: 201410-001
date: 2014-10-02
kind: paid
customer: !customer
address: [Alpha du centaure]
name: Zaphod Beeblebrox
subject: Voyage en dauphin
desc: "Pr\xE9paration et embarquation sur un dauphin \xE0 travers les mers"
place: Babylon
products:
- !product
descr: Soutien psychologique du dauphin
price: 430
qty: 1
- !offer
descr: Discount because I'm nice
price: 20
qty: 1
```
## How to run?
To generate all your invoices, in the `paperwork` directory:
clait -d paperwork generate
If you want your tax calculation:
clait -d paperwork results quarterly
clait -d paperwork results yearly
And finally, to launch the webapp, use
clait -d paperwork api
If you've made a change to an invoice and need to regenerate, just remove
the pdf file!
## How will it look like?
here's a shot of one of the example invoices:
## License
This code is licensed under the GPLv3.