Rename module

CHANGELOG.md

@@ -6,5 +6,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/anexia-it/django-attachments/compare/1.0.0...HEAD
-[1.0.0]: https://github.com/anexia-it/django-attachments/releases/tag/1.0.0
+[Unreleased]: https://github.com/anexia-it/drf-attachments/compare/1.0.0...HEAD
+[1.0.0]: https://github.com/anexia-it/drf-attachments/releases/tag/1.0.0

CONTRIBUTING.md

@@ -32,34 +32,4 @@ and patterns in the existing code-base.
 
 ### Contribution guidelines
  - Your code should follow PEP 8 -- Style Guide for Python Code
- - Your changes should be covered by unit-tests
-
-## Setup local tests (venv)
-
-After forking the repository you may create a `venv` to manage all dependencies required for running the tests:
-```
-python -m virtualenv venv
-```
-
-You can than enter the newly created `venv` and install all dependencies required for the tests:
-```
-user@computer: source venv/bin/activate
-(venv) user@computer: pip install -r requirements.txt
-(venv) user@computer: pip install -e .
-```
-
-A quick check via `pip freeze` should list all relevant dependency packages plus the `django-attachments`:
-```
-(venv) user@computer: pip freeze
-Django==2.2.24
-# Editable Git install with no remote (django-attachments==0.0.0)
--e /media/alex/INTENSO/ANX/pycharmWorkspace/django-attachments
-python-magic==0.4.24
-pytz==2021.3
-sqlparse==0.4.2
-```
-
-Now you should be able to successfully run the tests provided in `/tests/`:
-```
-(venv) user@computer: python tests/manage.py test test tests/test/
-```
+ - Your changes should be covered by unit-tests

README.md

@@ -1,21 +1,21 @@
-# Django Attachments
+# DRF Attachments
 
-A django module to manage any model's file up-/downloads by relating an Attachment model to it.
+Django rest framework module to manage any model's file up-/downloads by relating an Attachment model to it.
 
 ## Installation
 
 Install using pip:
 
 ```
-pip install git+https://github.com/anexia-it/django-attachments@main
+pip install git+https://github.com/anexia-it/drf-attachments@main
 ```
 
 Add model_prefix to your INSTALLED_APPS list. Make sure it is the first app in the list
 
 ```
 INSTALLED_APPS = [
     ...
-    'django_attachments',
+    'drf_attachments',
     ...
 ]
 ```
@@ -114,7 +114,7 @@ To manage file uploads for any existing model you must create a one-to-many "att
 
 5. Add attachment DRF route
    ```
-   from django_attachments.rest.views import AttachmentViewSet
+   from drf_attachments.rest.views import AttachmentViewSet
 
    router = get_api_router()
    router.register(r"attachment", AttachmentViewSet)

django_attachments/admin.py → drf_attachments/admin.py

@@ -1,7 +1,7 @@
 from django.contrib import admin
 from django.contrib.contenttypes.admin import GenericTabularInline
 
-from django_attachments.models.models import Attachment
+from drf_attachments.models.models import Attachment
 
 __all__ = [
     "AttachmentInlineAdmin",

django_attachments/apps.py → drf_attachments/apps.py

@@ -20,11 +20,11 @@ def create_global_permissions_for_app(sender, **kwargs):
 
 
 class AttachmentsConfig(AppConfig):
-    name = "django_attachments"
+    name = "drf_attachments"
     verbose_name = _("attachments")
 
     def ready(self):
         post_migrate.connect(create_global_permissions_for_app, sender=self)
 
         # import signal handlers
-        import django_attachments.handlers
+        import drf_attachments.handlers

django_attachments/handlers.py → drf_attachments/handlers.py

@@ -3,7 +3,7 @@
 from django.db.models.signals import post_delete
 from django.dispatch import receiver
 
-from django_attachments.models.models import Attachment
+from drf_attachments.models.models import Attachment
 
 
 @receiver(post_delete, sender=Attachment)

django_attachments/migrations/0001_initial.py → drf_attachments/migrations/0001_initial.py

@@ -3,7 +3,7 @@
 import django.contrib.postgres.fields.jsonb
 from django.db import migrations, models
 import django.db.models.deletion
-import django_attachments.models.models
+import drf_attachments.models.models
 import uuid
 
 
@@ -23,7 +23,7 @@ class Migration(migrations.Migration):
                 ('name', models.CharField(blank=True, max_length=255, verbose_name='name')),
                 ('context', models.CharField(blank=True, help_text="Additional info about the attachment's context/meaning.", max_length=255, verbose_name='context')),
                 ('meta', django.contrib.postgres.fields.jsonb.JSONField(help_text='Additional info about the attachment (e.g. file meta data: mime_type, extension, size).', verbose_name='meta')),
-                ('file', models.FileField(storage=django_attachments.models.models.AttachmentFileStorage(), upload_to=django_attachments.models.models.attachment_upload_path, verbose_name='file')),
+                ('file', models.FileField(storage=drf_attachments.models.models.AttachmentFileStorage(), upload_to=drf_attachments.models.models.attachment_upload_path, verbose_name='file')),
                 ('object_id', models.UUIDField()),
                 ('creation_date', models.DateTimeField(auto_now_add=True, verbose_name='Creation date')),
                 ('last_modification_date', models.DateTimeField(auto_now=True, verbose_name='Last modification date')),

django_attachments/models/managers.py → drf_attachments/models/managers.py

@@ -1,4 +1,4 @@
-from django_attachments.models.querysets import AttachmentQuerySet
+from drf_attachments.models.querysets import AttachmentQuerySet
 from django.db import models
 
 __all__ = [

django_attachments/models/models.py → drf_attachments/models/models.py

@@ -2,8 +2,8 @@
 import uuid
 from uuid import uuid1
 
-from django_attachments.models.managers import AttachmentManager
-from django_attachments.uitls import get_mime_type, get_extension, remove
+from drf_attachments.models.managers import AttachmentManager
+from drf_attachments.uitls import get_mime_type, get_extension, remove
 from django.conf import settings
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
@@ -37,7 +37,7 @@ def attachment_upload_path(attachment, filename):
 
     NOTE: DO NOT CHANGE THIS METHOD NAME (keep migrations sane).
     If you ever have to rename/remove this method, you need to mock it (to simply return None) in every migration
-    that references to django_attachments.models.models.attachment_upload_path
+    that references to drf_attachments.models.models.attachment_upload_path
     :param attachment:
     :param filename:
     :return:

django_attachments/rest/serializers.py → drf_attachments/rest/serializers.py

@@ -9,7 +9,7 @@
     "AttachmentSubSerializer",
 ]
 
-from django_attachments.models.models import Attachment
+from drf_attachments.models.models import Attachment
 
 
 def get_content_object_field():

django_attachments/rest/views.py → drf_attachments/rest/views.py

@@ -1,8 +1,8 @@
 from rest_framework import viewsets
 
-from django_attachments.models.models import Attachment
-from django_attachments.rest.renderers import FileDownloadRenderer
-from django_attachments.rest.serializers import AttachmentSerializer
+from drf_attachments.models.models import Attachment
+from drf_attachments.rest.renderers import FileDownloadRenderer
+from drf_attachments.rest.serializers import AttachmentSerializer
 from django_filters.rest_framework import DjangoFilterBackend
 from django.http import FileResponse
 from rest_framework.decorators import action, parser_classes

setup.py

@@ -9,15 +9,15 @@
 os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
 
 setup(
-    name='django-attachments',
+    name='drf-attachments',
     version=os.getenv('PACKAGE_VERSION', '0.0.0').replace('refs/tags/', ''),
     packages=find_packages(),
     include_package_data=True,
     license='MIT License',
     description='A django module to manage any model\'s file up-/downloads by relating an Attachment model to it.',
     long_description=README,
     long_description_content_type='text/markdown',
-    url='https://github.com/anexia-it/django-attachments',
+    url='https://github.com/anexia-it/drf-attachments',
     author='Alexandra Bruckner',
     author_email='[email protected]',
     install_requires=[

tests/settings.py

@@ -1,6 +1,6 @@
 """
-Django settings for "tests" project which assures the functionality of the "django-attachments" package
-(https://github.com/anexia-it/django-attachments).
+Django settings for "tests" project which assures the functionality of the "drf-attachments" package
+(https://github.com/anexia-it/drf-attachments).
 """
 
 import os
@@ -30,9 +30,7 @@
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
-
-    # include django-attachments
-    'django_attachments',
+    'drf_attachments',
 ]
 
 MIDDLEWARE = [