Librairie CAErp pour la gestion des encaissements
======================================================
NB : À parir de la version 2.0, cette librairie ne supporte plus python 2
Cette librairie a pour objectif de fournir un ensemble cohérent pour la gestion
des encaissements, ce afin de répondre aux exigences de la loi de finance 2018.
Le texte suivant `http://bofip.impots.gouv.fr/bofip/10691-PGP` décrit plus en
détail le besoin à couvrir
Elle fonctionne comme suit :
- Les opérations d'encaissement sont effectuées au travers d'une API publique
- Pour chaque opération d'encaissement, une entrée est écrite dans le journal
Le journal est le garant de l'intégrité des opérations d'encaissement.
Activation du module
---------------------
L'api publique est configurable dans CAErp au travers du fichier de
configuration .ini.
Assurez-vous que la librairie caerp_payment est bien dans les caerp.includes
.. code-block:: console
caerp.includes = ...
...
caerp_payment
Configurez le service caerp.interfaces.IPaymentRecordService
.. code-block:: console
caerp.interfaces.IPaymentRecordService = caerp_payment.public.PaymentService
Configurez les journaux de 'caerp_payment'. Voir la documentation sur le module
python logging pour le détail : https://docs.python.org/2/library/logging.html
ainsi que les exemples dans le fichier development.ini.sample.
Configurez le service de journalisation
caerp_payment.interfaces.IPaymentRecordHistoryService à utiliser.
caerp_payment propose deux services de journalisation
HistoryLogService : Service par défaut, prévu pour le mode développement, se
content de journaliser les actions sans détails.
HistoryDBService : Journalise les actions effectuées dans une base de données
spécifiques (pas forcément sur le même serveur mysql)
HistoryDBService
------------------
Pour activer la journalisation détaillée dans une base de données spécifiques
ajouter la ligne suivante dans la section [app:caerp] du fichier .ini
.. code-block:: console
caerp_payment.interfaces.IPaymentRecordHistoryService = caerp_payment.history.caerp_payment.history.HistoryDBService
Créer une nouvelle base de données, vous pouvez utiliser l'utilitaire
./tools/add_payment_database.sh fournit dans le repository caerp.
.. code-block:: console
cd caerp/
./tools/add_payment_database.sh
# Suivez les instructions
Puis saisissez les informations de connexion de la nouvelle base de données dans
la section [app:caerp] du fichier .ini
.. code-block:: console
caerp_payment_db.url = mysql://caerp_payment:caerp_payment@localhost/caerp_payment?charset=utf8
Archivage
-----------
Afin de certifier l'historique des actions sur les encaissements, caerp_payment
permet l'utilisation d'un service d'archivage.
Version locale, ajouter la ligne suivante à la configuration .ini du service
caerp dans la section [app:caerp]
.. code-block:: console
caerp_payment.interfaces.IPaymentArchiveService=caerp_payment.archive.FileArchiveService
caerp_payment_archive_storage_path=<chemin sur disque pour le stockage des journaux>
La version locale fournie une solution acceptable de certification des journaux
d'encaissement.
Afin d'obtenir une solution plus endurcie, on préfèrera l'utilisation d'un
service distant avec un tiers certifié.
Une configuration complète contient donc les informations suivantes
.. code-block::
caerp.includes =
....
caerp_payment
# Accès à la bdd de traitement des paiements
caerp_payment_db.url = mysql://caerp_payment:caerp_payment@localhost/caerp_payment?charset=utf8
# Le service qui sera utilisé depuis caerp pour agir sur les encaissements
caerp.interfaces.IPaymentRecordService = caerp_payment.public.PaymentService
# Le service qui sera utilisé par caerp_payment pour stocker l'historique des actions d'encaissement
caerp_payment.interfaces.IPaymentRecordHistoryService = caerp_payment.history.HistoryDBService
# Le service en charge de la génération d'une archive avec un peu de certification d'intégrité des journaux
caerp_payment.interfaces.IPaymentArchiveService = caerp_payment.archive.FileArchiveService
# Le chemin utilisé par le service d'archivage pour le stockage sur disque
caerp_payment_archive_storage_path = /var/caerp/files/treasury/payment_storage
Consultation des journaux
--------------------------
Si le service HistoryDBService est utilisé, caerp_payment ajoute automatiquement
une entrée dans le menu Comptabilité d'CAErp permettant la consultation du
journal des modifications apportées aux encaissements.
Raw data
{
"_id": null,
"home_page": "https://framagit.org/caerp/caerp_payment",
"name": "caerp-payment",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "web wsgi bfg pylons pyramid caerp",
"author": "Majerti",
"author_email": "equipe@majerti.fr",
"download_url": "https://files.pythonhosted.org/packages/52/d7/ceb0c11f4f55d8b91c56c245c8d7fde6e59061630409d416214b392faf17/caerp_payment-2024.0.10.tar.gz",
"platform": null,
"description": "Librairie CAErp pour la gestion des encaissements\n======================================================\n\nNB : \u00c0 parir de la version 2.0, cette librairie ne supporte plus python 2\n\nCette librairie a pour objectif de fournir un ensemble coh\u00e9rent pour la gestion\ndes encaissements, ce afin de r\u00e9pondre aux exigences de la loi de finance 2018.\nLe texte suivant `http://bofip.impots.gouv.fr/bofip/10691-PGP` d\u00e9crit plus en\nd\u00e9tail le besoin \u00e0 couvrir\n\nElle fonctionne comme suit :\n\n- Les op\u00e9rations d'encaissement sont effectu\u00e9es au travers d'une API publique\n- Pour chaque op\u00e9ration d'encaissement, une entr\u00e9e est \u00e9crite dans le journal\n\nLe journal est le garant de l'int\u00e9grit\u00e9 des op\u00e9rations d'encaissement.\n\nActivation du module\n---------------------\n\nL'api publique est configurable dans CAErp au travers du fichier de\nconfiguration .ini.\n\nAssurez-vous que la librairie caerp_payment est bien dans les caerp.includes\n\n.. code-block:: console\n\n caerp.includes = ...\n ...\n caerp_payment\n\nConfigurez le service caerp.interfaces.IPaymentRecordService\n\n.. code-block:: console\n\n caerp.interfaces.IPaymentRecordService = caerp_payment.public.PaymentService\n\nConfigurez les journaux de 'caerp_payment'. Voir la documentation sur le module\npython logging pour le d\u00e9tail : https://docs.python.org/2/library/logging.html\nainsi que les exemples dans le fichier development.ini.sample.\n\n\nConfigurez le service de journalisation\ncaerp_payment.interfaces.IPaymentRecordHistoryService \u00e0 utiliser.\n\ncaerp_payment propose deux services de journalisation\n\n\n HistoryLogService : Service par d\u00e9faut, pr\u00e9vu pour le mode d\u00e9veloppement, se\n content de journaliser les actions sans d\u00e9tails.\n\n HistoryDBService : Journalise les actions effectu\u00e9es dans une base de donn\u00e9es\n sp\u00e9cifiques (pas forc\u00e9ment sur le m\u00eame serveur mysql)\n\nHistoryDBService\n------------------\n\nPour activer la journalisation d\u00e9taill\u00e9e dans une base de donn\u00e9es sp\u00e9cifiques\najouter la ligne suivante dans la section [app:caerp] du fichier .ini\n\n.. code-block:: console\n\n caerp_payment.interfaces.IPaymentRecordHistoryService = caerp_payment.history.caerp_payment.history.HistoryDBService\n\nCr\u00e9er une nouvelle base de donn\u00e9es, vous pouvez utiliser l'utilitaire\n./tools/add_payment_database.sh fournit dans le repository caerp.\n\n.. code-block:: console\n\n cd caerp/\n ./tools/add_payment_database.sh\n # Suivez les instructions\n\nPuis saisissez les informations de connexion de la nouvelle base de donn\u00e9es dans\nla section [app:caerp] du fichier .ini\n\n.. code-block:: console\n\n caerp_payment_db.url = mysql://caerp_payment:caerp_payment@localhost/caerp_payment?charset=utf8\n\n\nArchivage\n-----------\n\nAfin de certifier l'historique des actions sur les encaissements, caerp_payment\npermet l'utilisation d'un service d'archivage.\n\nVersion locale, ajouter la ligne suivante \u00e0 la configuration .ini du service\ncaerp dans la section [app:caerp]\n\n.. code-block:: console\n\n caerp_payment.interfaces.IPaymentArchiveService=caerp_payment.archive.FileArchiveService\n caerp_payment_archive_storage_path=<chemin sur disque pour le stockage des journaux>\n\nLa version locale fournie une solution acceptable de certification des journaux\nd'encaissement.\n\nAfin d'obtenir une solution plus endurcie, on pr\u00e9f\u00e8rera l'utilisation d'un\nservice distant avec un tiers certifi\u00e9.\n\n\nUne configuration compl\u00e8te contient donc les informations suivantes\n\n\n.. code-block::\n\n caerp.includes =\n ....\n caerp_payment\n\n # Acc\u00e8s \u00e0 la bdd de traitement des paiements\n caerp_payment_db.url = mysql://caerp_payment:caerp_payment@localhost/caerp_payment?charset=utf8\n\n # Le service qui sera utilis\u00e9 depuis caerp pour agir sur les encaissements\n caerp.interfaces.IPaymentRecordService = caerp_payment.public.PaymentService\n\n # Le service qui sera utilis\u00e9 par caerp_payment pour stocker l'historique des actions d'encaissement\n caerp_payment.interfaces.IPaymentRecordHistoryService = caerp_payment.history.HistoryDBService\n\n # Le service en charge de la g\u00e9n\u00e9ration d'une archive avec un peu de certification d'int\u00e9grit\u00e9 des journaux\n caerp_payment.interfaces.IPaymentArchiveService = caerp_payment.archive.FileArchiveService\n\n # Le chemin utilis\u00e9 par le service d'archivage pour le stockage sur disque\n caerp_payment_archive_storage_path = /var/caerp/files/treasury/payment_storage\n\n\nConsultation des journaux\n--------------------------\n\nSi le service HistoryDBService est utilis\u00e9, caerp_payment ajoute automatiquement\nune entr\u00e9e dans le menu Comptabilit\u00e9 d'CAErp permettant la consultation du\njournal des modifications apport\u00e9es aux encaissements.\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "caerp_payment",
"version": "2024.0.10",
"project_urls": {
"Homepage": "https://framagit.org/caerp/caerp_payment"
},
"split_keywords": [
"web",
"wsgi",
"bfg",
"pylons",
"pyramid",
"caerp"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a47b3aed318d0e90e5658d2b17df2af23a1f5b12e207ac5dab10d66a5cf1b9e0",
"md5": "6643f9805a108d847ae0711b177d617e",
"sha256": "0076fe72524aa3ee5d5aa4617f2429895e2b1ae23deecb6e40314e67130fe548"
},
"downloads": -1,
"filename": "caerp_payment-2024.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6643f9805a108d847ae0711b177d617e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 35428,
"upload_time": "2024-11-13T16:43:05",
"upload_time_iso_8601": "2024-11-13T16:43:05.062023Z",
"url": "https://files.pythonhosted.org/packages/a4/7b/3aed318d0e90e5658d2b17df2af23a1f5b12e207ac5dab10d66a5cf1b9e0/caerp_payment-2024.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "52d7ceb0c11f4f55d8b91c56c245c8d7fde6e59061630409d416214b392faf17",
"md5": "4fdbb757427aa3fcbf0329f60336c3c1",
"sha256": "31ae2a651d79fc710f34d38ba09f7250eef8580ea2c80052808a7b8137e6fb04"
},
"downloads": -1,
"filename": "caerp_payment-2024.0.10.tar.gz",
"has_sig": false,
"md5_digest": "4fdbb757427aa3fcbf0329f60336c3c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31493,
"upload_time": "2024-11-13T16:43:06",
"upload_time_iso_8601": "2024-11-13T16:43:06.379939Z",
"url": "https://files.pythonhosted.org/packages/52/d7/ceb0c11f4f55d8b91c56c245c8d7fde6e59061630409d416214b392faf17/caerp_payment-2024.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 16:43:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "caerp-payment"
}
JSON