93df8c6939
Add a lot of missing documentation * try codeblock * code * backticks * markdown, not rst * examples * unindent * stub out docs * change theme, add docs for installation * More documentation * remove debug print * flake8
53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
# Django-dbfilestorage
|
|
|
|
|
|
[](https://circleci.com/gh/tyrelsouza/django-dbfilestorage)
|
|
|
|
Custom file storage for Django that stores file data and content type in the database.
|
|
Easy to use for testing when you don't care about a filename, and just want to test file data.
|
|
|
|
Intended to be used in tests, never in production.
|
|
|
|
## INSTALLATION
|
|
|
|
In your project's `settings.py` file, add `'dbfilestorage'` to your `INSTALLED_APPS`:
|
|
|
|
```python
|
|
INSTALLED_APPS = (
|
|
...
|
|
'dbfilestorage'
|
|
)
|
|
```
|
|
|
|
Next, if you want to set this globally, set the setting:
|
|
|
|
```python
|
|
DEFAULT_FILE_STORAGE='dbfilestorage.storage.DBFileStorage'
|
|
```
|
|
|
|
Or you can set it individually on a field: [Django Docs](https://docs.djangoproject.com/en/1.10/ref/models/fields/#django.db.models.FileField.storage)
|
|
|
|
```python
|
|
from dbfilestorage.storage import DBFileStorage
|
|
|
|
class SomeClass(models.Model):
|
|
file = models.FileField(upload_to=u'anywhere',
|
|
storage=DBFileStorage())
|
|
```
|
|
|
|
|
|
## TODO
|
|
|
|
- More Tests
|
|
- Test that this works on a fake model, not just the storage file.
|
|
- Different django and different python versions.
|
|
- Store original filename in a field, maybe?
|
|
- Use original filename instead, so it honors the "upload_to" parameter.
|
|
|
|
|
|
## CHANGELOG
|
|
|
|
- 2016-12-08 [Tyrel Souza] Add more documentation.
|
|
- 2016-12-07 [Tyrel Souza] Update Readme, move to github, gitlab wasn't functioning properly.
|
|
- 2016-12-07 [Tyrel Souza] Initial commits and basic project setup
|