/shuup-wishlist

Shuup Wishlist Addon

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

https://travis-ci.org/shuup/shuup-wishlist.svg?branch=master https://coveralls.io/repos/github/shuup/shuup-wishlist/badge.svg?branch=master

Shuup Wishlist

This package implements wishlists for the Shuup platform.

Copyright

Copyright (C) 2012-2018 by Shuup Inc. <support@shuup.com>

Shuup is International Registered Trademark & Property of Shuup Inc., Business Address: 1013 Centre Road, Suite 403-B, Wilmington, Delaware 19805, United States Of America

License

Shuup Wishlist is published under the GNU Affero General Public License, version 3 (AGPLv3). See the LICENSE file.

Chat

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

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 Sphinx  # to install Sphinx
cd doc && make html

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

./generate_apidoc.py

Running tests

You can run tests with py.test.

Requirements for running tests:

  • Your virtualenv needs to have Shuup installed.

  • Project root must be in the Python path. This can be done with:

    pip install -e .
  • The packages from testing_requirements.txt must be installed.

    pip install -r testing_requirements.txt

To run tests, use command:

py.test -v shuup_wishlist_tests

Building a release

  • python setup.py bdist_wheel