brena 0.0.2

Simple invoice generation.

Brena

Nerdy CLI invoice generator. Brena generates invoices based on a .toml file you define. You can do everything in the terminal. No need to open your browser and trouble yourself. Add a few lines and be done!

Why you might ask? Because I hate to leave the terminal - that's it!

Installation

To install it type:

pip install brena

and you are done. Brena depends on weasyprint, so you might be required to install additional requirements. Look at weasyprint docs. If you don't want to do that - check out the docker option.

Usage

If you have defined your brena.toml file (how to do it is shown below), then you can just:

brena

To generate all the invoices or

brena invoicecode1 invoicecode2

To generate only invoices with specific codes.

You can read a bit more about available commands after typing

brena --help

Config: brena.toml

Below you can see an example of the required brena.toml file. Brena expects this file to be found in current working directory.

[companies.default]  # important to keep it as default 
  name = "Name Of Your Company"
  address_line_1 = "Some streeet 8/10"
  address_line_2 = "11-111 Some City"
  nip = "Your tax id number here if any"
  language = "pl"
  bank_accounts = { PLN = "PL11 1111 1111 1111 1111", EUR = "PL11 1111 1111 1111 1111" }

[companies.someclient]
  name = "Some Client Sp. z o. o."
  address_line_1 = "Another street"
  address_line_2 = "01-111 Warsaw"
  nip = "Your clients tax id if any"


[[invoices]]
  code = "01/12/2020"
  company = "someclient"
  currency = "PLN" # this value needs to be found in bank_accounts keys
  language = "pl"  # for now we only support pl and en
  dates = { issued = "2020-12-25", sold = "2020-12-31", due_to = "2021-01-15"}

  [[invoices.positions]]
    name = "IT service"
    quantity = 1
    amount = 15000
    vat_stake = 23


[[invoices]]
  code = "02/12/2020"
  company = "someclient"
  currency = "EUR"
  language = "en"
  dates = { issued = "2020-12-25", sold = "2020-12-31", due_to = "2021-01-10"}

  [[invoices.positions]] 
    name = "IT services"
    quantity = 172.5
    amount = 85.2
    vat_stake = 23
  
  [[invoices.positions]] 
    name = "Additional invoice position"
    quantity = 1
    amount = 82
    vat_stake = 23

For now I only support toml, maybe yaml in the future. Why toml over yaml? No reason, just my preference in this case.

Dependencies

jinja2 toml WeasyPrint typer

Technology

This bases on toml, weasyprint and jinja2.

Toml is used for configuration. weasyprint gets the html template rendered to pdf. Lastly jinja2 to add some contexts here and there.

Formatting of the code is done using black, isort. flake8, autoflake and bandit to check for potential vulns.

Versioning is done with bumpversion. Patch for merges to develop, minor for merged to master. Merge to master means release to pypi.

And wonderful poetry as dependency manager.

CLI is done with typer <- wonderful CLI library.

I use type hinting where it's possible.

To start developing you need to install poetry pip install poetry and then just poetry install.

Docker

TODO

Known make commands

flake
isort
isort-inplace
bandit
black
linters
bumpversion
black-inplace
autoflake-inplace
format-inplace

Most important ones are make linters and make format-inplace. Before each commit it's required to run these checks.

License

MIT