Metadata-Version: 2.1
Name: sweelol
Version: 1.2.1
Summary: Simple project to copy media files (intended for fixtures loads), pretty much as Django staticfiles does
Home-page: https://github.com/pojoba02/django-media-fixtures.git
Author: Francis I AM
Author-email: pojoba01@gmail.com
License: MIT
Keywords: django collectmedia mediafiles mediafixtures fixtures media
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.5
Requires-Dist: Django (>=1.8)
Provides-Extra: dev
Requires-Dist: check-manifest ; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage ; extra == 'test'

|badge1| |badge2| |badge3| |badge4| |badge5|

.. |badge1| image:: https://travis-ci.org/adrianoveiga/django-media-fixtures.svg?branch=master
    :target: https://travis-ci.org/adrianoveiga/django-media-fixtures
    :alt: Build Status

.. |badge2| image:: https://coveralls.io/repos/github/adrianoveiga/django-media-fixtures/badge.svg?branch=master
    :target: https://coveralls.io/github/adrianoveiga/django-media-fixtures?branch=master
    :alt: Coverage

.. |badge3| image:: https://img.shields.io/pypi/v/django-media-fixtures.svg
    :target: https://pypi.org/project/django-media-fixtures/
    :alt: PyPI Version

.. |badge4| image:: https://img.shields.io/pypi/pyversions/django-media-fixtures.svg
    :target: https://pypi.org/project/django-media-fixtures/
    :alt: Python Versions

.. |badge5| image:: https://img.shields.io/pypi/l/django-media-fixtures.svg
    :target: https://pypi.org/project/django-media-fixtures/
    :alt: License

sweelol
---------------------

Simple project to copy media files (intended for fixtures loads) to the file storage, pretty much as the `django.contrib.staticfiles` app does.


Dependencies
------------

- Python 3.5+
- Django 1.8+

**Note**: The version (v1.x.x) dropped support of Python2! If you still need Python2, please check the last version of `v0.1.x series <https://github.com/pojoba02/django-media-fixtures/tree/version/0.1.x>`_


Installation
------------

.. code-block:: python

   pip install sweelol==1.2.1

Then, add the ``django_media_fixtures`` app in your ``settings.INSTALLED_APPS``:

.. code-block:: python

    INSTALLED_APPS = [
        ...,
        'django.contrib.staticfiles',
        'sweelol',
        ...
    ]


Usage
-----

The app provides a management command ``collectmedia``:

.. code-block:: python

    python manage.py collectmedia

This works similarly to ``collectstatic``: finds the ``media_fixtures`` subdirectory in the apps directories, and copies those files to the ``settings.MEDIA_ROOT``.

So, when you create your fixture (by any means, even through shell), put your file path matching the same tree folder layout as it should be in the ``MEDIA_ROOT`` destination.

For instance:

.. code-block:: python

    YourModel.objects.get_or_create(image="uploads/yourmodel/img/example.jpeg")

Where the file ``example.jpeg`` is found in ``yourappfolder/media_fixtures/uploads/yourmodel/img/example.jpeg``. The ``collectmedia`` management command will copy this file to ``uploads/yourmodel/img/example.jpeg`` inside the ``settings.MEDIA_ROOT`` directory.


Configurations
--------------

- MEDIA_FIXTURE_FOLDERNAME
    You can change the media fixtures folder's name on your apps, just putting this variable on settings.py.

    .. code-block:: python

        MEDIA_FIXTURE_FOLDERNAME='my_media_fixtures_folder'

- MEDIA_FIXTURES_FILES_FINDERS
    You can change the media fixtures finders, to search media files on other folders not in-app, for instance.

    .. code-block:: python

        MEDIA_FIXTURES_FILES_FINDERS = (
                'django_media_fixtures.finders.FileSystemFinder',      # combined with MEDIA_FIXTURES_FILES_DIRS, choose specific folders
                'django_media_fixtures.finders.AppDirectoriesFinder',  # default (if you do not set MEDIA_FIXTURES_FILES_FINDERS)
        )

- MEDIA_FIXTURES_FILES_DIRS
    You can list specific media folders that you want to include on search.

    .. code-block:: python

        MEDIA_FIXTURES_FILES_DIRS = [
            "/home/user/myproject/mediafiles",
            "/opt/webfiles/common/",
        ]


