A reusable Django app that adds a link shortener like bit.ly to your site.
A Django application that adds an URL shortener to your site similar to bit.ly.
This is an early alpha. Use it with caution.
You need to install the following prerequisites in order to use this app:
pip install django==1.4.2 pip install South==0.7.6 pip install django-libs==0.8 pip install urllib3==1.5
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 = patterns('', ... url(r'^s/', include('tinylinks.urls')), )
Don’t forget to migrate your database:
./manage.py migrate tinylinks
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.
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 $ pip install -r requirements.txt $ ./tinylinks/tests/runtests.sh # You should get no failing tests $ git co -b feature_branch master # Implement your feature and tests $ ./tinylinks/tests/runtests.sh # You should still get no failing tests # Describe your change in the CHANGELOG.txt $ git add . && git commit $ git push origin feature_branch # Send us a pull request for your feature branch
Whenever you run the tests a coverage output will be generated in tests/coverage/index.html. When adding new features, please make sure that you keep the coverage at 100%.
If you are making changes that need to be tested in a browser (i.e. to the CSS or JS files), you might want to setup a Django project, follow the installation insttructions above, then run python setup.py develop. This will just place an egg-link to your cloned fork in your project’s virtualenv.
Check the issue tracker on github for milestones and features to come.