forked from Vostopia/django-inmemorystorage
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Convert from ReST to Markdown. * Add explicit content type for Markdown description. * Stop jamming the entire LICENSE file in the `license` field and instead use `BSD`.
- Loading branch information
1 parent
c51472c
commit 013f03c
Showing
5 changed files
with
71 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
include README.rst LICENSE tests.py | ||
include README.md LICENSE tests.py |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# dj-inmemorystorage | ||
|
||
[![image](https://travis-ci.org/waveaccounting/dj-inmemorystorage.png?branch=master)](https://travis-ci.org/waveaccounting/dj-inmemorystorage) | ||
|
||
An in-memory data storage backend for Django. | ||
|
||
Compatible with Django's [storage | ||
API](https://docs.djangoproject.com/en/dev/ref/files/storage/). | ||
|
||
# Supported Versions | ||
|
||
- Python 2.7 with Django 1.11 | ||
- Python 3.5/3.6/3.7 with Django 1.11+ | ||
- Python 3.8 with Django 2.2+ | ||
|
||
In general, we follow [Python's supported | ||
versions](https://devguide.python.org/#status-of-python-branches) and | ||
[Django's supported | ||
versions](https://docs.djangoproject.com/en/dev/faq/install/#what-python-version-can-i-use-with-django). | ||
Any major change in version support will be released as a new major | ||
version. | ||
|
||
# Usage | ||
|
||
In your test settings file, add | ||
|
||
``` python | ||
DEFAULT_FILE_STORAGE = 'inmemorystorage.InMemoryStorage' | ||
``` | ||
|
||
By default, the `InMemoryStorage` backend is non-persistant, meaning | ||
that writes to it from one section of your code will not be present when | ||
reading from another section of your code, unless both are sharing the | ||
same instance of the storage backend. | ||
|
||
If you need your storage to persist, you can add the following to your | ||
settings. | ||
|
||
``` python | ||
INMEMORYSTORAGE_PERSIST = True | ||
``` | ||
|
||
# Differences | ||
|
||
This library is based on | ||
[django-inmemorystorage](https://github.com/codysoyland/django-inmemorystorage) | ||
by Cody Soyland, with | ||
[modifications](https://github.com/SeanHayes/django-inmemorystorage) | ||
made by Seán Hayes with support for the `url` method, with [additional | ||
support](https://github.com/Vostopia/django-inmemorystorage) from Tore | ||
Birkeland for writing to the file. | ||
|
||
Wave's modifications include packaging, and test modifications such that | ||
`python setup.py test` works. This version also bumps the version to | ||
`1.0.0` and renames it to dj-inmemorystorage such that it doesn't | ||
conflict on PyPI. | ||
|
||
The biggest difference is that this package works with Django 1.4 now | ||
(previously only 1.5+). It also supports Python 2.6/2.7 with Django | ||
1.4+, Python 3.2/3.3/3.4 with Django 1.5+ and Python 3.5/3.6 with Django | ||
1.7+. | ||
|
||
# Contributing | ||
|
||
1. Ensure that you open a pull request | ||
2. All feature additions/bug fixes MUST include tests |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,8 +11,9 @@ | |
description="A non-persistent in-memory data storage backend for Django.", | ||
version="2.0.0", | ||
url="https://github.com/waveaccounting/dj-inmemorystorage", | ||
license=open('LICENSE').read(), | ||
long_description=open('README.rst').read(), | ||
license='BSD', | ||
long_description=open('README.md').read(), | ||
long_description_content_type='text/markdown', | ||
author='Cody Soyland, Seán Hayes, Tore Birkeland, Nick Presta', | ||
author_email='[email protected]', | ||
packages=[ | ||
|