Rutgers University URL Shortener
Project description
shrunk
A URL shortener for Rutgers University. For more information, contact Rutgers Open System Solutions.
Uses MongoDB. Python code targets Python 3.3.
Virtual Environment
Python dependencies are enumerated in pip.req
. You can set up an appropriate
virtual environment with the following:
$ virtualenv --no-site-packages --python="python3" virtualenv
$ source virtualenv/bin/activate
$ pip install -r pip.req
Documentation
After setting up the virtual environment, you can generate HTML documentation
by running ./build_docs.sh
from the root of the project. The documentation will
be placed in ./docs_out
.
Features
Web Application
- Log in with a Rutgers NetID
- Create a short URL from a long URL
- Given a NetID, what URLs have they created?
- Analytics on visits
URL Shortening Service
- Given a short URL, redirect to the long URL
- Track visits to the short URL
- Track popularity and number of clicks
Distribution steps
assuming you're in the root of the git repo
- git tag -m "some description/changelog"
rm -rf dist/ shrunk.egg-info
python3 setup.py sdist
puts a tar in dist/python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
to upload to test pypipython3 -m twine upload dist/*
to upload to pypi WARNING: Don't use bdist_wheel. bdist_wheel refuses to exclude config.py, so if you have one in here for testing, it will package it and give our secret and privs out to the public
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
shrunk-0.6.7.tar.gz
(151.4 kB
view hashes)