Skip to main content

Generic user wishlists for use with any Django model.

Project description

https://img.shields.io/pypi/v/django-wishlist.svg https://img.shields.io/travis/dokterbob/django-wishlist/master.svg https://coveralls.io/repos/dokterbob/django-wishlist/badge.svg?branch=master&service=github Code Health

Generic user wishlists for use with any Django model.

What is it?

Generic user wishlists for shops and the likes.

Status

Alpha. Don’t use it, unless you’re willing to fix issues. Will be released on PyPI as soon as tested in limited production.

Compatibility

Tested to work with Django 1.8 and 1.9 and Python 2.7.

Requirements

Please refer to requirements.txt for an updated list of required packages.

Installation

The package is available

To install:

  1. Install the django-wishlist app:

    pip install django-wishlist
    
  2. In your Django settings:

    • Add ‘wishlist’ to INSTALLED_APPS.
    • Configure WISHLIST_ITEM_MODEL to the model used for wishlist items.
    • Optionally: add wishlist.context_processors.wishlist_items to your TEMPLATE_CONTEXT_PROCESSORS.

    For example:

    INSTALLED_APPS = [
        ...
        'wishlist'
        ...
    ]
    
    TEMPLATE_CONTEXT_PROCESSORS = [
        ...
        'wishlist.context_processors.wishlist_items',
        ...
    ]
    
    WISHLIST_ITEM_MODEL = 'my_webshop.Product'
    
  3. In urls.py add:

    (r'^/wishlist/', include('wishlist.urls')),
    
  4. Update the database:

    ./manage.py migrate
    

    Note Migrations do not work as the model is dynamically configured.

Usage

Create a button to add an item to the wishlist simply from within your template.

At the top of the page add:

{% load wishlist_tags %}

And where you want the button add:

{% wishlist_add_form product %}

Where product is the product you want to add to the wishlist.

Tests

Tests for pull req’s and the master branch are automatically run through Travis CI.

License

This application is released under the GNU Affero General Public License version 3.

Changes

1.0 (6-5-2016)

  • Move tests to project root, use Django’s native test runner.
  • Support Django 1.8 and 1.9.
  • Drop support for Django 1.7 and below.
  • Production release after about a year of internal production use.

0.2

  • Never released but used internally in production.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-wishlist-1.0.tar.gz (23.4 kB view hashes)

Uploaded source

Built Distribution

django_wishlist-1.0-py2-none-any.whl (19.4 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page