Skip to content

Latest commit

 

History

History
147 lines (106 loc) · 5.71 KB

README.rst

File metadata and controls

147 lines (106 loc) · 5.71 KB
https://travis-ci.org/shuup/shuup.svg?branch=master https://coveralls.io/repos/github/shuup/shuup/badge.svg?branch=master PyPI Known Vulnerabilities

Shuup

Shuup is an Open Source E-Commerce Platform based on Django and Python.

https://shuup.com/

Copyright

Copyright (c) 2012-2020 by Shoop Commerce Ltd. <support@shuup.com>

Shuup is International Registered Trademark & Property of Shoop Commerce Ltd., Business ID: FI27184225, Business Address: Iso-Roobertinkatu 20-22, 00120 HELSINKI, Finland.

CLA

Contributor License Agreement is required for any contribution to this project. Agreement is signed as a part of pull request process. See the CLA.rst file distributed with Shuup.

License

Shuup is published under Open Software License version 3.0 (OSL-3.0). See the LICENSE file distributed with Shuup.

Some external libraries and contributions bundled with Shuup may be published under other compatible licenses. For these, please refer to VENDOR-LICENSES.md file in the source code tree or the licenses included within each package.

Chat

We have a Gitter chat room for Shuup. Come chat with us! Join chat

Install Shuup

See Getting Started.

For simple project example see our Django-project template.

Getting Started with Shuup development

See Getting Started with Shuup Development.

Contributing to Shuup

Interested in contributing to Shuup? Please see our Contribution Guide.

Documentation

Shuup documentation is available online at Read the Docs.

Documentation is built with Sphinx.

Issue the following commands to build the documentation:

pip install -r requirements-doc.txt
cd doc && make html

To update the API documentation rst files, e.g. after adding new modules, use command:

./generate_apidoc.py

Roadmap

  • Per object placeholders. Option to add content per contact group, category, product and CMS page. #1220 ✅.
  • Pricing cache. To improve the performance issues with complex catalog campaigns. #1163 ✅.
  • Improve shop product purchasable attribute. #1281 ✅.
  • Option for 'centrally' or 'separately' managed products. #1275.
  • Improve product stock behavior. #1249.
  • Improved unit tests for the multishop feature. #1160.
  • Improve order status and order status history. #1211.
  • Initial support for Django 2.0. #1289.
  • OS Admin design/UX overhaul.
  • Various smaller issues from the issues-list.

OS Addons

The purpose of these addons, is to demonstrate how to build other simple addons to extend Shuup. To learn more, here are some useful links about how to extend Shuup.

Admin Preview

doc/_static/admin_shop_product.png doc/_static/admin_order_detail.png