Skip to main content
https://badge.fury.io/py/django-addthis.svg https://img.shields.io/pypi/pyversions/django-addthis.svg https://img.shields.io/pypi/djversions/django-addthis.svg https://github.com/bashu/django-addthis/actions/workflows/test.yml/badge.svg

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

Maintained by Basil Shubin, and some great contributors.

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!

Credits

django-addthis was originally started by Raymond Wanyoike who has now unfortunately abandoned the project.

License

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

Changes

3.0.3 (2026-08-14)

  • Modernize packaging: switch from setup.py/setup.cfg to pyproject.toml

  • Replace Travis CI with GitHub Actions for tests and PyPI releases

  • Add Dependabot and pre-commit configuration

  • Support Django 5.2, 6.0 and 6.1; drop support for Python < 3.10

  • Clean up ruff lint findings in template tags and tests

3.0.2 (2021-09-13)

  • Made sure the app runs on Django 3.2

3.0.1 (2020-10-13)

  • Nothing…

3.0.0 (2015-08-04)

  • Support Django 1.6+

  • New template tag

2.0.2 (2015-03-26)

  • Refactor

2.0.1 (2014-11-24)

  • Add GNU GPL v3.0 license

2.0.0 (2014-11-24)

1.0.1 (2014-11-24)

  • Fix/Remove invalid “ui_use_css” config

1.0.0 (2014-11-24)

  • Initial release

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_addthis-3.0.3-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file django_addthis-3.0.3.tar.gz.

File metadata

  • Download URL: django_addthis-3.0.3.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_addthis-3.0.3.tar.gz
Algorithm Hash digest
SHA256 54253eb08780d6893bfea9fd378972b24dd3f14b09da02411391d3ab79c70358
MD5 e474ca306bec53a6e6cc779a3bc67a2a
BLAKE2b-256 47be1fb32b17bd960be2c2b3424ba00de194ee71edac6a4b2d6d21de4784175a

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_addthis-3.0.3.tar.gz:

Publisher: release.yml on bashu/django-addthis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_addthis-3.0.3-py3-none-any.whl.

File metadata

  • Download URL: django_addthis-3.0.3-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_addthis-3.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d6a4b84d5b8d84818ddd956dd4adbbbcbe50580ab68dca8a1516f79b3391ede0
MD5 2cb33840d38c6c2900d276b00a9fe320
BLAKE2b-256 32c485ee3e2b9f35e0cf208ffc87347f602e22142b0e6a732aeaf09dc5d6613f

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_addthis-3.0.3-py3-none-any.whl:

Publisher: release.yml on bashu/django-addthis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

3.0.3 This release

2 files

3.0.2

2 files

3.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page