prestashop-webservice 0.2.0__tar.gz

prestashop_webservice-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,56 @@
+name: Publish to PyPI
+
+on:
+    release:
+        types: [published]
+    workflow_dispatch:
+
+permissions:
+    id-token: write
+    contents: read
+
+jobs:
+    build:
+        name: Build distribution
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v5
+
+            - name: Set up Python
+              uses: actions/setup-python@v6
+              with:
+                  python-version: "3.12"
+
+            - name: Install build dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install build
+
+            - name: Build package
+              run: python -m build
+
+            - name: Store the distribution packages
+              uses: actions/upload-artifact@v5
+              with:
+                  name: python-package-distributions
+                  path: dist/
+
+    publish-to-pypi:
+        name: Publish to PyPI
+        needs:
+            - build
+        runs-on: ubuntu-latest
+        environment:
+            name: pypi
+            url: https://pypi.org/p/prestashop-webservice
+
+        steps:
+            - name: Download all the dists
+              uses: actions/download-artifact@v6
+              with:
+                  name: python-package-distributions
+                  path: dist/
+
+            - name: Publish distribution to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1

prestashop_webservice-0.2.0/.gitignore

@@ -0,0 +1,211 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+logs/
+
+
+.env.test

prestashop_webservice-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+default_language_version:
+    python: python3.12
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: check-added-large-files
+        exclude: ^docs/
+    -   id: check-toml
+    -   id: check-yaml
+        args:
+        -   --unsafe
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+    -   id: ruff
+        args:
+        - --fix
+    -   id: ruff-format
+ci:
+    autofix_commit_msg: 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
+    autoupdate_commit_msg: ⬆ [pre-commit.ci] pre-commit autoupdate

prestashop_webservice-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Patitas and Co
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

prestashop_webservice-0.2.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: prestashop-webservice
+Version: 0.2.0
+Summary: Webservice client for PrestaShop API
+Author-email: Nestor Villa <nestorvilla@patitasco.com>, Manolo Corte <manolocorte@patitasco.com>
+License: MIT License
+        
+        Copyright (c) 2025 Patitas and Co
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Documentation, https://github.com/patitas-and-co/prestashop-webservice/blob/main/README.md
+Project-URL: Repository, https://github.com/patitas-and-co/prestashop-webservice
+Keywords: prestashop,api,client,webservice,rest
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx
+Requires-Dist: cachetools
+Requires-Dist: loguru
+Requires-Dist: pre-commit
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: python-dotenv; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# PrestaShop Webservice
+
+Python client for PrestaShop API with caching, logging, and type hints.
+
+## Installation
+
+```bash
+pip install prestashop-webservice
+```
+
+## Quick Start
+
+```python
+from prestashop_webservice import Client, Params, Sort, SortOrder
+
+# Initialize client
+client = Client(
+    prestashop_base_url="https://your-store.com/api",
+    prestashop_ws_key="YOUR_API_KEY"
+)
+
+# Simple queries
+order = client.query_order(order_id="123")
+customer = client.query_customer(customer_id="456")
+
+# Advanced queries with parameters
+params = Params(
+    filter={"id_customer": "123"},
+    sort=Sort(field="date_add", order=SortOrder.DESC),
+    display=["id", "total_paid", "reference"],
+    limit=10
+)
+orders = client.query_orders(params=params)
+```
+
+## Features
+
+- 🚀 HTTP client with connection pooling
+- 💾 Automatic caching (24h TTL)
+- 📝 Logging with Loguru
+- 🎯 Full type hints
+- 🔒 Singleton pattern
+
+## Available Methods
+
+- `query_order()`, `query_orders()`, `exists_order()`
+- `query_customer()`, `query_customers()`
+- `query_product()`, `query_address()`, `query_country()`
+- `query_order_carriers()`, `query_order_histories()`, `query_order_state()`
+
+## License
+
+MIT License - See [LICENSE](LICENSE) file for details.

prestashop_webservice-0.2.0/README.md

@@ -0,0 +1,53 @@
+# PrestaShop Webservice
+
+Python client for PrestaShop API with caching, logging, and type hints.
+
+## Installation
+
+```bash
+pip install prestashop-webservice
+```
+
+## Quick Start
+
+```python
+from prestashop_webservice import Client, Params, Sort, SortOrder
+
+# Initialize client
+client = Client(
+    prestashop_base_url="https://your-store.com/api",
+    prestashop_ws_key="YOUR_API_KEY"
+)
+
+# Simple queries
+order = client.query_order(order_id="123")
+customer = client.query_customer(customer_id="456")
+
+# Advanced queries with parameters
+params = Params(
+    filter={"id_customer": "123"},
+    sort=Sort(field="date_add", order=SortOrder.DESC),
+    display=["id", "total_paid", "reference"],
+    limit=10
+)
+orders = client.query_orders(params=params)
+```
+
+## Features
+
+- 🚀 HTTP client with connection pooling
+- 💾 Automatic caching (24h TTL)
+- 📝 Logging with Loguru
+- 🎯 Full type hints
+- 🔒 Singleton pattern
+
+## Available Methods
+
+- `query_order()`, `query_orders()`, `exists_order()`
+- `query_customer()`, `query_customers()`
+- `query_product()`, `query_address()`, `query_country()`
+- `query_order_carriers()`, `query_order_histories()`, `query_order_state()`
+
+## License
+
+MIT License - See [LICENSE](LICENSE) file for details.

prestashop_webservice-0.2.0/docs/INSTALLATION.md

@@ -0,0 +1,93 @@
+# Installation
+
+## Installation Methods
+
+### 1. Direct installation from Git (Recommended for internal use)
+
+```bash
+pip install git+https://github.com/yourcompany/prestashop-webservice.git
+```
+
+### 2. Installation from Git with specific version
+
+```bash
+pip install git+https://github.com/yourcompany/prestashop-webservice.git@v0.1.0
+```
+
+### 3. Installation in development mode
+
+```bash
+git clone https://github.com/yourcompany/prestashop-webservice.git
+cd prestashop-webservice
+pip install -e .
+```
+
+### 4. Installation with development dependencies
+
+```bash
+pip install -e ".[dev]"
+```
+
+### 5. Using requirements.txt
+
+Add to your `requirements.txt`:
+
+```
+git+https://github.com/yourcompany/prestashop-webservice.git@v0.1.0
+```
+
+Then install:
+
+```bash
+pip install -r requirements.txt
+```
+
+### 6. Using as Git submodule
+
+```bash
+# Add as submodule
+git submodule add https://github.com/yourcompany/prestashop-webservice.git libs/prestashop-webservice
+
+# Install
+pip install -e libs/prestashop-webservice
+```
+
+## Verify installation
+
+```python
+import prestashop_webservice
+print(prestashop_webservice.__version__)
+```
+
+## Requirements
+
+- Python >= 3.10
+- httpx >= 0.25.0
+- cachetools >= 5.3.0
+- loguru >= 0.7.0
+
+## Troubleshooting
+
+### Error: No module named 'prestashop_webservice'
+
+Make sure you have installed the package correctly:
+
+```bash
+pip list | grep prestashop
+```
+
+### Permission errors
+
+On some systems you will need to use `sudo` or install in a virtual environment:
+
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+pip install git+https://github.com/yourcompany/prestashop-webservice.git
+```
+
+### Update to latest version
+
+```bash
+pip install --upgrade git+https://github.com/yourcompany/prestashop-webservice.git
+```