Skip to main content

Simple integration of the AddThis social sharing widget for Django projects.

Project description

django-addthis

A simple integration of the AddThis social sharing widget for Django projects.

Authored by Raymond Wanyoike, and some great contributors.

https://img.shields.io/pypi/v/django-addthis.svg https://img.shields.io/pypi/dm/django-addthis.svg https://img.shields.io/github/license/bashu/django-addthis.svg https://img.shields.io/travis/bashu/django-addthis.svg

Installation

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

pip install django-addthis

Setup

You’ll need to add addthis to INSTALLED_APPS in your project’s settings.py file:

INSTALLED_APPS += [
    'addthis',
]

Configuration

The addthis_widget template tag requires a site profile id: pub_id. Either pass it as pub_id, or set PUB_ID in your ADDTHIS_SETTINGS settings dictionary:

ADDTHIS_SETTINGS = {
    'PUB_ID': 'xx-xxxxxxxxxxxxxxxx',
    ...
}

The site profile id can be found by visiting its Profile Options page on AddThis (ID:).

There are a few configuration options for addthis that can be placed in your ADDTHIS_SETTINGS settings dictionary:

Option

Default

USERNAME

SERVICES_EXCLUDE

SERVICES_COMPACT

SERVICES_EXPANDED

SERVICES_CUSTOM

UI_CLICK

False

UI_DELAY

0

UI_HOVER_DIRECTION

0

UI_LANGUAGE

UI_OFFSET_TOP

0

UI_OFFSET_LEFT

0

UI_HEADER_COLOR

UI_HEADER_BACKGROUND

UI_COBRAND

UI_USE_CSS

True

UI_USE_ADDRESSBOOK

False

UI_508_COMPLIANT

False

DATA_TRACK_CLICKBACK

True

DATA_GA_TRACKER

Please see the example application. This application is used to manually test the functionalities of this package. This also serves as a good example.

You need Django 1.8 or above to run that. It might run on older versions but that is not tested.

Usage

  1. First of all, load the addthis in every template where you want to use it:

    {% load addthis %}

    then load the widget:

    {% addthis_widget %}
  2. Visit the AddThis Get the Code page and create/generate your social sharing code, e.g:

    <!-- Go to www.addthis.com/dashboard to customize your tools -->
    <div class="addthis_sharing_toolbox"></div>

    Be sure to omit the:

    <script type="text/javascript" src="//s7.addthis.com/js/300/addthis_widget.js#pubid=xx-xxxxxxxxxxxxxxxx"></script>

    part of the (generated) code as the addthis_widget template tag takes care of this.

Example

{% load addthis %}

<!DOCTYPE html>

<html>
<head>
  <meta charset="utf-8">
  <title>django-addthis Example</title>
</head>

<body>
  <!-- Go to www.addthis.com/dashboard to customize your tools -->
  <div class="addthis_sharing_toolbox"></div>

  <p>Well, the way they make shows is, they make one show. That show's
  called a pilot. Then they show that show to the people who make shows,
  and on the strength of that one show they decide if they're going to
  make more shows. Some pilots get picked and become television programs.
  Some don't, become nothing. She starred in one of the ones that became
  nothing.</p>

  <!-- Placed at the end of the document so the page load faster -->
  {% addthis_widget %}
</body>
</html

Contributing

If you’ve found a bug, implemented a feature or customized the template and think it is useful then please consider contributing. Patches, pull requests or just suggestions are welcome!

License

django-addthis is released under the GNU GPL v3 license.

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-addthis-3.0.2.tar.gz (20.9 kB view hashes)

Uploaded Source

Built Distribution

django_addthis-3.0.2-py3-none-any.whl (20.2 kB view hashes)

Uploaded Python 3

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