Metadata-Version: 2.1
Name: django-tips
Version: 0.8.2
Summary: Show tip of the day cards on your site.
Home-page: https://github.com/trojsten/django-tips
License: BSD-3-Clause
Author: Michal Hozza
Author-email: mhozza@gmail.com
Requires-Python: >=3.5,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: django (>=2.0,<3.0)
Requires-Dist: djangorestframework (>=3.10)
Requires-Dist: markdown (>=2.6)
Project-URL: Repository, https://github.com/trojsten/django-tips
Description-Content-Type: text/x-rst

=============================
django-tips
=============================

.. image:: https://badge.fury.io/py/django-tips.png
    :target: https://badge.fury.io/py/django-tips

.. image:: https://travis-ci.org/trojsten/django-tips.png?branch=master
    :target: https://travis-ci.org/trojsten/django-tips

Show tip of the day cards on your site.

Quickstart
----------

Install django-tips::

    pip install django-tips

Then use it in a project::

    import tips

Requirements
------------

* django
* djangorestframework
* markdown

Recommanded packages
--------------------

* django-sekizai

Building frontend
-----------------

From tips_frontend directory run::

    npm run dev

or production build::

    npm run build

Usage
-----
place where you want to show tips::

    {% include "tips/tips.html" %}

include csrf-token ajax setup script if you have csrf protection enabled (you can find the script in the example)::

    <script src="{% static "js/csrf_token.js" %}"></script>

Development
-----------
::

    pip install poetry
    poetry install
    cd example
    ./manage.py migrate
    ./manage.py loaddata fixtures/initial_data.json
    ./manage.py createsuperuser
    ./manage.py runserver

Credits
-------

Tools used in rendering this package:

*  Cookiecutter_
*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/trojsten/cookiecutter-djangopackage

