Skip to main content

Twitter feed widget for django-fluent-contents

Project description

fluentcms-twitterfeed

Twitter feed widget for django-fluent-contents

https://img.shields.io/pypi/v/fluentcms-twitterfeed.svg https://img.shields.io/github/license/bashu/fluentcms-twitterfeed.svg https://landscape.io/github/bashu/fluentcms-twitterfeed/develop/landscape.svg?style=flat

Installation

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

pip install fluentcms-twitterfeed

Backend Configuration

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

Then add the following settings:

INSTALLED_APPS += (
    'fluentcms_twitterfeed',
)

The database tables can be created afterwards:

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:

{% 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.

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:

  1. Go to https://twitter.com/settings/widgets and create new widget, select “User timeline” as source

  2. Configure the options (theme, colours etc) as described in https://dev.twitter.com/docs/embedded-timelines

  3. Get the value of data-widget-id in the embed code

  4. 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.

  1. Go to https://twitter.com/settings/widgets and create new widget, select “Search” as source

  2. Configure the search query and options (theme, colours etc) as described in https://dev.twitter.com/docs/embedded-timelines

  3. Get the value of data-widget-id in the embed code

  4. 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

  5. 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. :-)

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

fluentcms-twitterfeed-1.0.1.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

fluentcms_twitterfeed-1.0.1-py2.py3-none-any.whl (14.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fluentcms-twitterfeed-1.0.1.tar.gz.

File metadata

File hashes

Hashes for fluentcms-twitterfeed-1.0.1.tar.gz
Algorithm Hash digest
SHA256 27c4e469a47d4ead3745f16e3026a5d10cb15dd97901d6877694a1aa6f614a15
MD5 4435d2a5c020751b239e8a1ac145e307
BLAKE2b-256 8b52ed23e8f4a29f6635e445bee702f0eddd3856c57de2e3c321c82f2c83f768

See more details on using hashes here.

Provenance

File details

Details for the file fluentcms_twitterfeed-1.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fluentcms_twitterfeed-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d37e83faf4d1af2c1c4ecf92657af51ae2b27144a1d1da49affe773ce9b8bd2f
MD5 72ed8d9de50aecaae4a155ad17794c14
BLAKE2b-256 5f6e70197bc4c0b025ae683922ef76a3670b9f9e9b69ecab3f60e0624487bc32

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page