Skip to content

Latest commit

 

History

History
653 lines (441 loc) · 24.9 KB

HISTORY.md

File metadata and controls

653 lines (441 loc) · 24.9 KB
Raw

History

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

6.0.0 - 2024-09-19

Changed

5.1.0 - 2024-04-09

Added

Changed

  • Blocks have been updated to v0.36.0
  • For ImageTransformation:
    • The overlay() and overlay_self() methods now treat overlay_width and overlay_height parameters as optional.
    • Unified gif2video(), gif2video_format(), and gif2video_quality() methods into a single gif2video() method. The format and quality parameters can now be accepted directly in the gif2video() method.
  • Black dev dependency has been updated to 24.3.0.

Fixed

  • Django forms: Any modifications made in an image editor are now correctly restored when editing the same image again. Previously, the editor state was not restored, and the original image was displayed instead. via uploadcare/blocks#615.

Deprecated

  • For ImageTransformation:
    • Deprecated the separate gif2video_format and gif2video_quality methods. Please use the format and quality parameters directly in the gif2video method for setting these properties.

5.0.1 - 2024-03-02

Changed

Fixed

  • The SSL context is now cached by default, resulting in significant performance improvements when initializing the Uploadcare class frequently. #279
  • Removed the warning for the usage of the deprecated pydantic.utils.deep_update #283

5.0.0 - 2023-12-28

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.

4.3.0 - 2023-12-24

Fixed

  • For AkamaiSecureUrlBuilderWithAclToken and AkamaiSecureUrlBuilderWithUrlToken:
    • Special characters that were not previously escaped are now properly handled, as detailed in issue #275.

Changed

  • For AkamaiSecureUrlBuilderWithAclToken and AkamaiSecureUrlBuilderWithUrlToken:
    • Both classes have been made more consistent and now accept a full URL, URL path, or just the UUID of a file – whichever is more convenient for you.

Deprecated

  • For FileGroup:

    • Added a deprecation warning when accessing datetime_stored property, as it has been deprecated in the REST API. This field does not exist in REST API v0.7.x.

  • For GroupsAPI:

    • Added a deprecation warning when calling store method, as it has been deprecated in the REST API. This API endpoint does not exist in REST API v0.7.x.

4.2.2 - 2023-11-20

Added

  • For File:
    • AWS Rekognition Moderation results are now accessible via File.info["appdata"]["aws_rekognition_detect_moderation_labels"].

4.2.1 - 2023-11-17

Fixed

  • For AddonsAPI:
    • In version 4.2.0, passing a Python dictionary as params to the execute method would cause an AttributeError. Now, you can use either an AddonExecutionParams instance or a dict.

4.2.0 - 2023-11-16

Summary of this update:

  1. Added support for the save_in_group parameter in multipage conversion (#258);
  2. Implemented the AWS Rekognition Moderation addon API (#260);
  3. Added signed_uploads setting for Django projects (#262);
  4. Secure URL generation improvements (#263 & #264);
  5. Various bug fixes.

There are no breaking changes in this release.

Added

  • For Uploadcare:

    • Added a type for the event parameter of the create_webhook and update_webhook methods.
    • Added the generate_upload_signature method. This shortcut could be useful for signed uploads from your website's frontend, where the signature needs to be passed outside of your website's Python part (e.g., for the uploading widget).
    • Added generate_secure_url_token method. Similar to generate_secure_url, it returns only a token, not the full URL.
    • Added an optional wildcard parameter to the generate_secure_url method.

  • For File:

    • Added the save_in_group parameter to the convert and convert_document methods. It defaults to False. When set to True, multi-page documents will additionally be saved as a file group.
    • Added the get_converted_document_group method. It returns a FileGroup instance for converted multi-page documents.

  • For DocumentConvertAPI:

  • For AddonsAPI / AddonLabels:

  • For Django integration:

    • Added the signed_uploads setting for Django projects. When enabled, this setting exposes the generated signature to the uploading widget.

  • For AkamaiSecureUrlBuilderWithAclToken:

    • Added get_token method.
    • Added an optional wildcard parameter to the build method.

  • Introduced AkamaiSecureUrlBuilderWithUrlToken class.

Changed

  • AkamaiSecureUrlBuilder has been renamed to AkamaiSecureUrlBuilderWithAclToken. It is still available under the old name and works as before, but it will issue a deprecation warning when used.

Fixed

  • For AddonsAPI / AddonExecutionParams:
    • Fixed an issue where calling execute and status with AddonLabels's attributes (such as AddonLabels.REMOVE_BG) for the addon_name would result in a 404 Not Found error.
    • Fixed ValidationError when constructing AddonClamAVExecutionParams or AddonRemoveBGExecutionParams with omitted optional parameters.

4.1.3 - 2023-10-05

Added

  • For AudioStreamInfo:
    • added profile field.

Changed

  • pyuploadcare now officially supports Python 3.12 (please notice that if you're using Django, that doesn't support Python 3.12 as of yet).

4.1.2 - 2023-09-08

Fixed

  • Incorrect expiration time was calculated for signed uploads causing the AuthenticationError: Expired signature exception.

4.1.1 - 2023-09-04

Fixed

  • Resolved a ValidationError that occurred when requesting file information for specific video files.

4.1.0 - 2023-07-18

Added

  • For Uploadcare and UploadAPI:
    • upload_from_url and upload_from_url_sync can now accept two new optional parameters: check_duplicates and save_duplicates. These correspond to check_URL_duplicates and save_URL_duplicates for /from_url/ upload API endpoint respectively.
  • For FileGroup:
    • The delete method now includes an optional delete_files argument, which indicates whether the files within the specified group should also be deleted.

Changed

  • Bumped httpx dependency for py37+.
  • Bumped yarl dev dependency for py37+.
  • Bumped coverage dev dependency for py37+.
  • Tests are now run against Python 3.11 as well. The minimum supported version of Python remains 3.6.
  • Tests are now run against Django 4.0, 4.1 and 4.2 as well. The minimum supported version of Django remains 1.11.

4.0.0 - 2022-12-26

Now uses REST API v0.7.

Breaking changes

  • For File.info:
    • File information doesn't return image_info and video_info fields anymore, they were moved into field content_info that includes mime-type, image (dimensions, format, etc), video information (duration, format, bitrate, etc), audio information, etc.
    • Removed rekognition_info in favor of appdata.
  • For file_list method of FileList:
    • Removed the option of sorting the file list by file size.
  • For File:
    • Removed method copy in favor of local_copy and remote_copy methods.
    • Files to upload must be opened in a binary mode.

Added

  • For File.info:
    • Field metadata that includes arbitrary metadata associated with a file.
    • Field appdata that includes dictionary of application names and data associated with these applications.
  • Add Uploadcare API interfaces for Uploadcare:
    • MetadataAPI
    • AddonsAPI
  • Added an option to delete a Group.

Fixed

  • Limit for batch operation is set to 100 (doc).
  • Iterating over long collections in batch operation.
  • Akamai signed URL generation.

3.2.0 - 2022-12-19

Changed

  • Freezed httpx dependency for py37+ (=0.23.0) to prevent breaking changes in processing files opened in the text mode.

Fixed

  • Akamai signed URL generation.

3.1.0 - 2022-10-24

Changed

  • Bumped httpx dependency for py37+.
  • Add follow_redirects argument for Client request method.
  • Using allow_redirects argument is allowed, but will cause a deprecating warning.
  • Bumped black dependency.

3.0.1 - 2022-10-06

Changed

  • Bumped pytz dependency.
  • Bumped typing-extensions for py37+.

3.0.0 - 2021-11-01

Added

  • Multipart uploads.
  • Document and video conversions.
  • Authenticated URL generator.
  • Image transformation path builder.
  • Webhook operations.
  • Getting project information.
  • Low-level API.
  • Uploadcare client.

Changed

  • Dropped support for Python 3.5.
  • Dropped support for Python 2.*.
  • Allowed uploading from URL in File.upload method.
  • Resource attributes can be accessed now as properties, not methods.
  • Uploadcare client should be initialized to access API.
  • Moved from Travis to Github Actions.

2.7.0 - 2020-05-03

Added

  • Support for signed uploads.

Changed

  • Dropped support for Python 3.4.
  • Update bundled widget to version 3.6.1. See widget changelog.

Fixed

  • Tests.

2.6.0 - 2018-11-29

Changed

  • Improved error logging.
  • Update bundled widget to version 3.6.1. See widget changelog.

Fixed

  • FileWidget.render() now works in Django 2.1.
  • Obsolete widget setting data-upload-base-url replaced with data-url-base

2.5.0

  • Update bundled widget to version 3.3.0. See widget changelog.
  • Update links to the Uploadcare site
  • Expand data format in 'User-Agent' request header.

2.4.0

  • Change data format in 'User-Agent' request header.

2.3.1

  • Update default widget version to 3.x
  • Update bundled widget to version 3.2.3. See widget changelog.

2.3.0

  • Add support for Django versions 1.11 and ~2.0
  • Miscellaneous updates (version, year in a license file, tox configuration and etc.)
  • Drop official support for obsolete Python and Django versions. Chances are that everything still works. If you have to use those, modify tox.ini, run tests and use at your own risk ;) Or, you may use older versions of the library.

2.2.1

  • Add file.create_local_copy and file.create_remote_copy methods.
  • Add new make_public and pattern parameters to file.create_remote_copy method.
  • Add new store parameter to file.create_local_copy methods.
  • Update CDN link to the widget.
  • Use wildcard 2.x to always get the latest patch or minor version of widget version 2. See widget changelog.
  • Update bundled widget to version 2.10.3. See widget changelog.

2.1.0

  • Support auto storing in upload requests
  • Updated widget to version 2.10.0 (see widget changelog).
  • Drop support for Python 3.2
  • Simplify and reduce test matrix in .travis.yml

2.0.1

  • Fixed issue with missing ucare_cli package.

2.0

  • Added support for version 0.5 of REST API.
  • Updated widget to version 2.8.1 (see widget changelog).
  • Added the ucare list_groups command.
  • Removed deprecated entities.

NB: There are backward incompatible changes. For detailed information about the upgrade process see update to version 2.0.

1.3.6

  • Fixed ZeroDivision error when trying to sync files with no size

1.3.5

  • Added support of Django 1.9
  • Removed indication of Unicode strings from output of ucare
  • Fixed a group representation for ucare create_group command
  • Fixed error with ucare sync when trying to processing of not image files

1.3.4

  • Added storage operations
  • Added request_limit to ucare_cli

1.3.3

  • Expanded User-Agent

1.3.2

  • Added sync command to ucare_cli
  • Autogenerated documentation for ucare_cli
  • update widget to 2.5.5 (see widget changelog)

1.3.1

1.3.0

  • API version was updated up to 0.4.
  • update widget to 2.4.0 (see widget changelog)

1.2.15

1.2.14

1.2.13

  • improve synchronous upload API
  • fix encoding issues with pip3
  • update widget to 1.5.4 (see widget changelog)
  • add AUTHORS.txt

1.2.12

  • add synchronous upload from URL method to File
  • UploadcareExceptions are __repr__'ed properly
  • update widget to 1.5.3 (see widget changelog)

1.2.11

  • fix "source" composition for copy requests
  • let configure default throttle retry count via conf.retry_throttled

1.2.10

  • handle responses for HEAD and OPTION requests
  • update widget to 1.4.6

1.2.9

  • compatibility with Django 1.7

1.2.8

  • update widget to 1.4.0

1.2.7

  • handle rest api throttling

1.2.6

  • update widget to 1.2.3
  • fixed compatibility with six library version 1.7.0 and above

1.2.5

  • fixed setup script

1.2.4

  • update widget to 1.0.1
  • fixed logging when response contains unicode chars

1.2.3

  • update widget to 0.17.1

1.2.2

  • add File.copy()
  • add data attribute to UploadcareException
  • update widget to 0.13.2
  • update pyuploadcare.dj.models.ImageField crop validation

1.2.1

https://ucarecdn.com/ URL was returned to serve widget's assets.

1.2

  • CDN URL has been changed to http://www.ucarecdn.com/. Previous URL https://ucarecdn.com/ is depricated.
  • Widget was updated up to 0.10.1.

1.1

  • Widget was updated up to 0.10.
  • Default API version was updated up to 0.3.
  • Django settings were merged into UPLOADCARE dictionary.
  • Performance was improved by reusing requests' session.

1.0.2

UnicodeDecodeError was fixed. This bug appears when request's method param is unicode and requests.request() got files argument, e.g.:

>>> requests.request(u'post', u'http://httpbin.org/post',
...                  files={u'file': open('README.rst', 'rb')})
UnicodeDecodeError: 'ascii' codec can't decode byte 0xc5 ...

1.0.1

  • Widget was updated up to 0.8.1.2.

  • It was invoking File.store(), FileGroup.store() methods on every model instance saving, e.g.:

    photo.title = 'new title'
photo.save()

    Now it happens while saving by form, namely by calling your_model_form.is_valid(). There is other thing that can trigger storing -- calling photo.full_clean() directly.

1.0

0.19

0.18

  • Widget was updated up to 0.6.9.1.

0.17

  • ImageField was added. It provides uploading only image files. Moreover, you can activate manual crop, e.g. ImageField(manual_crop='2:3').
  • More appropriate exceptions were added.
  • Tests were separated from library and were restructured.
  • Widget was updated up to 0.6.7.
  • Issue of FileField's blank, null attributes was fixed.

0.14

  • Replace accept header for old api version

0.13

  • Fix unicode issue on field render

0.12

  • Add new widget to pyuploadcare.dj
  • Remove old widget
  • Use https for all requests

0.11

  • Add cdn_base to Ucare.__init__
  • Get rid of api v.0.1 support
  • Add File.ensure_on_s3 and File.ensure_on_cdn helpers
  • Add File properties is_on_s3, is_removed, is_stored
  • Fix url construction
  • Add and correct waiting to upload and upload_from_url

0.10

  • Add console log handler to ucare
  • Add wait argument to ucare store and delete commands
  • Fix ucare arg handling

0.9

  • Add bunch of arguments to ucare upload and upload_via_url commands
  • Fix UploadedFile.wait()

0.8

  • Fix file storing for old API
  • Replaced Authentication header with Authorization
  • Log warnings found in HTTP headers
  • Replace old resizer with new CDN
  • Add verify_api_ssl, verify_upload_ssl options
  • Add custom HTTP headers to API and upload API requests

0.7

  • Added __version__
  • Added 'User-Agent' request header
  • Added 'Accept' request header
  • Added ucare config file parsing
  • Added pyuploadcare/tests.py
  • Replaced upload API
  • Replaced File.keep with File.store, File.keep is deprecated
  • File.store uses new PUT request
  • Added timeouts to File.store, File.delete
  • Added upload and upload_from_url to ucare
  • Added tests during setup
  • Replaced httplib with requests, support https (certificates for api requests are verified)
  • Added api_version arg to UploadCare, default is 0.2

0.6

  • Added ucare cli utility
  • Added PYUPLOADCARE_UPLOAD_BASE_URL setting
  • Added PYUPLOADCARE_WIDGET_URL
  • Updated widget assets to version 0.0.1
  • Made properties out of following pyuploadcare.file.File's methods:
    • api_uri()
    • url()
    • filename()
  • Changed pyuploadcare.UploadCareException.__init__