MyCompta

MyCompta allows you to generate invoices and quotation automatically (pdf) thanks to clients defined on the website

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You need to have installed the list bellow on your system:

python3
flask
pdfkit
flask_babel

$ sudo apt install python3 python3-pip
$ pip3 install flask pdfkit flask_babel

Installing

To install the program, please perform the following steps.

clone repository git clone https://github.com/LegallGuillaume/MyCompta.git
Modify DB_PATH in website/settings/config.py with the absolute path to DB file
run init python3 manage.py --init

Run the test to make sure the code works perfectly

Running the tests

There are 2 tests available in this repository. the first one allows to test all python classes and objects unit test (exclude website). The second allows to test all functions functional test (exclude website)

Unit test

These tests check if there are no regression only with object creation (exclude website)

$ python3 manage.py --testunit
$ echo $?

Log file is generate in root of project (test_unit.log)
if echo $? = 0 is OK else > 0 is FAILED

Functional test

These tests check if there are no regression with the global function (exclude website)

$ python3 manage.py --testfunc
$ echo $?

Log file is generate in root of project (test_works.log)
if echo $? = 0 is OK else > 0 is FAILED

Multi language

To use this command, please make sure you are on root gitdir

LANGUAGE type in server.py:

'en' for English
'fr' for French

Init new language

to add language

$ pybabel extract -F website/settings/babel.cfg -o translations/messages.pot .
$ pybabel extract -F website/settings/babel.cfg -k lazy_gettext -o translations/messages.pot .
$ pybabel init -i translations/messages.pot -d translations -l <LANGUAGE>

Update only text language

to update language for website

$ pybabel extract -F website/settings/babel.cfg -o translations/messages.pot .
$ pybabel extract -F website/settings/babel.cfg -k lazy_gettext -o translations/messages.pot .
$ pybabel compile -d translations
$ pybabel update -i translations/messages.pot -d translations

Example to add new language

I want to add the Italian language

add "'it': 'Italian'" to dict LANGUAGES in server.py

$ pybabel extract -F website/settings/babel.cfg -o translations/messages.pot .
$ pybabel extract -F website/settings/babel.cfg -k lazy_gettext -o translations/messages.pot .
$ pybabel init -i translations/messages.pot -d translations -l it

Runing website

To start website, you should use manager.py

$ python3 manager.py --run
$ echo $?

Log file is generate in root of project (server.log)
if echo $? = 0 is OK else > 0 is FAILED

IDE used

VS Code - Visual studio code

Contributing

Please use gitcmd/gc to commit and gitcmd/gclean to make clean

Valide case:

$ gitcmd/gc "update README.md with new display"
> unit_test.py: Test valid OK
> test_works.py: Test valid OK

Unvalid case:

$ gitcmd/gc "update README.md with new display"
> unit_test.py: Test valid FAILED
> test_works.py: Test valid FAILED

/!\ If you are unvalid case, you mustn't commit on the server.

Authors

Guillaume Le Gall - Initial work - Github page

There are no contributor for the moment.

License

This project is protected by licence BSD-2 please read license file

Todo

~~Multilang (Priority - HIGH to share code)~~
~~Fix pdf template (Priority - HIGH to share code)~~
Forecast cash (AI)
~~Forecast day~~
Chart (Graph bar & line)

LegallGuillaume / MyCompta