Metadata-Version: 2.0
Name: fluentcms-twitterfeed
Version: 1.0.1
Summary: Twitter feed widget for django-fluent-contents
Home-page: https://github.com/bashu/fluentcms-twitterfeed
Author: Basil Shubin
Author-email: basil.shubin@gmail.com
License: Apache License, Version 2.0
Download-URL: https://github.com/bashu/fluentcms-twitterfeed/zipball/master
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires: Django (>=1.4)
Requires-Dist: django-fluent-contents (>=1.0)
Requires-Dist: twitter-text-py

fluentcms-twitterfeed
=====================

Twitter feed widget for django-fluent-contents_

.. image:: https://img.shields.io/pypi/v/fluentcms-twitterfeed.svg
    :target: https://pypi.python.org/pypi/fluentcms-twitterfeed/

.. image:: https://img.shields.io/github/license/bashu/fluentcms-twitterfeed.svg
    :target: https://pypi.python.org/pypi/fluentcms-twitterfeed/

.. image:: https://landscape.io/github/bashu/fluentcms-twitterfeed/develop/landscape.svg?style=flat
    :target: https://landscape.io/github/bashu/fluentcms-twitterfeed/develop

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

First install the module, preferably in a virtual environment. It can be installed from PyPI:

.. code-block:: shell

    pip install fluentcms-twitterfeed


Backend Configuration
---------------------

First make sure the project is configured for django-fluent-contents_.

Then add the following settings:

.. code-block:: python

    INSTALLED_APPS += (
        'fluentcms_twitterfeed',
    )

The database tables can be created afterwards:

.. code-block:: shell

    python ./manage.py migrate

Now, the ``TwitterSearchPlugin`` and ``TwitterRecentEntriesPlugin``
can be added to your ``PlaceholderField`` and ``PlaceholderEditorAdmin`` admin screens.

Frontend Configuration
----------------------

Make sure that all plugin media files are exposed by django-fluent-contents_:

.. code-block:: html+django

    {% load fluent_contents_tags %}

    {% render_content_items_media %}

This tag should be placed at the bottom of the page, after all plugins
are rendered.  For more configuration options - e.g. integration with
django-compressor - see the `template tag documentation
<http://django-fluent-contents.readthedocs.org/en/latest/templatetags.html#frontend-media>`_.

CSS Code
~~~~~~~~

The stylesheet code is purposefully left out, since authors typically like to provide their own styling.

JavaScript Code
~~~~~~~~~~~~~~~

No configuration is required for the JavaScript integration.

By default, the plugin includes all required JavaScript code.

HTML code
~~~~~~~~~

If needed, the HTML code can be overwritten by redefining
``fluentcms_twitterfeed/recent_entries.html`` add / or ``fluentcms_twitterfeed/search.html``.

Usage
=====

TwitterRecentEntriesPlugin
--------------------------

For this plugin it's not necessary to create a widget for every plugin
in your website; you could just consider the widget you create on the
Twitter website as *template* for this content plugin:

#. Go to https://twitter.com/settings/widgets and create new widget, select "**User timeline**" as source
#. Configure the options (theme, colours etc) as described in https://dev.twitter.com/docs/embedded-timelines
#. Get the value of ``data-widget-id`` in the embed code
#. Add / modify the **Recent twitter entries** content plugin in
   django admin, fill in the ``widget id`` field using the
   ``data-widget-id`` value from the previous step

Note: ``data-widget-id`` value can be shared by any number of plugins instances, the
plugin-provided user timeline will be shown, while the twitter widget graphics
appearance will be used.

TwitterSearchPlugin
-------------------

The twitter widget used by this plugin is entirely configured on the twitter
website.

#. Go to https://twitter.com/settings/widgets and create new widget, select "**Search**" as source
#. Configure the search query and options (theme, colours etc) as
   described in https://dev.twitter.com/docs/embedded-timelines
#. Get the value of ``data-widget-id`` in the embed code
#. Add / modify the **Twitter search timeline** content plugin in
   django admin, fill in the ``widget id`` field using the
   ``data-widget-id`` value from the previous step
#. Optionally fill-in the query field in the plugin form; this is only used for
   non-javascript enabled browser, as the ``data-widget-id`` will take over on
   javascript-enabled ones

Contributing
------------

If you like this module, forked it, or would like to improve it, please let us know!
Pull requests are welcome too. :-)

.. _django-fluent-contents: https://github.com/edoburu/django-fluent-contents


