.. image:: https://travis-ci.org/shuup/shuup.svg?branch=master
.. image:: https://coveralls.io/repos/github/shuup/shuup/badge.svg?branch=master
Shuup is an Open Source E-Commerce Platform based on Django and Python.
Copyright (C) 2012-2016 by Shoop Commerce Ltd. firstname.lastname@example.org
Shuup is International Registered Trademark & Property of Shoop Commerce Ltd.,
Business ID: FI24815722, Business Address: Aurakatu 12 B, 20100 Turku,
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.
Shuup is published under the GNU Affero General Public License,
version 3 (AGPLv3). See the LICENSE file distributed with Shuup.
Some external libraries and contributions bundled with Shuup may be
published under other AGPLv3-compatible licenses. For these, please
refer to VENDOR-LICENSES.md file in the source code tree or the licenses
included within each package.
We have a Gitter chat room for Shuup. Come chat with us! |Join chat|
Getting Started with Shuup development
Getting Started with Shuup Development
Contributing to Shuup
Interested in contributing to Shuup? Please see our
Shuup documentation is available online at
Read the Docs
Documentation is built with
Issue the following commands to build the documentation:
.. code:: sh
pip install Sphinx # to install Sphinx cd doc && make html
To update the API documentation rst files, e.g. after adding new
modules, use command:
.. code:: sh