Skip to content

Commit

Permalink
Merge pull request #86 from ImperialCollegeLondon/release/0.5.0
Browse files Browse the repository at this point in the history
Documentation and config updates for v0.5.0
  • Loading branch information
jcohen02 authored Dec 5, 2022
2 parents 202c65b + 32552e4 commit b2e0c89
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,18 @@

django-drf-filepond supports remote storage of uploads via [*django-storages*](https://django-storages.readthedocs.io/)

:new: Support for large file uploads (> ~2GB) now available from version 0.4.0 (see [#57](https://github.com/ImperialCollegeLondon/django-drf-filepond/issues/57)).<br/>
:new: Support for filepond chunked uploads now available from version 0.3.0.
:new: Release v0.5.0 is now available including Python 3.10 support, memory
efficiency improvements when working with large files, bug fixes and updates to
the testing infrastructure along with improved test coverage.

:warning: Release v0.5.0 deprecates Python 2.7 and Python 3.5 support. This
will be the last release to support Python 2.7 and Python 3.5. Both these
versions of Python have now been "end-of-life" since 2020.

:warning: **Release v0.4.0 includes a database update** in relation to the large upload support. If you don't wish to apply DB migrations within your application at this stage, please continue to use django-drf-filepond [v0.3.1](https://pypi.org/project/django-drf-filepond/0.3.1/). :warning:

See the [Release Notes](#Release-notes) section for further release
information.

Further documentation and a tutorial are available at [https://django-drf-filepond.readthedocs.io](https://django-drf-filepond.readthedocs.io).

Expand Down Expand Up @@ -347,6 +353,37 @@ You can add more than one permission for each endpoint.

The above list includes all the permission names currently defined on django-drf-filepond views. The naming convention used is `<METHOD_NAME>_<ENDPOINT_NAME>` where `<METHOD_NAME>` is the method name used for a request and `<ENDPOINT_NAME>` is the URL endpoint called. So, for example, a `POST` request to `/fp/process` would be handled by the permission classes defined for `POST_PROCESS`.

### Release notes

##### v0.5.0

django-drf-filepond v0.5.0 includes additional functionality and bug fixes:

- Add Python 3.10 support
- Memory efficiency improvements when handling large files. Previously, the
way chunked uploads were handled meant that twice as much memory as the size
of an upload was being used. This has been resolved with an extensive
redesign of the chunked upload handler.
- Testing of the code has been switched to use Pytest with Tox.
- Test coverage has been significantly improved.

:warning: _Please note:_ v0.5.0 deprecates Python 2.7 and Python 3.5 support.
This will be the last release to support Python 2.7 and Python 3.5. Both these
versions of Python have now been "end-of-life" since 2020. :warning:

See full details of the particular changes merged in the [v0.5.0 release notes on GitHub](https://github.com/ImperialCollegeLondon/django-drf-filepond/releases/tag/v0.5.0).

##### v0.4.0

- Adds support for large file uploads (> ~2GB) (see [#57](https://github.com/ImperialCollegeLondon/django-drf-filepond/issues/57)).

:warning: **Release v0.4.0 includes a database update** in relation to the large upload support. If you don't wish to apply DB migrations within your application at this stage, please continue to use django-drf-filepond [v0.3.1](https://pypi.org/project/django-drf-filepond/0.3.1/). :warning:

##### v0.3.0

- Adds support for filepond chunked uploads.


### License

This repository is licensed under a BSD 3-Clause license. Please see the [LICENSE](LICENSE) file in the root of the repository.
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Topic :: Software Development :: Libraries :: Python Modules",
]
)

0 comments on commit b2e0c89

Please sign in to comment.