django-addthis

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

These details have not been verified by PyPI

Project links

Project description

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

First of all, load the addthis in every template where you want to use it:
```
{% load addthis %}
```
You can pass these options as arguments:

Option

Default

Description

pub_id

Site profile id (see configuration above).

then load the widget:
```
{% addthis_widget %}
```

Option	Default	Description
pub_id		Site profile id (see configuration above).

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

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

3.0.2

Sep 20, 2021

This version

3.0.1

Oct 13, 2020

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.1.tar.gz (19.3 kB view details)

Uploaded Oct 13, 2020 Source

Built Distribution

django_addthis-3.0.1-py2.py3-none-any.whl (18.0 kB view details)

Uploaded Oct 13, 2020 Python 2 Python 3

File details

Details for the file django-addthis-3.0.1.tar.gz.

File metadata

Download URL: django-addthis-3.0.1.tar.gz
Upload date: Oct 13, 2020
Size: 19.3 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: Python-urllib/3.8

File hashes

Hashes for django-addthis-3.0.1.tar.gz
Algorithm	Hash digest
SHA256	`abbd1c1127ac1aeef5fe266a8d2103f4334cb89f315a6d1d5b1b3f263c6260ea`
MD5	`400b2962050710e252bea4b760861f35`
BLAKE2b-256	`42b87f2c392c497976ef4f94a42eafd0b6e1398d1e8a997baecf4b2b5a260367`

See more details on using hashes here.

File details

Details for the file django_addthis-3.0.1-py2.py3-none-any.whl.

File metadata

Download URL: django_addthis-3.0.1-py2.py3-none-any.whl
Upload date: Oct 13, 2020
Size: 18.0 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No
Uploaded via: Python-urllib/3.8

File hashes

Hashes for django_addthis-3.0.1-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`702339160a7466cce750d97ef51e72b88d615bd797341cf31c106680c4112270`
MD5	`fd5ba7ea2aa981aaee1c5030a76a52d1`
BLAKE2b-256	`d5ddd7444eeb7477850efa2ae9a87a51c3630de5e32c7780deb814149bc43972`