baseapp-url-shortening 0.1.0

BaseApp URL Shortening

BaseApp URL Shortening

Reusable app to enable url shortening.

How to install:

Add dependencies to your requirements/base.txt file:

baseapp-core @ git+https://github.com/silverlogic/baseapp-backend.git@v0.1#subdirectory=baseapp-core
baseapp-reactions @ git+https://github.com/silverlogic/baseapp-backend.git@v0.1#subdirectory=baseapp-url-shortening

And run provision or manually pip install -r requirements/base.ext

If you want to develop, install using this other guide.

How to use

Add baseapp_url_shortening to your project's INSTALLED_APPS

Add the following to your settings file. URL_SHORTENING_PREFIX can be any string

URL_SHORTENING_PREFIX = "c"

Add the following to your apps/urls.py file

urlpatterns = [
    re_path(r"", include("baseapp_url_shortening.urls")),
]

Writing test cases in your project

There is a ShortUrlFactory which helps you write other factories:

import factory
from baseapp_url_shortening.tests.factories import ShortUrlFactory

How to develop

Clone the project inside your project's backend dir:

git clone [e-mail]:silverlogic/baseapp-backend.git

And manually install the package:

pip install -e baseapp-backend/baseapp-url-shortening

The -e flag will make it like any change you make in the cloned repo files will effect into the project.