Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A Dropbox Storage for your Django apps

Project description

django-dropbox-storage

A Dropbox Storage for your Django apps

What

django-dropbox-storage allows Django apps to use Dropbox as a storage backend for file uploading.

Installing

First things first:

$ pip install django-dropbox-storage

Then open the settings.py of your project and include it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'django_dropbox_storage',
    ...
)

If you want to use django_dropbox_storage as default storage for all file uploads, you need to adjust DEFAULT_FILE_STORAGE too:

DEFAULT_FILE_STORAGE = 'django_dropbox_storage.storage.DropboxStorage'

If you just want to use it on a single model field, you can simply import it:

from django_dropbox_storage.storage import DropboxStorage

DROPBOX_STORAGE = DropboxStorage()

photo = models.ImageField(upload_to='photos', storage=DROPBOX_STORAGE ...)

In order to let it work properly, you must set the next settings:

DROPBOX_ACCESS_TOKEN = 'xxx'

If you don't have DROPBOX_ACCESS_TOKEN you can create one after creating a Dropbox app at Dropbox for Developers. If you have your Dropbox App key and App secret, you can set DROPBOX_CONSUMER_KEY and DROPBOX_CONSUMER_SECRET settings in settings.py, then run:

$ python manage.py get_dropbox_token [--settings=test_settings]

And follow up on screen instructions, finally set the DROPBOX_ACCESS_TOKEN_SECRET in your settings.py module.

You can also set default root folder setting the value of DROPBOX_ROOT_FOLDER:

DROPBOX_ROOT_FOLDER = '/Public'

By default it's set to '/' (root folder).

Tests

Tests are written following Django's best practices.

In order to run them, you need to set DROPBOX_ACCESS_TOKEN properly.

NOTE: if you're testing this package as stand-alone, you can set the access token in a local_settings.py module put in the root folder.

To launch the test suite:

$ python manage.py test [--settings=test_settings]

To check the unit tests coverage you can:

$ pip install coverage
$ coverage run manage.py test [--settings=test_settings]
$ coverage report -m

Contributing

When contributing, please follow these steps:

  • Clone the repo and make your changes.
  • Make sure your code has test cases written against it.
  • Make sure all the tests pass.
  • Lint your code with Flake8.
  • Add your name to the list of contributers.
  • Submit a Pull Request.

Authors

  • Emanuele Bertoldi

This project is based on previous work by:

Kudos and many thanks to all of them!

License

Copyright (c) 2018 Emanuele Bertoldi

MIT License

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-dropbox-storage-fork, version 0.4.1
Filename, size File type Python version Upload date Hashes
Filename, size django_dropbox_storage_fork-0.4.1-py3-none-any.whl (9.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size django-dropbox-storage-fork-0.4.1.tar.gz (6.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page