https://github.com/prikhi/mezzanine-linkdump

Link Sharing in Mezzanine.
https://github.com/prikhi/mezzanine-linkdump

django mezzanine python

Last synced: 3 months ago
JSON representation

Link Sharing in Mezzanine.

• Host: GitHub
• URL: https://github.com/prikhi/mezzanine-linkdump
• Owner: prikhi
• License: gpl-3.0
• Created: 2014-04-22T18:16:06.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-09-20T07:59:52.000Z (over 10 years ago)
• Last Synced: 2024-09-18T00:39:02.627Z (4 months ago)
• Topics: django, mezzanine, python
• Language: Python
• Size: 236 KB
• Stars: 6
• Watchers: 6
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=========

LinkDump

=========

LinkDump is a Mezzanine module that lets you create, display and track links.

Example usage can be seen at `SleepAnarchy.com`_

Usage

======

Install the package and dependencies via pip::

    pip install mezzanine-linkdump

Add the ``linkdump`` app and the ``mptt`` dependency to your

``INSTALLED_APPS``::

    INSTALLED_APPS = (

        # ...

        "mptt",

        "linkdump",

    )

Include the urls into your project's ``urls.py``::

    urlpatterns += patterns('',

        ("^links/", include('linkdump.urls')),

        ("^", include("mezzanine.urls")),

    )

If you want a shorter link for the redirects, route the URL to the

``linkdump.views.link_dump_redirect`` view::

    urlpatterns += patterns('',

        ("^links/", include('linkdump.urls')),

        (r"^l/(.*)", "linkdump.views.link_dump_redirect"),

        ("^", include("mezzanine.urls")),

    )

To integrate into the navigation, create a new Page with ``links`` as the URL.

Config

=======

The following settings may be specified in your project's ``settings.py``:

* ``LINKDUMP_SLUG_CHOICES`` - Characters used for link slugs.

* ``LINKDUMP_SLUG_LENGTH`` - Length of generated slugs.

Contributing

=============

You can install prerequisites using ``pip``::

    pip install -r requirements.txt

The official bug tracker lives at

http://bugs.sleepanarchy.com/projects/mezzanine-linkdump/, but a github mirror

is available for pull requests at http://github.com/prikhi/mezzanine-linkdump/.

.. _SleepAnarchy.com:       http://sleepanarchy.com/links/