Skip to main content

Django Upload Path

PyPi MIT TravisCI Coverage Supported Python implementations Supported Python versions

Introduction

This application provides various implementations for the FileField/ImageField.upload_to attribute (https://docs.djangoproject.com/en/dev/ref/models/fields/#django.db.models.FileField.upload_to) (upload_to attribute accepts callable).

These implementations are:

  • auto_cleaned_path will generate {MODEL_NAME}/{SAFE_UPLOADED_FILENAME}{SUFFIX}

  • auto_cleaned_path_uuid4 will generate {MODEL_NAME}/{SAFE_UPLOADED_FILENAME}{SEPARATOR}{UUID4}{SUFFIX}

  • auto_cleaned_path_stripped_uuid4 will generate {MODEL_NAME}/{UUID4}{SUFFIX}

Example

For example, how auto_cleaned_path works: First, the original file name (typically from the user) is always cleaned (using django.utils.text.slugify). Then, a new path is generated that contains the model name.

If you have a MyModel model and the user uploads a foo-bar.txt file, the resulting path will be mymodel/foo-bar.txt.

from django.db import models
from django_upload_path import auto_cleaned_path


class MyModel(models.Model):
    file = models.FileField(upload_to=auto_cleaned_path)

Installation

  • Supported Python versions are: 3.4., 3.5, 3.6 and 3.7-dev.

  • Supported Django versions are: 1.8.x (LTS), 1.9.x, 1.10.x and 1.11.x (LTS).

pip install django-upload-path

Do not add the app to INSTALLED_APPS (it is useless).

Usage

from django.db import models
from django_upload_path.upload_path import auto_cleaned_path, auto_cleaned_path_stripped_uuid4, auto_cleaned_path_uuid4


class MyModel(models.Model):
    file1 = models.FileField(upload_to=auto_cleaned_path)
    file2 = models.FileField(upload_to=auto_cleaned_path_stripped_uuid4)
    file3 = models.FileField(upload_to=auto_cleaned_path_uuid4)

Note: ImageField (https://docs.djangoproject.com/en/dev/ref/models/fields/#django.db.models.ImageField) is also supported.

License

The MIT License (MIT)

Copyright (c) 2017 Vašek Dohnal (@illagrenan)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Metadata

Release files for django-upload-path 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-upload-path 0.1.1
File Size Uploaded Provenance
django-upload-path-0.1.1.tar.gz 4.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for django-upload-path 0.1.1
File Interpreter ABI Platform
django_upload_path-0.1.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 11.6 kB

Release files / django-upload-path-0.1.1.tar.gz

Download URL django-upload-path-0.1.1.tar.gz
Size 4.4 kB
Tags Source
SHA-256 checksum
How to use checksums
ec4281f78889ce9295251670931987c9db59de72485b14f3fde64391de76bfd6
BLAKE2b-256 checksum
How to use checksums
54e6ada9d82dfa2a02d7120f153abc240c878fe428dd834d897dddb15b0ee8ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / django_upload_path-0.1.1-py2.py3-none-any.whl

Download URL django_upload_path-0.1.1-py2.py3-none-any.whl
Size 7.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
1ed79e7896e75af2ba37a03f6d921612e58aa8cf4cf20565824ea1084cfc69ca
BLAKE2b-256 checksum
How to use checksums
ff0da8e4ae79900b61a89d724cafb5fef8da2cc35b9303dd7c106717a7844627
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for django-upload-path 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page