semvec/pypi-packages huggingface dataset:
django-happystamp 0.3
Happystamp is a Mezzanine plugin for building loyalty card systems
License: BSD License

Created by `Hicham El Mansouri <https://twitter.com/dr_hichman>`_

========
License
========

This software is open sourced under `BSD licensed`_.

========
Overview
========

Happystamp is a `Django`_ application for building loyalty card systems. It's built on the top of `Mezzanine`_ CMS platform. This application provides, OOTB, the key features for a loyalty system like program setup, redeem/reward transaction and much more. 

Features
========

* Point of sale setup
* Loyalty program setup
* QR codes generation for `Happystamp app`_
* Customer enrollment
* Card history with executed transactions
* Redeem/reward transactions
* Marketing notifications
* REST api for `Happystamp app`_
* ...

Dependencies
============

* Happystamp is designed as a plugin for the `Mezzanine`_ content management platform, and therefore requires `Mezzanine`_ to be installed.
* `Django Rest Framework`_ is required to provide REST api 
* `QR Code`_ for QR codes generation
* `Django storages`_ is required to support S3 storage for static/media files

Installation
============

1. The easiest way is to install directly from PyPI using `pip`_::

    $ pip install django-happystamp

2. Add 'happystamp' to the INSTALLED_APPS in your project’s settings.py::

    INSTALLED_APPS = (
        ...
        "happystamp",    
    )

3. Add 'happystamp' urls by updating your project's urls.py::

    urlpatterns = patterns('',     
        url(r"^", include('happystamp.urls')),       
    )

4. Run `python manage.py migrate` to create happystamp models

5. Start the development server and visit http://127.0.0.1:8000/admin/
   to see happystamp objects

To uninstall Happystmp, simply comment out or remove the 'happystamp' line in your INSTALLED_APPS.

Contributing
============

Happystmp is an open source project managed using Git. The repository is hosted on `GitHub`_.

Support
=======

To report a security issue, please send an email privately to
`admin+security@happystamp.fr`_. 


For all other Happystamp support, please send an email to
`admin@happystamp.fr`_.  


If you're certain you've come across a bug, then please use the
`GitHub issue tracker`_.

.. _`Django`: http://djangoproject.com
.. _`BSD licensed`: http://www.linfo.org/bsdlicense.html
.. _`Happystamp app`: http://play.google.com/store/apps/details?id=com.happystamp&hl=fr
.. _`Mezzanine`: http://mezzanine.jupo.org
.. _`Happystamp Project`: http://www.happystamp.fr
.. _`pip`: http://www.pip-installer.org
.. _`Django Rest Framework`: http://www.django-rest-framework.org
.. _`QR Code`: http://pypi.python.org/pypi/qrcode
.. _`Django storages`: http://github.com/jschneier/django-storages
.. _`Github`: http://github.com/hicham-elmansouri/django-happystamp
.. _`Github issue tracker`: http://github.com/hicham-elmansouri/django-happystamp/issues
.. _`admin+security@happystamp.fr`: mailto:admin@happystamp.fr?subject=Security+Issue
.. _`admin@happystamp.fr`: mailto:admin@happystamp.fr?subject=Support