Skip to main content

A django one-time file streaming application

Project description

Description

A Django file streaming application to provide download links that only valid for one time click. Ispired by django-dynamic-link.

License

BSD-3-Clause license

Notes

  • Tested with Django 2.2

  • Tested with Django 3.1

Features

  • One-time only download link

Installation

Dependences

  • This app only

Installation

Installation with pip (recommended)

Pip will download and install the package and take care of all the dependences. If you havn’t pip on your system then install setuptools first after that run “easy_install pip”. After that you can use pip in your terminal window.

  • Use the stable release (recommended):

    pip install django-onetimelink
  • With pip you can also uninstall:

    pip uninstall django-onetimelink

test your installation

Go to console and type:

python

… then type:

>>> import onetimelink
>>> onetimelink.CKINST()
>>> help(onetimelink)
>>> exit()

Setup

  • Add “onetimelink” to you installed apps in the settings file.

  • Make sure that:

    1. Your Admin is enabled (‘django.contrib.admin’, is in your INSTALLED_APPS).

    2. ‘django.contrib.auth.context_processors.auth’, (also for admin) is in TEMPLATE_CONTEXT_PROCESSORS.

    3. ‘django.core.context_processors.request’, is in TEMPLATE_CONTEXT_PROCESSORS.

  • Add the following to your urls.py:

    1. from django.conf.urls import include, url

    2. from onetimelink import presettings

    3. url(r’%s/’ % presettings.DYNAMIC_LINK_URL_BASE_COMPONENT, include(‘onetimelink.urls’)),

  • Finally run:

    python manage.py makemigrations
    python manage.py migrate
    python manage.py runserver

Make it custom

Use the global settings.py in your projects root to overwrite the applications presettings with the following variables.

DYNAMIC_LINK_MEDIA

  • Default: settings.MEDIA_ROOT

  • A path to a directory. From this point you can walk down the subdirectories to choose your files to serve.

DYNAMIC_LINK_URL_BASE_COMPONENT

  • Default: ‘OneTimeLink’

  • A string that modifies your url serve path.

  • Example: www.example.com/DYNAMIC_LINK_URL_BASE_COMPONENT/link/3839hd8HKl3/example.zip.

DYNAMIC_LINK_UPLOAD_TO

  • Default: ‘’

  • Uploaded files base directory.

DYNAMIC_LINK_SCHEMA_PROTO

  • Default: ‘http’

  • HTTP Schema Protocal.

Usage

Open the admin interface and go to “OneTimeLink” section. The rest should be self-explanatory.

Hints

  • Upload Files to upload the file to DYNAMIC_LINK_MEDIA

  • The filename from the in Upload Files is only for human readability. You can delete or change these filenames in any way you want.

  • Through the action button you can serve a site with all the files from Upload Files.

Changelogs

2021-03-24

  • Add setting for schema protocol

  • Prefix links with FORCE_SCRIPT_NAME

2021-03-25

  • Fix several bugs

  • Do NOT use previous versions of this package

2021-06-08

  • Fix search bug in admin

  • clean up code

  • Do NOT use previous versions of this package

2022-02-04

  • Add setting to override HTTP Host

  • clean up code

  • Fix several bugs

  • Do NOT use previous versions of this package

2022-09-27

  • Add DYNAMIC_LINK_USE_FORCE_SCRIPT_NAME setting

  • Add HTTP Host override setting

  • Fix several bugs

  • clean up code

  • Do NOT use previous versions of this package

2022-10-31

  • Add support for Django 4

  • Remove support for Python 3.6, 3.7 as Django 4 requires min 3.8

  • Do NOT use previous versions of this package

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-onetimelink-3.2.tar.gz (98.0 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