Release history and notes¶
Sequence based identifiers are used for versioning (schema follows below):
major.minor[.revision]
It’s always safe to upgrade within the same minor version (for example, from 0.3 to 0.3.4).
Minor version changes might be backwards incompatible. Read the release notes carefully before upgrading (for example, when upgrading from 0.3.4 to 0.4).
All backwards incompatible changes are mentioned in this document.
0.8¶
2022-12-16
Note, that this release introduces breaking changes!
All file system based operations are moved to a separate abstraction layer of file storages. The following storages have been implemented: FileSystemStorage, PathyFileSystemStorage, AWSS3Storage, GoogleCloudStorage and AzureStorage. The root_path and rel_path params of the providers are deprecated in favour of storages. See the docs more usage examples.
0.7¶
2022-12-12
Added
RandomFileFromDirProvider
which picks a random file from directory given.Improved docs.
0.6¶
2022-12-11
Pass optional
generator
argument to inner functions of theZipFileProvider
.Added
create_inner_zip_file
inner function which allows to create nested ZIPs.Reached test coverage of 100%.
0.5¶
2022-12-10
Note, that this release introduces breaking changes!
Added ODS file support.
Switched to
tablib
for easy, non-variant support of various formats (XLSX, ODS).Silence
imgkit
logging output.ZipFileProvider allows to pass arbitrary arguments to inner functions. Put all your inner function arguments into a dictionary and pass it in create_inner_file_args key inside options argument. See the example below.
zip_file = ZipFileProvider(None).file( prefix="zzz_archive_", options={ "count": 5, "create_inner_file_func": create_inner_docx_file, "create_inner_file_args": { "prefix": "zzz_file_", "max_nb_chars": 1_024, "content": "{{date}}\r\n{{text}}\r\n{{name}}", }, "directory": "zzz", } )
0.4¶
2022-12-09
Note, that this release introduces breaking changes!
Remove the concept of content generators (and the correspondent
content_generator
arguments in implemented providers). Instead, allow usage of dynamic fixtures in the providedcontent
argument.Remove temporary files when creating ZIP archives.
Various improvements and fixes in docs.
0.3¶
2022-12-08
Add support for BIN, CSV and XLSX files.
Better visual representation of generated images and PDFs.
0.2¶
2022-12-07
Added support for ICO, JPEG, PNG, SVG and WEBP files.
Documentation improvements.
0.1¶
2022-12-06
Initial beta release.