Publish initial package code (#1)

Author: codingjoe

.bandit

@@ -0,0 +1,2 @@
+[bandit]
+exclude: tests

.checks.yml

@@ -0,0 +1,3 @@
+- bandit
+- flake8
+- pydocstyle

.travis.yml

@@ -0,0 +1,22 @@
+language: python
+sudo: required
+dist: xenial
+python: 3.7
+cache: pip
+env:
+  matrix:
+  - TOXENV=django-slugify
+  - TOXENV=unicode-slugify
+install: pip install -U pip tox codecov
+script: tox -e $TOXENV
+after_success: codecov
+deploy:
+  provider: pypi
+  user: codingjoe
+  password:
+    secure: dfstvb+TXu32T3rAaHITddoMmYYfNWGVVyfyNyjq8vHigawJKieUNHmy9UKqP5Wb8gHaw8O/zpqodYVAt+8JvYfxALEGJBOSOE3E8KPqNZBgQbwutC7vvna+Sz+f/H4OGLWY+YWm54rujB2J/eSqlG4NV/6fePebMy0wq+mGqYWYfrH4KMTwG3oYZfmEDZcMD55lFSKxryHzlq3C5eibtq+iLTolKE+r1QlazMw07TADsboFDigAHmDPRuZJvhfzfkY+3V3rkoiaHXtpN8m386nokqpMSfeEO5BXjod80yRvvtNWGH1x2N19mWf3YZAhBovGqkZR0ezVc9ho60z9+aTUGLcVhbRWqsUob8nQ0KqsepeldLAaopDb/TgCEJmOMjBCD0NH+Q/d1UVtFi/MUguxKyC+Kbi1/3qx/8ArELw74rTJURDHIRqIUB0wX3pzIu24U2pV0uII1DECn5dfVE2RZwbqnt/+JVIUA8pWoAd8VWilCGHm0NfHhMfplPwbSYhbWyCgCnwzAfScvZQOtzquEX+kbXB7BK89kFIICOueh1IASxn2WTxEj+8QNNhe1PnznGmA+bOKtEmEkhE65n606Q9WSwKGiyLLDgrqC3tGxeQmEHYaIds3Ali3ayRbMlSwlSH90NrXmh1zoK8TLHGSO01fAm4SBfHnQDEJSwM=
+  on:
+    tags: true
+    distributions: sdist bdist_wheel
+    repo: codingjoe/django-dynamic-filenames
+    branch: master

README.md

@@ -0,0 +1,79 @@
+========================
+Django Dynamic Filenames
+========================
+
+Write advanced filename patterns using the `Format Specification Mini-Language`__.
+
+__ https://docs.python.org/3/library/string.html#format-string-syntax
+
+Getting Started
+---------------
+
+Installation
+~~~~~~~~~~~~
+
+.. code-block:: bash
+
+    pip install django-dynamic-filenames
+
+Samples
+~~~~~~~
+
+Basic example:
+
+.. code-block:: python
+
+    from django.db import models
+    from dynamic_names import FilePattern
+
+    upload_to_pattern = FilePattern('{app_name:.25}/{model_name:.30}/{uuid_base32}{ext}')
+
+    class FileModel(models.Model):
+        my_file = models.FileField(upload_to=upload_to_pattern)
+
+
+Auto slug example:
+
+.. code-block:: python
+
+    from django.db import models
+    from dynamic_names import FilePattern
+
+    class SlugPattern(FilePattern):
+        filename_pattern = '{app_name:.25}/{model_name:.30}/{slug}{ext}'
+
+    class FileModel(models.Model):
+        title = models.CharField(max_length=100)
+        my_file = models.FileField(upload_to=SlugPattern(populate_slug_from='title'))
+
+Supported Attributes
+--------------------
+
+``ext``
+    File extension including the dot.
+
+``name``
+    Filename excluding the folders.
+
+``model_name``
+    Name of the Django model.
+
+``app_label``
+    App label of the Django model.
+
+``uuid_base16``
+    Base16 (hex) representation of a UUID.
+
+``uuid_base32``
+    Base32 representation of a UUID.
+
+``uuid_base64``
+    Base64 representation of a UUID. Not supported by all file systems.
+
+``slug``
+    Auto created slug based on another field on the model instance.
+
+``slug_from``
+    Name of the field the slug should be populated from.
+
+    .. note:: The field name itself is not part of the pattern.

README.rst

@@ -0,0 +1,131 @@
+import base64
+import os
+import uuid
+
+try:  # use unicode-slugify library if installed
+    from slugify import slugify
+
+    SLUGIFY_KWARGS = dict(only_ascii=True)
+except ImportError:
+    from django.utils.text import slugify
+
+    SLUGIFY_KWARGS = dict(allow_unicode=False)
+
+
+class FilePattern:
+    """
+    Write advanced filename patterns using the Format Specification Mini-Language.
+
+    Basic example:
+
+    .. code-block:: python
+
+        from django.db import models
+        from dynamic_names import FilePattern
+
+        upload_to_pattern = FilePattern('{app_name:.25}/{model_name:.30}/{uuid_base32}{ext}')
+
+        class FileModel(models.Model):
+            my_file = models.FileField(upload_to=upload_to_pattern)
+
+    Args:
+
+        ext: File extension including the dot.
+        name: Filename excluding the folders.
+        model_name: Name of the Django model.
+        app_label: App label of the Django model.
+        uuid_base16: Base16 (hex) representation of a UUID.
+        uuid_base32: Base32 representation of a UUID.
+        uuid_base64: Base64 representation of a UUID. Not supported by all file systems.
+        slug: Auto created slug based on another field on the model instance.
+        slug_from: Name of the field the slug should be populated from.
+
+
+    Auto slug example:
+
+    .. code-block:: python
+
+        from django.db import models
+        from dynamic_names import FilePattern
+
+        class SlugPattern(FilePattern):
+            filename_pattern = '{app_name:.25}/{model_name:.30}/{slug}{ext}'
+
+        class FileModel(models.Model):
+            title = models.CharField(max_length=100)
+            my_file = models.FileField(upload_to=SlugPattern(slug_from='title'))
+
+    """
+
+    slug_from = None
+
+    filename_pattern = '{name}{ext}'
+
+    def __call__(self, instance, filename):
+        """Return filename based for given instance and filename."""
+        # UUID needs to be set on call, not per instance to avoid state leakage.
+        guid = self.get_uuid()
+        path, ext = os.path.splitext(filename)
+        path, name = os.path.split(path)
+        defaults = {
+            'ext': ext,
+            'name': name,
+            'model_name': instance._meta.model_name,
+            'app_label': instance._meta.app_label,
+            'uuid_base10': self.uuid_2_base10(guid),
+            'uuid_base16': self.uuid_2_base16(guid),
+            'uuid_base32': self.uuid_2_base32(guid),
+            'uuid_base64': self.uuid_2_base64(guid),
+        }
+        defaults.update(self.override_values)
+        if self.slug_from is not None:
+            field_value = getattr(instance, self.slug_from)
+            defaults['slug'] = slugify(field_value, **SLUGIFY_KWARGS)
+        return self.filename_pattern.format(**defaults)
+
+    def __init__(self, **kwargs):
+        self.kwargs = kwargs
+        override_values = kwargs.copy()
+        self.slug_from = override_values.pop('slug_from', self.slug_from)
+        self.filename_pattern = override_values.pop('filename_pattern', self.filename_pattern)
+        self.override_values = override_values
+
+    def deconstruct(self):
+        """Destruct callable to support Django migrations."""
+        path = "%s.%s" % (self.__class__.__module__, self.__class__.__name__)
+        return path, [], self.kwargs
+
+    @staticmethod
+    def get_uuid():
+        """Return UUID version 4."""
+        return uuid.uuid4()
+
+    @staticmethod
+    def uuid_2_base10(uuid):
+        """Return 39 digits long integer UUID as Base10."""
+        return uuid.int
+
+    @staticmethod
+    def uuid_2_base16(uuid):
+        """Return 32 char long UUID as Base16 (hex)."""
+        return uuid.hex
+
+    @staticmethod
+    def uuid_2_base32(uuid):
+        """Return 27 char long UUIDv4 as Base32."""
+        return base64.b32encode(
+            uuid.bytes
+        ).decode('utf-8').rstrip('=\n')
+
+    @staticmethod
+    def uuid_2_base64(uuid):
+        """
+        Return 23 char long UUIDv4 as Base64.
+
+        .. warning:: Not all file systems support Base64 file names.
+            e.g. The Apple File System (APFS) is case insensitive by default.
+
+        """
+        return base64.urlsafe_b64encode(
+            uuid.bytes
+        ).decode('utf-8').rstrip('=\n')

dynamic_filenames.py

@@ -0,0 +1,4 @@
+-e .
+coverage
+pytest
+pytest-django

requirements-dev.txt

@@ -0,0 +1 @@
+Django>=1.11

requirements.txt

@@ -0,0 +1,45 @@
+[metadata]
+name = django-dynamic-filenames
+author = Johannes Hoppe
+author-email = info@johanneshoppe.com
+summary = Write advanced filename patterns using the Format Specification Mini-Language.
+description-file = README.rst
+home-page = https://github.com/codingjoe/django-dynamic-filenames
+license = MIT License
+classifier =
+    Development Status :: 5 - Production/Stable
+    Environment :: Web Environment
+    Intended Audience :: Developers
+    License :: OSI Approved :: MIT License±
+    Operating System :: OS Independent
+    Programming Language :: Python
+    Programming Language :: Python :: 3
+    Framework :: Django
+
+[pbr]
+skip_authors = true
+skip_changelog = true
+
+[tool:pytest]
+norecursedirs = env docs .eggs
+addopts = --tb=short -rxs
+DJANGO_SETTINGS_MODULE=tests.testapp.settings
+
+[flake8]
+max-line-length = 99
+max-complexity = 10
+statistics = true
+show-source = true
+
+[pydocstyle]
+add-ignore = D1
+match-dir = (?!tests|env|docs|\.).*
+
+[isort]
+atomic = true
+multi_line_output = 5
+line_length = 79
+skip = manage.py,docs,.tox,env
+known_first_party = dynamic_filenames, tests
+known_third_party = django, slugify
+combine_as_imports = true

setup.cfg

@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+
+from setuptools import setup
+
+setup(
+    setup_requires=['pbr'],
+    py_modules=['dynamic_filenames'],
+    pbr=True,
+)