Skip to main content

A reusable Django app that adds a link shortener like bit.ly to your site.

Project description

A Django application that adds an URL shortener to your site similar to bit.ly.

Installation

You need to install the following prerequisites in order to use this app:

pip install django
pip install requests

When using Python 2.6, you will also need to install importlib.

If you want to install the latest stable release from PyPi:

$ pip install django-tinylinks

If you feel adventurous and want to install the latest commit from GitHub:

$ pip install -e git://github.com/bitmazk/django-tinylinks.git#egg=tinylinks

Add tinylinks to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...,
    'tinylinks',
)

Add the tinylinks URLs to your urls.py:

urlpatterns = [
    url(r'^s/', include('tinylinks.urls')),
]

Don’t forget to migrate your database:

./manage.py migrate tinylinks

Settings

Usage

Just visit the root URL of the app. Let’s assume you hooked the app into your urls.py at s/, then visit yoursite.com/s/. You will see your tinylist overview. Go to yoursite.com/s/create/ to see a form to submit a new long URL.

After submitting, you will be redirected to a new page which shows the generated short URL. If you want this URL to have a different short URL, just change the short URL to your liking.

Now visit yoursite.com/s/yourshorturl and you will be redirected to your long URL.

Contribute

If you want to contribute to this project, please perform the following steps

# Fork this repository
# Clone your fork
mkvirtualenv -p python2.7 django-tinylinks
make develop

git co -b feature_branch master
# Implement your feature and tests
git add . && git commit
git push -u origin feature_branch
# Send us a pull request for your feature branch

In order to run the tests, simply execute tox. This will install two new environments (for Django 1.8 and Django 1.9) and run the tests against both environments.

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-tinylinks-0.7.tar.gz (17.8 kB view hashes)

Uploaded Source

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