diff --git a/CHANGELOG.md b/CHANGELOG.md index 4cfd41e..22b480c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,8 +9,9 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ### Added -- Code generator for Odoo module +- Code generator for Odoo module, depending of ERPLibre - Support map geoengine +- Multilingual markdown ### Changed diff --git a/Makefile b/Makefile index ca2bb35..5cafcd7 100644 --- a/Makefile +++ b/Makefile @@ -389,3 +389,8 @@ doc_user: .PHONY: doc_clean_user doc_clean_user: make -C doc/odoo_documentation-user clean + +# documentation markdown +.PHONY: doc_markdown +doc_markdown: + ./.venv/multilang_md.py $(shell pwd)/doc/CODE_GENERATOR.base.md \ No newline at end of file diff --git a/README.md b/README.md index 8f0ea32..3c25608 100644 --- a/README.md +++ b/README.md @@ -7,19 +7,18 @@ Clone the project git clone https://github.com/ERPLibre/ERPLibre.git cd ERPLibre ``` -Support Ubuntu 18.04 and OSX +Support Ubuntu 18.04, 20.04 and OSX. The installation duration is more than 30 minutes. ```bash -./script/install_dev.sh -./script/install_locally_prod.sh +make install ``` -Update your configuration if you need to run somehere than 127.0.0.1, file `config.conf` +Update your configuration if you need to run from another interface than 127.0.0.1, file `config.conf` ``` #xmlrpc_interface = 127.0.0.1 #netrpc_interface = 127.0.0.1 ``` -Run +Ready to execute ```bash -./run.sh +make run ``` ## Discover guide diff --git a/doc/CODE_GENERATOR.base.md b/doc/CODE_GENERATOR.base.md new file mode 100644 index 0000000..667d800 --- /dev/null +++ b/doc/CODE_GENERATOR.base.md @@ -0,0 +1,448 @@ + + + + + + +# How to generate code + + +# Comment générer du code + + +Never run this on production environment, this create circular dependencies and will cause frustration to clean damage. + +Ne jamais exécuter le générateur de code dans un environnement de production, il y a création de dépendance circulaire pouvant causer de la frustration à nettoyer tous les dommages. + + +``` +Modules +############ ################## ########## +# Template # -> # Code_Generator # -> # Module # +############ ################## ########## +``` + + +1. [A Template generates a Template or a Code_Generator.](#create-your-first-code_generator) +2. A Code_Generator generates a Module. +3. A Template reads a Module to generate a Code_Generator. + + +Il y a 3 types de module dans le contexte du générateur de code : +1. [A Template generates a Template or a Code_Generator.](#crer-votre-premier-code_generator) +2. Un Code_Generator génère un module. +3. Un Template lis un module pour générer un Code_Generator. + + +Warning, be careful to your code, always commit after a manipulation, because the mode enable_sync_code erase data, only the git will save you! + + +Attention pour ne pas écraser votre code, toujours commiter après une manipulation, l'utilisation du mode enable_sync_code peut effacer des données. Seul git vous sauvera! + + +TODO +Il y a 4 objectifs sur le générateur : ++ utilisation du générateur via l'interface web ++ créer un nouveau module, ++ modifier un module existant ++ exécuter les tests. + +test : +- code generator +- code generator extra (externe au repo template) +- template +- création d'un nouveau module direct ou chaine complète + - tester chaque étape de la création +- i18n (définir les différents cas) + +Suggestion de réduire les config avec make config_ pour les tests. + +TODO expliquer les modules/fonctionnalités actuellements supportés. portail WIP, snippet website WIP, cron, web vue tree+form, geoengine WIP, theme website, hook, db_servers WIP, exportation de donnée en module +TODO expliquer objectif des 4 libertés +TODO rechanger les termes pour : orcherstre + moule + module + + +## Manual generator with web interface + + +## Générateur de module avec l'interface web + + +TODO + + +At root path of ERPLibre git project, run: + + +Niveau intermédiaire. + +Pour utiliser le générateur de code, il faut ouvrir l'interface web qui permet la configuration du logiciel à générer. Un des choix suivants : + +Générateur de code de base : + +```bash +make addons_install_code_generator_basic +make run_code_generator +``` + + +Générateur de code avec fonctionnalités avancées : + +```bash +make addons_install_code_generator_featured +make run_code_generator +``` + + +Générateur de code avec fonctionnalités complètes : + +```bash +make addons_install_code_generator_full +make run_code_generator +``` + +Ouvrir le navigateur sur [http://localhost:8069](http://localhost:8069). Utilisateur `test` et mot de passe `test`. Une fois connecté, ouvrir sur [http://localhost:8069/web?debug=](http://localhost:8069/web?debug=) pour activer le déverminage. + +Ouvrir l'application `Code Generator` et créer un `Module`. Remplir les champs requis et générer avec `Action/Generate code`. + + +## Prepare a DB + + +## Préparer une BD + + +This will destroy and create database named `code_generator`. + + +Ceci va détruire et créer une base de donnée nommé `code_generator`. + + +```bash +make db_restore_erplibre_base_db_code_generator +``` + + +## Test code generator + + +## Tester le générateur de code + + +TODO + + +Tester la génération des modules internes du générateur, créant les démos à partir de leur générateur respectif. +```bash +make test_code_generator_generation +``` + + +## Create your first `Code_Generator` + + +## Créer votre premier `Code_Generator` + + +Edit [Code Generator Demo](./../addons/TechnoLibre_odoo-code-generator/code_generator_demo/hooks.py) and update `# TODO HUMAN:` + + +Modifier [Code Generator Demo](./../addons/TechnoLibre_odoo-code-generator/code_generator_demo/hooks.py) et mettre à jour `# TODO HUMAN:` + + +### Generate a `Template` + + +### Générer un `Template` + + +By default, `code_generator_demo` generate itself, `code_generator_demo`. + +Name your module begin with `MODULE_NAME = "code_generator_template_"` + +The value "enable_template_code_generator_demo" at `False` to create a new template module, else this will recreate `code_generator_demo`. + + +Par défaut, installer le module code_generator_demo va générer le module `code_generator_demo`. + +Nommer votre module en commençant par `MODULE_NAME = "code_generator_template_"` + + +Example, to generate the module `code_generator_template_demo_website_snippet`, change value: + + +Un exemple, générer le module `code_generator_template_demo_website_snippet`, changer la variable `value`: + + +```python +MODULE_NAME = "code_generator_template_demo_website_snippet" +[...] +value["enable_template_website_snippet_view"] = True +[...] +lst_depend = [ + "code_generator", + "code_generator_website_snippet", +] +``` + + +Generate new module, this will overwrite `code_generator_template_demo_website_snippet`: + + +Générer un nouveau module, ceci va écraser `code_generator_template_demo_website_snippet` : + + +```bash +make db_restore_erplibre_base_db_code_generator +make addons_install_code_generator_demo +``` + + +### Generate a Code_Generator (continue template) + + +### Générer un Code_Generator (suite de template) + + +Name your module begin with `MODULE_NAME = "code_generator_"` + + +Nommé votre module qui débute par `MODULE_NAME = "code_generator_"` + + +Continue the example, you generated the template `code_generator_template_demo_website_snippet`, this will overwrite `code_generator_demo_website_snippet`: + + +Pour continuer avec l'exemple, généré le template `code_generator_template_demo_website_snippet`, ceci va écraser `code_generator_demo_website_snippet`: + + +```bash +make db_restore_erplibre_base_db_template +./script/addons/install_addons.sh template code_generator_template_demo_website_snippet +``` + + +Go to section [Create your first module](#create-your-first-module) + + +Aller à la section [Créer votre premier module](#crer-votre-premier-module) + + +### Generate a Code_Generator_Demo + + +### Générer un Code_Generator_Demo + + +TODO validate this + + +Name your module begin with `MODULE_NAME = "code_generator_demo_"` + +Disable `enable_template_code_generator_demo` + + +Nommé votre module qui débute par `MODULE_NAME = "code_generator_demo_"` + +Désactiver la variable `enable_template_code_generator_demo` + + +```python +value["enable_template_code_generator_demo"] = False +``` + + +Continue the example, you generated the template `code_generator_template_demo_website_snippet`, this will overwrite `code_generator_demo_website_snippet`: + + +Pour continuer avec l'exemple, généré le template `code_generator_template_demo_website_snippet`, ceci va écraser `code_generator_demo_website_snippet`: + + +```bash +./script/addons/install_addons.sh code_generator code_generator_template_demo_website_snippet +``` + + +## Create your first Module + + +## Créer votre premier module + + +Continue example of code_generator_demo_website_snippet to generate your first module. Update next value: + + +Continuer avec l'exemple du `code_generator_demo_website_snippet` pour générer votre premier module. Mettre à jour les valeurs suivantes : + + +```python +"application": True, +"category_id": env.ref("base.module_category_website").id, +[...] +# Add dependencies +lst_depend = [ + "website", +] +``` + + +Generate your module: + + +Générer votre module : + + +```bash +./script/addons/install_addons.sh code_generator code_generator_demo_website_snippet +``` + + +Now, you can test it! Note, you cannot install a generated module with is code_generator associated, because duplicated +models! + + +Maintenant, vous pouvez le tester! Pour info, on ne peut pas installer un module généré avec son générateur de code associé, puisqu'il y a une duplication des modèles! + + + + +Il est maintenant possible de modifier les paramètres via l'interface manuelle pour ce module, puis le regénérer en effaçant la BD. Ajouter un modèle. + + +```bash +make db_restore_erplibre_base_db_code_generator +./script/addons/install_addons.sh code_generator code_generator_demo_website_snippet +``` + + + + +Faire la boucle d'amélioration, commiter le code pour avoir une traçabilité des changements. + +Ensuite, modifier la valeur `enable_sync_template` à `True` dans le fichier template, de l'exemple `code_generator_template_demo_website_snippet`. + + +```python +value["enable_sync_template"] = True +``` + + + + +Exécuter l'installation du template pour qu'il se synchronise sur le module généré. +```bash +make db_restore_erplibre_base_db_template +./script/addons/install_addons.sh template code_generator_template_demo_website_snippet +``` + + +Ready to test, generate your module: + + +Prêt à tester, générer le module : + + +```bash +# Optional, reset test database +make db_restore_erplibre_base_db_test +./script/addons/install_addons.sh test demo_website_snippet +``` + + +# How to generate i18n translation + + +# Comment générer les traductions i18n + + +You need a template and a module. Be sure you have this line in template: + + +Vous avez besoin d'un template et d'un module. Soyez certain que vous avez cette ligne dans le template : + + +```python +new_module_path = os.path.join(path_module_generate, new_module_name) +code_generator_writer.set_module_translator(new_module_name, new_module_path) +``` + + +First, install the module, example `demo_portal`, and after the template, example `code_generator_template_demo_portal`. + + +Premièrement, installer le module, par exemple `demo_portal`, et ensuite le template, par exemple `code_generator_template_demo_portal`. + + +```bash +make db_restore_erplibre_base_db_code_generator +./script/addons/install_addons.sh test demo_portal +./script/addons/install_addons.sh test code_generator_template_demo_portal +``` + + +# Sync Code_Generator fields from Module + + +# Synchroniser les champs du `Code_Generator` du module + + +This reduce time of programming a `Code_Generator` with sync module field with `Template`. + +You need a `Template`, a `Code_Generator` with his `Module`. Install the `Module` first in clean database and install `Template`, +this will generate the `Code_Generator`, use `enable_sync_template` at True. + +Example: + + +Ceci va permettre de réduire le temps de programmation d'un `Code_Generator` avec la synchronisation des champs de module avec `Template`. + +On a besoin d'un `Template`, un `Code_Generator` accompagné de son module. Installer le module en premier dans une base de donnée nettoyé et installer le `Template`, ceci va générer le `Code_Generator`, utiliser `enable_sync_template` à la valeur `True`. + +Exemple : + + +```bash +make db_restore_erplibre_base_db_code_generator +./script/addons/install_addons.sh test demo_portal +./script/addons/install_addons.sh test code_generator_template_demo_portal +``` + + +# Test the code generator + + +# Tester le générateur de code + + +TODO + + +Une bonne manière de tester un générateur de code est de valider qu'il génère le même code, il ne devient pas nécessaire de tester les fonctionnalités, puisque le comportement est la génération. + +Tester les générations simples : + + +```bash +make test_code_generator_generation +``` + + +TODO + + +Tester les générations extra : + + +```bash +make test_code_generator_generation_extra +``` + +TODO + + +Tester les générations des templates : + + +```bash +make test_code_generator_template +``` diff --git a/doc/CODE_GENERATOR.fr.md b/doc/CODE_GENERATOR.fr.md new file mode 100644 index 0000000..695d82d --- /dev/null +++ b/doc/CODE_GENERATOR.fr.md @@ -0,0 +1,222 @@ +# Comment générer du code + +Ne jamais exécuter le générateur de code dans un environnement de production, il y a création de dépendance circulaire pouvant causer de la frustration à nettoyer tous les dommages. + +``` +Modules +############ ################## ########## +# Template # -> # Code_Generator # -> # Module # +############ ################## ########## +``` + +Il y a 3 types de module dans le contexte du générateur de code : +1. [A Template generates a Template or a Code_Generator.](#crer-votre-premier-code_generator) +2. Un Code_Generator génère un module. +3. Un Template lis un module pour générer un Code_Generator. + +Attention pour ne pas écraser votre code, toujours commiter après une manipulation, l'utilisation du mode enable_sync_code peut effacer des données. Seul git vous sauvera! + +## Générateur de module avec l'interface web + +Niveau intermédiaire. + +Pour utiliser le générateur de code, il faut ouvrir l'interface web qui permet la configuration du logiciel à générer. Un des choix suivants : + +Générateur de code de base : +```bash +make addons_install_code_generator_basic +make run_code_generator +``` + +Générateur de code avec fonctionnalités avancées : +```bash +make addons_install_code_generator_featured +make run_code_generator +``` + +Générateur de code avec fonctionnalités complètes : +```bash +make addons_install_code_generator_full +make run_code_generator +``` + +Ouvrir le navigateur sur [http://localhost:8069](http://localhost:8069). Utilisateur `test` et mot de passe `test`. Une fois connecté, ouvrir sur [http://localhost:8069/web?debug=](http://localhost:8069/web?debug=) pour activer le déverminage. + +Ouvrir l'application `Code Generator` et créer un `Module`. Remplir les champs requis et générer avec `Action/Generate code`. + +## Préparer une BD + +Ceci va détruire et créer une base de donnée nommé `code_generator`. + +```bash +make db_restore_erplibre_base_db_code_generator +``` + +## Tester le générateur de code + +Tester la génération des modules internes du générateur, créant les démos à partir de leur générateur respectif. +```bash +make test_code_generator_generation +``` + +## Créer votre premier `Code_Generator` + +Modifier [Code Generator Demo](./../addons/TechnoLibre_odoo-code-generator/code_generator_demo/hooks.py) et mettre à jour `# TODO HUMAN:` + +### Générer un `Template` + +Par défaut, installer le module code_generator_demo va générer le module `code_generator_demo`. + +Nommer votre module en commençant par `MODULE_NAME = "code_generator_template_"` + +Un exemple, générer le module `code_generator_template_demo_website_snippet`, changer la variable `value`: + +```python +MODULE_NAME = "code_generator_template_demo_website_snippet" +[...] +value["enable_template_website_snippet_view"] = True +[...] +lst_depend = [ + "code_generator", + "code_generator_website_snippet", +] +``` + +Générer un nouveau module, ceci va écraser `code_generator_template_demo_website_snippet` : + +```bash +make db_restore_erplibre_base_db_code_generator +make addons_install_code_generator_demo +``` + +### Générer un Code_Generator (suite de template) + +Nommé votre module qui débute par `MODULE_NAME = "code_generator_"` + +Pour continuer avec l'exemple, généré le template `code_generator_template_demo_website_snippet`, ceci va écraser `code_generator_demo_website_snippet`: + +```bash +make db_restore_erplibre_base_db_template +./script/addons/install_addons.sh template code_generator_template_demo_website_snippet +``` + +Aller à la section [Créer votre premier module](#crer-votre-premier-module) + +### Générer un Code_Generator_Demo + +Nommé votre module qui débute par `MODULE_NAME = "code_generator_demo_"` + +Désactiver la variable `enable_template_code_generator_demo` + +```python +value["enable_template_code_generator_demo"] = False +``` + +Pour continuer avec l'exemple, généré le template `code_generator_template_demo_website_snippet`, ceci va écraser `code_generator_demo_website_snippet`: + +```bash +./script/addons/install_addons.sh code_generator code_generator_template_demo_website_snippet +``` + +## Créer votre premier module + +Continuer avec l'exemple du `code_generator_demo_website_snippet` pour générer votre premier module. Mettre à jour les valeurs suivantes : + +```python +"application": True, +"category_id": env.ref("base.module_category_website").id, +[...] +# Add dependencies +lst_depend = [ + "website", +] +``` + +Générer votre module : + +```bash +./script/addons/install_addons.sh code_generator code_generator_demo_website_snippet +``` + +Maintenant, vous pouvez le tester! Pour info, on ne peut pas installer un module généré avec son générateur de code associé, puisqu'il y a une duplication des modèles! + +Il est maintenant possible de modifier les paramètres via l'interface manuelle pour ce module, puis le regénérer en effaçant la BD. Ajouter un modèle. + +```bash +make db_restore_erplibre_base_db_code_generator +./script/addons/install_addons.sh code_generator code_generator_demo_website_snippet +``` + +Faire la boucle d'amélioration, commiter le code pour avoir une traçabilité des changements. + +Ensuite, modifier la valeur `enable_sync_template` à `True` dans le fichier template, de l'exemple `code_generator_template_demo_website_snippet`. + +```python +value["enable_sync_template"] = True +``` + +Exécuter l'installation du template pour qu'il se synchronise sur le module généré. +```bash +make db_restore_erplibre_base_db_template +./script/addons/install_addons.sh template code_generator_template_demo_website_snippet +``` + +Prêt à tester, générer le module : + +```bash +# Optional, reset test database +make db_restore_erplibre_base_db_test +./script/addons/install_addons.sh test demo_website_snippet +``` + +# Comment générer les traductions i18n + +Vous avez besoin d'un template et d'un module. Soyez certain que vous avez cette ligne dans le template : + +```python +new_module_path = os.path.join(path_module_generate, new_module_name) +code_generator_writer.set_module_translator(new_module_name, new_module_path) +``` + +Premièrement, installer le module, par exemple `demo_portal`, et ensuite le template, par exemple `code_generator_template_demo_portal`. + +```bash +make db_restore_erplibre_base_db_code_generator +./script/addons/install_addons.sh test demo_portal +./script/addons/install_addons.sh test code_generator_template_demo_portal +``` + +# Synchroniser les champs du `Code_Generator` du module + +Ceci va permettre de réduire le temps de programmation d'un `Code_Generator` avec la synchronisation des champs de module avec `Template`. + +On a besoin d'un `Template`, un `Code_Generator` accompagné de son module. Installer le module en premier dans une base de donnée nettoyé et installer le `Template`, ceci va générer le `Code_Generator`, utiliser `enable_sync_template` à la valeur `True`. + +Exemple : + +```bash +make db_restore_erplibre_base_db_code_generator +./script/addons/install_addons.sh test demo_portal +./script/addons/install_addons.sh test code_generator_template_demo_portal +``` + +# Tester le générateur de code + +Une bonne manière de tester un générateur de code est de valider qu'il génère le même code, il ne devient pas nécessaire de tester les fonctionnalités, puisque le comportement est la génération. + +Tester les générations simples : + +```bash +make test_code_generator_generation +``` + +Tester les générations extra : + +```bash +make test_code_generator_generation_extra +``` +Tester les générations des templates : + +```bash +make test_code_generator_template +``` diff --git a/doc/CODE_GENERATOR.md b/doc/CODE_GENERATOR.md index d31d832..f6c22c7 100644 --- a/doc/CODE_GENERATOR.md +++ b/doc/CODE_GENERATOR.md @@ -8,34 +8,62 @@ Modules # Template # -> # Code_Generator # -> # Module # ############ ################## ########## ``` -1. [A Template generates a Template or a Code_Generator.](Create your first code generator) + +1. [A Template generates a Template or a Code_Generator.](#create-your-first-code_generator) 2. A Code_Generator generates a Module. 3. A Template reads a Module to generate a Code_Generator. +Warning, be careful to your code, always commit after a manipulation, because the mode enable_sync_code erase data, only the git will save you! + +## Manual generator with web interface + +TODO + +```bash +make addons_install_code_generator_basic +make run_code_generator +``` + +```bash +make addons_install_code_generator_featured +make run_code_generator +``` + +```bash +make addons_install_code_generator_full +make run_code_generator +``` + +Ouvrir le navigateur sur [http://localhost:8069](http://localhost:8069). Utilisateur `test` et mot de passe `test`. Une fois connecté, ouvrir sur [http://localhost:8069/web?debug=](http://localhost:8069/web?debug=) pour activer le déverminage. + +Ouvrir l'application `Code Generator` et créer un `Module`. Remplir les champs requis et générer avec `Action/Generate code`. + ## Prepare a DB -This will destroy and create database named code_generator. +This will destroy and create database named `code_generator`. + ```bash make db_restore_erplibre_base_db_code_generator ``` -## Create your first Code_Generator +## Test code generator + +TODO + +## Create your first `Code_Generator` Edit [Code Generator Demo](./../addons/TechnoLibre_odoo-code-generator/code_generator_demo/hooks.py) and update `# TODO HUMAN:` -### Generate a Template +### Generate a `Template` -By default, code_generator_demo generate itself, code_generator_demo. +By default, `code_generator_demo` generate itself, `code_generator_demo`. Name your module begin with `MODULE_NAME = "code_generator_template_"` -The value "enable_template_code_generator_demo" at False to create a new template module, else this will recreate code_generator_demo. +The value "enable_template_code_generator_demo" at `False` to create a new template module, else this will recreate `code_generator_demo`. -```python -value["enable_template_code_generator_demo"] = True -``` +Example, to generate the module `code_generator_template_demo_website_snippet`, change value: -Example, to generate the module `code_generator_template_demo_website_snippet`, change value ```python MODULE_NAME = "code_generator_template_demo_website_snippet" [...] @@ -46,28 +74,47 @@ lst_depend = [ "code_generator_website_snippet", ] ``` -Generate new module, this will overwrite code_generator_template_demo_website_snippet: + +Generate new module, this will overwrite `code_generator_template_demo_website_snippet`: + ```bash +make db_restore_erplibre_base_db_code_generator make addons_install_code_generator_demo ``` -### Generate a Code_Generator +### Generate a Code_Generator (continue template) + +Name your module begin with `MODULE_NAME = "code_generator_"` + +Continue the example, you generated the template `code_generator_template_demo_website_snippet`, this will overwrite `code_generator_demo_website_snippet`: + +```bash +make db_restore_erplibre_base_db_template +./script/addons/install_addons.sh template code_generator_template_demo_website_snippet +``` + +Go to section [Create your first module](#create-your-first-module) + +### Generate a Code_Generator_Demo Name your module begin with `MODULE_NAME = "code_generator_demo_"` -Disable enable_template_code_generator_demo +Disable `enable_template_code_generator_demo` + ```python value["enable_template_code_generator_demo"] = False ``` -Continue the example, you generated the template `code_generator_template_demo_website_snippet`, this will overwrite code_generator_demo_website_snippet: +Continue the example, you generated the template `code_generator_template_demo_website_snippet`, this will overwrite `code_generator_demo_website_snippet`: + ```bash -./install_addon.sh code_generator code_generator_template_demo_website_snippet +./script/addons/install_addons.sh code_generator code_generator_template_demo_website_snippet ``` ## Create your first Module Continue example of code_generator_demo_website_snippet to generate your first module. Update next value: + ```python "application": True, "category_id": env.ref("base.module_category_website").id, @@ -79,45 +126,81 @@ lst_depend = [ ``` Generate your module: + ```bash -./install_addon.sh code_generator code_generator_demo_website_snippet +./script/addons/install_addons.sh code_generator code_generator_demo_website_snippet ``` -Now, you can test it! Note, you cannot install a generated module with is code_generator associated, because duplicated models! -Generate your module: +Now, you can test it! Note, you cannot install a generated module with is code_generator associated, because duplicated +models! + + +```bash +make db_restore_erplibre_base_db_code_generator +./script/addons/install_addons.sh code_generator code_generator_demo_website_snippet +``` + + +```python +value["enable_sync_template"] = True +``` + + +Ready to test, generate your module: + ```bash # Optional, reset test database make db_restore_erplibre_base_db_test -./install_addon.sh test demo_website_snippet +./script/addons/install_addons.sh test demo_website_snippet ``` # How to generate i18n translation -You need a template and a module. -Be sure you have this line in template: +You need a template and a module. Be sure you have this line in template: ```python new_module_path = os.path.join(path_module_generate, new_module_name) code_generator_writer.set_module_translator(new_module_name, new_module_path) ``` -First, install the module, example demo_portal, and after the template, example code_generator_template_demo_portal +First, install the module, example `demo_portal`, and after the template, example `code_generator_template_demo_portal`. + ```bash make db_restore_erplibre_base_db_code_generator -./install_addon.sh test demo_portal -./install_addon.sh test code_generator_template_demo_portal +./script/addons/install_addons.sh test demo_portal +./script/addons/install_addons.sh test code_generator_template_demo_portal ``` # Sync Code_Generator fields from Module -This reduce time of programming a Code_Generator with sync module field with Template. +This reduce time of programming a `Code_Generator` with sync module field with `Template`. -You need a Template, a Code_Generator with his Module. Install the Module first in clean database and install Template, this will generate the Code_generator, use `enable_sync_template` at True. +You need a `Template`, a `Code_Generator` with his `Module`. Install the `Module` first in clean database and install `Template`, +this will generate the `Code_Generator`, use `enable_sync_template` at True. + +Example: -Example ```bash make db_restore_erplibre_base_db_code_generator -./install_addon.sh test demo_portal -./install_addon.sh test code_generator_template_demo_portal +./script/addons/install_addons.sh test demo_portal +./script/addons/install_addons.sh test code_generator_template_demo_portal ``` +# Test the code generator + +TODO + +```bash +make test_code_generator_generation +``` + +TODO + +```bash +make test_code_generator_generation_extra +``` +TODO + +```bash +make test_code_generator_template +``` diff --git a/script/install_locally.sh b/script/install_locally.sh index a95a0eb..3b20639 100755 --- a/script/install_locally.sh +++ b/script/install_locally.sh @@ -185,6 +185,7 @@ POETRY_PATH=~/.poetry VENV_PATH=./.venv LOCAL_PYTHON_EXEC=${VENV_PATH}/bin/python VENV_REPO_PATH=${VENV_PATH}/repo +VENV_MULTILINGUAL_MARKDOWN_PATH=${VENV_PATH}/multilang_md.py POETRY_VERSION=1.0.10 echo "Python path version home" @@ -246,6 +247,16 @@ if [[ ! -f ${VENV_REPO_PATH} ]]; then sed -i "1 i ${PYTHON_HASHBANG}" ${VENV_REPO_PATH} fi +# Install Multilingual Markdown Generator if missing +if [[ ! -f ${VENV_MULTILINGUAL_MARKDOWN_PATH} ]]; then + echo "\n---- Install Multilingual Markdown Generator ----" + curl https://raw.githubusercontent.com/ERPLibre/multilingual-markdown/master/multilang_md.py > ${VENV_MULTILINGUAL_MARKDOWN_PATH} + chmod +x ${VENV_MULTILINGUAL_MARKDOWN_PATH} + sed -i 1d ${VENV_MULTILINGUAL_MARKDOWN_PATH} + PYTHON_HASHBANG="#!./.venv/bin/python" + sed -i "1 i ${PYTHON_HASHBANG}" ${VENV_MULTILINGUAL_MARKDOWN_PATH} +fi + echo -e "\n---- Installing poetry dependency ----" ${VENV_PATH}/bin/pip install --upgrade pip # Force python instead of changing env