Skip to content

Version 5.0.0
Compare
Choose a tag to compare
@evgkirov evgkirov released this 28 Dec 13:42
· 44 commits to main since this release
v5.0.0
824c1b6
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

In version 5.0, we introduce a new file uploader, which is now the default for Django projects. If you prefer to continue using the old jQuery-based widget, you can enable it by setting the use_legacy_widget option in your configuration:

UPLOADCARE = {
    ...,
    "use_legacy_widget": True,
    "legacy_widget": {
        "version": "3.x",
    }
}

Additionally, please take note that some settings have been renamed in this update (see the next section).

Breaking Changes

  • Python 3.6 and 3.7 are no longer supported.

  • Django 1.11, 2.0, and 2.1 are no longer supported.

  • Pydantic has been updated to Version 2. Projects dependent on Pydantic Version 1 may encounter errors due to incompatibility between Versions 1 and 2.

  • Removed tox.ini. The recommended method for running tests locally is now through act with Docker.

  • for Django settings (UPLOADCARE = {...}):

    • widget_* settings were renamed and moved:
      • UPLOADCARE["widget_version"] to UPLOADCARE["legacy_widget"]["version"]
      • UPLOADCARE["widget_build"] to UPLOADCARE["legacy_widget"]["build"]
      • UPLOADCARE["widget_variant"] to UPLOADCARE["legacy_widget"]["build"] (this is not a typo: former widget_build and widget_variant settings were equialent)
      • UPLOADCARE["widget_url"] to UPLOADCARE["legacy_widget"]["override_js_url"] and works regardless of use_hosted_assets value.

  • for pyuploadcare.dj.conf:

    • Individual variables were moved into one dict called config. If you've accessed these settings from pyuploadcare.dj.conf module in your code, please migrate:
      • pub_key to config["pub_key"]
      • secret to config["secret"]
      • cdn_base to config["cdn_base"]
      • upload_base_url to config["upload_base_url"]
      • use_hosted_assets to config["use_hosted_assets"]
      • widget_version to config["legacy_widget"]["version"]
      • widget_build to config["legacy_widget"]["build"]
      • uploadcare_js to get_legacy_widget_js_url()
    • Gone from pyuploadcare.dj.conf:
      • widget_filename
      • hosted_url
      • local_url

  • for pyuploadcare.dj.forms:

    • FileWidget renamed to LegacyFileWidget. FileWidget is an all-new implementation now.
    • By default, FileWidget is used. To use LegacyFileWidget, please set UPLOADCARE["use_legacy_widget"] to True

Added

  • Added Python 3.12 and Django 5.0 to the test matrix.

Changed

  • Updated dependencies: httpx, pydantic, pytz, typing-extensions.
  • Updated development dependencies: mypy, pytest, black, isort, flake8, flake8-print, vcrpy, yarl, coverage, pytest-cov, sphinx, sphinx-argparse, types-*. Replaced pytest-freezegun with pytest-freezer.
Assets 2