Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bashu/django-addthis
👍 A simple integration of the AddThis social sharing widget for Django projects
https://github.com/bashu/django-addthis
addthis django facebook twitter
Last synced: 7 days ago
JSON representation
👍 A simple integration of the AddThis social sharing widget for Django projects
- Host: GitHub
- URL: https://github.com/bashu/django-addthis
- Owner: bashu
- License: gpl-3.0
- Created: 2013-08-01T09:38:45.000Z (over 11 years ago)
- Default Branch: develop
- Last Pushed: 2021-12-14T07:04:42.000Z (almost 3 years ago)
- Last Synced: 2024-10-04T06:18:44.168Z (about 1 month ago)
- Topics: addthis, django, facebook, twitter
- Language: Python
- Homepage:
- Size: 69.3 KB
- Stars: 10
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
django-addthis
==============
.. image:: https://img.shields.io/pypi/v/django-addthis.svg
:target: https://pypi.python.org/pypi/django-addthis/
.. image:: https://img.shields.io/pypi/dm/django-addthis.svg
:target: https://pypi.python.org/pypi/django-addthis/
.. image:: https://img.shields.io/github/license/bashu/django-addthis.svg
:target: https://pypi.python.org/pypi/django-addthis/
.. image:: https://app.travis-ci.com/bashu/django-addthis.svg?branch=develop
:target: https://app.travis-ci.com/bashu/django-addthis
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:
.. code:: shell
pip install django-addthis
Setup
-----
You'll need to add ``addthis`` to ``INSTALLED_APPS`` in your project's ``settings.py`` file:
.. code:: python
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:
.. code:: python
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:
.. code:: html+django
{% load addthis %}
then load the widget:
.. code:: html+django
{% addthis_widget %}
#. Visit the AddThis `Get the Code `_ page and create/generate your social sharing code, e.g:
.. code:: html+django
Be sure to omit the:
.. code:: html+django
part of the (generated) code as the ``addthis_widget`` template tag takes care of this.
Example
~~~~~~~
.. code:: html+django
{% load addthis %}
django-addthis Example
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.
{% addthis_widget %}
`_ was originally started by `Raymond Wanyoike `_ who has now unfortunately abandoned the project.
License
-------
``django-addthis`` is released under the GNU GPL v3 license.
.. _django: https://www.djangoproject.com