| Name | viur-shop JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | None |
| Summary | ViUR shop-plugin |
| upload_time | 2025-07-29 14:21:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | MIT License
Copyright (c) 2023 – 2024 ViUR
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.
|
| keywords |
viur
plugin
backend
shop
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<img src="https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-shop.svg" height="196" alt="A hexagonal logo of Shop" title="Shop logo"/>
<h1>viur-shop</h1>
<a href="https://pypi.org/project/viur-shop/">
<img alt="Badge showing current PyPI version" title="PyPI" src="https://img.shields.io/pypi/v/viur-shop">
</a>
<a href='https://viur-shop.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/viur-shop/badge/?version=latest' alt='Documentation Status' />
</a>
<a href="LICENSE">
<img src="https://img.shields.io/github/license/viur-framework/viur-shop" alt="Badge displaying the license" title="License badge">
</a>
<br>
A modular e-commerce extension for the <a href="https://www.viur.dev">ViUR framework</a>.
</div>
## 📦 Features
- Fully integrated **Shop logic** via the central `shop.Shop` class: cart handling, order management, API routing, bootstrapping with custom `article_skel`, and payment/shipping modules.
- Extensible **Modules**: Address, Api, Cart, Discount, Shipping, VatRate, Order, etc. — all provided as abstract base implementations.
- **Payment Providers**: Amazon Pay, PayPal Plus, Prepayment, Invoice, and Unzer integrations (Credit Card, PayPal, SOFORT, Bancontact, iDEAL). Can be extended with custom implementations.
- **Event & Hook System**: Customize checkout and order flow with hooks for events like `ORDER_PAID`, `CART_CHANGED`, and `CHECKOUT_STARTED`.
- **Pricing & Discounts**: Automated calculation of unit and bulk prices, gross/net handling, VAT rates, savings, and discount combinations via the `Price` class.
---
## 🚀 Requirements
- [ViUR Framework (viur-core)](https://www.viur.dev/) installed and configured
- Python **3.11+**
---
## 🧩 Installation & Integration
```bash
pipenv install viur-shop
```
Integrate into your ViUR application:
```py
# deploy/modules/shop.py
from viur.shop import Shop
from skeletons.article import ArticleSkel # your custom article skeleton
shop = Shop(
name="myshop",
article_skel=ArticleSkel,
payment_providers=[
# e.g. PayPalPlus(), Invoice(), ... ,
],
suppliers=[
# optional Shop.types.Supplier(...),
],
)
```
## 🔍 Additional Resources
- Full API Reference: [viur-shop.readthedocs.io](https://viur-shop.readthedocs.io/en/latest/viur/shop/index.html)
- [Frontend Components for Vue.js](https://github.com/viur-framework/shop-components)
Raw data
{
"_id": null,
"home_page": null,
"name": "viur-shop",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "Sven Eberth <se@mausbrand.de>",
"keywords": "viur, plugin, backend, shop",
"author": null,
"author_email": "Sven Eberth <se@mausbrand.de>",
"download_url": "https://files.pythonhosted.org/packages/67/58/206f491dc4b847af0d1a948c70be6b04ddc509f22bf224779375c14ee9e5/viur_shop-0.5.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img src=\"https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-shop.svg\" height=\"196\" alt=\"A hexagonal logo of Shop\" title=\"Shop logo\"/>\n <h1>viur-shop</h1>\n <a href=\"https://pypi.org/project/viur-shop/\">\n <img alt=\"Badge showing current PyPI version\" title=\"PyPI\" src=\"https://img.shields.io/pypi/v/viur-shop\">\n </a>\n <a href='https://viur-shop.readthedocs.io/en/latest/?badge=latest'>\n <img src='https://readthedocs.org/projects/viur-shop/badge/?version=latest' alt='Documentation Status' />\n </a>\n <a href=\"LICENSE\">\n <img src=\"https://img.shields.io/github/license/viur-framework/viur-shop\" alt=\"Badge displaying the license\" title=\"License badge\">\n </a>\n <br>\n A modular e-commerce extension for the <a href=\"https://www.viur.dev\">ViUR framework</a>.\n</div>\n\n## \ud83d\udce6 Features\n\n- Fully integrated **Shop logic** via the central `shop.Shop` class: cart handling, order management, API routing, bootstrapping with custom `article_skel`, and payment/shipping modules. \n- Extensible **Modules**: Address, Api, Cart, Discount, Shipping, VatRate, Order, etc. \u2014 all provided as abstract base implementations. \n- **Payment Providers**: Amazon Pay, PayPal Plus, Prepayment, Invoice, and Unzer integrations (Credit Card, PayPal, SOFORT, Bancontact, iDEAL). Can be extended with custom implementations. \n- **Event & Hook System**: Customize checkout and order flow with hooks for events like `ORDER_PAID`, `CART_CHANGED`, and `CHECKOUT_STARTED`. \n- **Pricing & Discounts**: Automated calculation of unit and bulk prices, gross/net handling, VAT rates, savings, and discount combinations via the `Price` class.\n\n---\n\n## \ud83d\ude80 Requirements\n\n- [ViUR Framework (viur-core)](https://www.viur.dev/) installed and configured \n- Python **3.11+** \n\n---\n\n## \ud83e\udde9 Installation & Integration\n\n```bash\npipenv install viur-shop\n```\n\nIntegrate into your ViUR application:\n```py\n# deploy/modules/shop.py\nfrom viur.shop import Shop\nfrom skeletons.article import ArticleSkel # your custom article skeleton\n\nshop = Shop(\n name=\"myshop\",\n article_skel=ArticleSkel,\n payment_providers=[\n # e.g. PayPalPlus(), Invoice(), ... ,\n ],\n suppliers=[\n # optional Shop.types.Supplier(...),\n ],\n)\n```\n\n## \ud83d\udd0d Additional Resources\n\n- Full API Reference: [viur-shop.readthedocs.io](https://viur-shop.readthedocs.io/en/latest/viur/shop/index.html)\n- [Frontend Components for Vue.js](https://github.com/viur-framework/shop-components)\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2023 \u2013 2024 ViUR\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "ViUR shop-plugin",
"version": "0.5.1",
"project_urls": {
"Bug Tracker": "https://github.com/viur-framework/viur-shop/issues",
"Documentation": "https://viur-shop.readthedocs.io",
"Repository": "https://github.com/viur-framework/viur-shop.git"
},
"split_keywords": [
"viur",
" plugin",
" backend",
" shop"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6e2beed5e5680c8c5408e016d052406863359062265f830d214edfcd67271e5a",
"md5": "2aa429a37d868dfa831ccae690cfd9c2",
"sha256": "b168054552badd5f42f46116fbc157588387ff1d60ca6a76c71946b6e7b2370b"
},
"downloads": -1,
"filename": "viur_shop-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2aa429a37d868dfa831ccae690cfd9c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 94103,
"upload_time": "2025-07-29T14:21:01",
"upload_time_iso_8601": "2025-07-29T14:21:01.323761Z",
"url": "https://files.pythonhosted.org/packages/6e/2b/eed5e5680c8c5408e016d052406863359062265f830d214edfcd67271e5a/viur_shop-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6758206f491dc4b847af0d1a948c70be6b04ddc509f22bf224779375c14ee9e5",
"md5": "d083ddc5d6a23193ab7fe629acc8d4d8",
"sha256": "82e74145009d2d77f12cd504a070e39e01165e44bb9a95c5f50a84b9b17be676"
},
"downloads": -1,
"filename": "viur_shop-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "d083ddc5d6a23193ab7fe629acc8d4d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 71056,
"upload_time": "2025-07-29T14:21:02",
"upload_time_iso_8601": "2025-07-29T14:21:02.320563Z",
"url": "https://files.pythonhosted.org/packages/67/58/206f491dc4b847af0d1a948c70be6b04ddc509f22bf224779375c14ee9e5/viur_shop-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-29 14:21:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "viur-framework",
"github_project": "viur-shop",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "viur-shop"
}
