ecriture-shopify


Nameecriture-shopify JSON
Version 3.1.0 PyPI version JSON
download
home_pagehttps://github.com/michelpado/ecriture-shopify
SummaryGénération d'une écriture comptable à partir d'un extrait mensuel de Shopify.
upload_time2023-10-25 16:22:18
maintainer
docs_urlNone
authormichelpado
requires_python>=3.9,<3.13
licenseGPL-3.0-only
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # ecriture-shopify

[![Test CI](https://github.com/michelpado/ecriture-shopify/actions/workflows/test_source_code.yml/badge.svg)](https://github.com/michelpado/ecriture-shopify/actions/workflows/test_source_code.yml)
[![PyPI - Version](https://img.shields.io/pypi/v/ecriture-shopify?label=Latest%20release&color=41B3FF)](https://pypi.org/project/ecriture-shopify/)
[![PyPI - License](https://img.shields.io/pypi/l/ecriture-shopify?color=EEEEEE)](https://github.com/michelpado/ecriture-shopify/blob/master/LICENSE)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ecriture-shopify?color=F67280)](https://pypi.org/project/ecriture-shopify/)


Génère une écriture comptable à partir d'un extrait mensuel de Shopify.<br>

Le coeur du traitement est en Pandas & XlsxWriter, avec l'aide de Loguru pour la partie log.


## Fonctionnement
La fonction principale du package est `shopify_to_ec`. Cette fonction encapsule le pipeline complet pour créer une écriture comptable à partir du fichier xlsx (ou xls) mensuel de Shopify. Le pipeline est composé de 3 étapes majeures:
* chargement, vérification et nettoyage du fichier d'entrée Shopify
* application de la TVA France et génération de l'écriture comptable
* création du fichier de sortie xlsx avec une mise en forme propre

**Explication de la fonction**<br>
`shopify_to_ec` prend en argument le fichier xlsx/xls de Shopify (en io.Bytes pour simplifier les intégrations dans d'autres outils) et le fichier de configuration de la TVA (optionnel) . La fonction génère le fichier d'écriture comptable en xlsx (aussi en io.Bytes).

**input/output en 'type hints':**<br>
```
shopify_to_ec(input_io: io.BytesIO(), dict_pays_tva: dict = DICT_PAYS_TVA) -> io.BytesIO()
```

**Pour importer:**<br>
```python
from ecriture_shopify import shopify_to_ec
```
<br>

Les problèmes pendant la génération déclencheront des exceptions, situé ici: `/ecriture_shopify/tools/exceptions.py`
<br>


## A propos
[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

Le projet est mené, entres autres, avec Poetry, Black, isort, Pytest et pre-commit.<br> Voir "pyproject.toml" pour la liste comptète.


## Auteur:
michel padovani


## Licence
License "GNU General Public License v3.0 only".<br>
Voir [LICENSE](https://github.com/michelpado/ecriture-shopify/blob/master/LICENSE)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/michelpado/ecriture-shopify",
    "name": "ecriture-shopify",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<3.13",
    "maintainer_email": "",
    "keywords": "",
    "author": "michelpado",
    "author_email": "michel.padovani@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/92/83/19b6a375a2929ab41a84539922a32f89080f67de462b2ade0face995c08b/ecriture_shopify-3.1.0.tar.gz",
    "platform": null,
    "description": "# ecriture-shopify\n\n[![Test CI](https://github.com/michelpado/ecriture-shopify/actions/workflows/test_source_code.yml/badge.svg)](https://github.com/michelpado/ecriture-shopify/actions/workflows/test_source_code.yml)\n[![PyPI - Version](https://img.shields.io/pypi/v/ecriture-shopify?label=Latest%20release&color=41B3FF)](https://pypi.org/project/ecriture-shopify/)\n[![PyPI - License](https://img.shields.io/pypi/l/ecriture-shopify?color=EEEEEE)](https://github.com/michelpado/ecriture-shopify/blob/master/LICENSE)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ecriture-shopify?color=F67280)](https://pypi.org/project/ecriture-shopify/)\n\n\nG\u00e9n\u00e8re une \u00e9criture comptable \u00e0 partir d'un extrait mensuel de Shopify.<br>\n\nLe coeur du traitement est en Pandas & XlsxWriter, avec l'aide de Loguru pour la partie log.\n\n\n## Fonctionnement\nLa fonction principale du package est `shopify_to_ec`. Cette fonction encapsule le pipeline complet pour cr\u00e9er une \u00e9criture comptable \u00e0 partir du fichier xlsx (ou xls) mensuel de Shopify. Le pipeline est compos\u00e9 de 3 \u00e9tapes majeures:\n* chargement, v\u00e9rification et nettoyage du fichier d'entr\u00e9e Shopify\n* application de la TVA France et g\u00e9n\u00e9ration de l'\u00e9criture comptable\n* cr\u00e9ation du fichier de sortie xlsx avec une mise en forme propre\n\n**Explication de la fonction**<br>\n`shopify_to_ec` prend en argument le fichier xlsx/xls de Shopify (en io.Bytes pour simplifier les int\u00e9grations dans d'autres outils) et le fichier de configuration de la TVA (optionnel) . La fonction g\u00e9n\u00e8re le fichier d'\u00e9criture comptable en xlsx (aussi en io.Bytes).\n\n**input/output en 'type hints':**<br>\n```\nshopify_to_ec(input_io: io.BytesIO(), dict_pays_tva: dict = DICT_PAYS_TVA) -> io.BytesIO()\n```\n\n**Pour importer:**<br>\n```python\nfrom ecriture_shopify import shopify_to_ec\n```\n<br>\n\nLes probl\u00e8mes pendant la g\u00e9n\u00e9ration d\u00e9clencheront des exceptions, situ\u00e9 ici: `/ecriture_shopify/tools/exceptions.py`\n<br>\n\n\n## A propos\n[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)\n[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n\nLe projet est men\u00e9, entres autres, avec Poetry, Black, isort, Pytest et pre-commit.<br> Voir \"pyproject.toml\" pour la liste compt\u00e8te.\n\n\n## Auteur:\nmichel padovani\n\n\n## Licence\nLicense \"GNU General Public License v3.0 only\".<br>\nVoir [LICENSE](https://github.com/michelpado/ecriture-shopify/blob/master/LICENSE)\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-only",
    "summary": "G\u00e9n\u00e9ration d'une \u00e9criture comptable \u00e0 partir d'un extrait mensuel de Shopify.",
    "version": "3.1.0",
    "project_urls": {
        "Changelog": "https://github.com/michelpado/ecriture-shopify/blob/master/CHANGELOG.md",
        "Homepage": "https://github.com/michelpado/ecriture-shopify"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "59c314e2687b026fd755d3b240f0f97a31e62b76f89e758ed68d28adcf63ff9d",
                "md5": "17b7fccf679de5b574641445a9cbe027",
                "sha256": "6f3bf4f773182e3a14c4d11755694d3e99a4ff0cf6158983faed1bf3f1fd295e"
            },
            "downloads": -1,
            "filename": "ecriture_shopify-3.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "17b7fccf679de5b574641445a9cbe027",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<3.13",
            "size": 22089,
            "upload_time": "2023-10-25T16:22:17",
            "upload_time_iso_8601": "2023-10-25T16:22:17.228488Z",
            "url": "https://files.pythonhosted.org/packages/59/c3/14e2687b026fd755d3b240f0f97a31e62b76f89e758ed68d28adcf63ff9d/ecriture_shopify-3.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "928319b6a375a2929ab41a84539922a32f89080f67de462b2ade0face995c08b",
                "md5": "674eb9e94130aa2c336677d51c6bd40a",
                "sha256": "2a052dd0ecd5c1727bdd3fd563123faae9c9e2a498129a5198c7cdffceff6859"
            },
            "downloads": -1,
            "filename": "ecriture_shopify-3.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "674eb9e94130aa2c336677d51c6bd40a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<3.13",
            "size": 19971,
            "upload_time": "2023-10-25T16:22:18",
            "upload_time_iso_8601": "2023-10-25T16:22:18.500454Z",
            "url": "https://files.pythonhosted.org/packages/92/83/19b6a375a2929ab41a84539922a32f89080f67de462b2ade0face995c08b/ecriture_shopify-3.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-25 16:22:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "michelpado",
    "github_project": "ecriture-shopify",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "ecriture-shopify"
}
michelpado
Elapsed time: 0.24379s