faker-file

2024-09-12

• Upgrade requirements.
• Upgrade precommit.
• Update secrets.
• Storage optimisations.

• Minor documentation fixes.

• Make text_extractor_cls and text_augmenter_cls arguments of the
  AugmentFileFromDirProvider provider access string values (to load
  requested class from path given).
• Add TextaugmentAugmenter based on textaugment_ package (very
  lightweight) and make it a default text augmenter.
• Minor documentation fixes.
• Optimized GitHub CI.

• Improvements and fixes in the documentation.
• Announcing feature plans to change default PDF and Image generators
  to Pillow based ones, instead of wkhtmltopdf in version 0.18.

    This release is dedicated to the victims of the war in Artsakh
    (Nagorno-Karabakh), a land now lost to its native inhabitants (Armenians).
    Following a grueling nine-month blockade, Azerbaijan initiated another
    military onslaught on September 19, 2023. The already weakened and
    outnumbered forces of Artsakh could no longer mount an effective
    resistance.

• Added support for DynamicTemplate to all non-graphic image providers.
  That means, that you can produce images with text, tables, various
  headings and other images. Correspondent snippets are implemented for all
  supported image generators; namely reportlab, WeasyPrint and
  Pillow_.

• Added GTTS_MP3_GENERATOR and EDGE_TTS_MP3_GENERATOR to
  the mp3_file provider import options.

• Added add_paragraph, add_picture, add_heading_h1 and other
  heading helpers to pil_snippets contrib module.

    This release might introduces minor backwards incompatible changes only
    if you have written own- or customized existing- image providers and used
    them in combination with `WeasyPrint`_-based image generator. A new
    property named ``image_format`` has been added to all image-based
    providers and the ``WeasyPrintImageGenerator`` is using that instead
    of formerly used ``extension`` property.

• Added PilImageGenerator (for text-to-image).
• Added PilPdfGenerator (for text-to-image).

    Release is dedicated to the victims and de-facto hostages of
    the `Blockade of the Republic of Artsakh`_. Have you ever heard
    of `Armenian genocide`_? It's happening again. For more than 8 months,
    Azerbaijan has launched an illegal blockade of the Republic of Artsakh,
    including critical civilian infrastructure such as gas, electricity and
    roads connecting Armenia and Artaskh. Shortages of essential goods –
    including electricity, fuel, and water reserves – are widespread and
    emergency reserves are being rationed. The blockade has resulted in
    significant medical and food shortages in Artsakh, leading to increased
    health complications, as reported by Artsakh Healthcare ministry.

     - Deaths due to cardiovascular diseases doubled in the first seven
       months of the year, with a particular surge in July-August.
     - Deaths from malignant tumors rose by 15.9% over the same period due
       to lack of medications and medical aid.
     - New cases of stroke and heart attacks increased by 26% and 9.7%
       respectively.
     - Newly diagnosed cases of malignant tumors rose by 24.3%.
     - Around 90% of monitored pregnant women developed anemia from poor
       nutrition and medication shortages.
     - While overall abortion numbers remained stable, medically indicated
       abortions quadrupled in July due to factors like stress and
       inadequate nutrition.
     - Reports of fainting surged by 91% in July-August.
     - Emergency calls for high blood pressure saw a 5.6-fold increase in
       July-August.

    The dire health outcomes are attributed to the blockade's impact,
    including medication shortages, stress, disrupted medical procedures,
    and restricted healthcare access. The Artsakh Health Ministry warns of
    further deterioration if the blockade continues, emphasizing the systemic
    challenges in healthcare delivery due to the blockade.

• Added AugmentRandomImageFromDirProvider
  and AugmentImageFromPathProvider providers for basic image augmentation.
• Added storage to metadata for all providers for easy clean-up of files.
• Added unlink method to all storages for easy clean-up of files.
• Added FileRegistry to keep track of all files created and introduce
  functionality for cleaning up the files.
• Stop testing against Python 3.7.

    In memory of Sinead O'Connor.

• Allow to pass image argument (bytes) to the contrib add_picture functions.
• Documentation improvements.

• Added JSON file provider.

• Added WeasyPrintImageGenerator image generator class based
  on WeasyPrint and pdf2image packages.
• Added BMP, TIFF and GIF file providers (both text-to-image
  and graphic ones). Note, that above-mentioned text-to-image providers
  are using WeasyPrintImageGenerator as a default image generator class,
  since ImagekitImageGenerator class isn't capable of supporting the
  above mentioned file formats.
• Added more helper functions for DynamicTemplate use for ODT, PDF and
  DOCX file providers to support h1, h2, h3, h4, h5 and h6 headings.

Release is dedicated to the victims and de-facto hostages of the Blockade of the Republic of Artsakh.
Have you ever heard of the Armenian genocide? It's happening again and the world silently watches.

• Introducing graphic image providers. Prior to this release, images have
  been created using text-to-image solutions. Sometimes it's just handy to
  have a graphic image. Therefore, a number of graphic image file providers
  have been created (including inner functions support). The following graphic
  file providers have been added: GraphicIcoFileProvider,
  GraphicJpegFileProvider, GraphicPdfFileProvider,
  GraphicPngFileProvider and GraphicWebpFileProvider to support
  creation of graphic ICO, JPEG, PDF, PNG and WEBP files.
• The previously mentioned text-to-image rendering has been delegated to
  image generators. Default generator is still based on the imgkit, but
  the change makes it possible to use custom generators.

• Documentation improvements. Added a dedicated section for creating ODT files.
• Adding add_paragraph and add_page_break to ODT contrib module.

• Documentation improvements. Added a dedicated section for creating PDF files.
  Added a dedicated section for creating DOCX files.
• Adding add_paragraph and add_page_break to DOCX contrib module.

• Moving some of the snippets from tests to a contrib module to improve
  usability. The snippets are generic enough to be used in tests and if you
  don't like the way they work, you could always make a new one. New snippets
  to insert page breaks and paragraphs into PDF (using both pdfkit
  and reportlab generators) have been added.

• Better error handling in CLI.

    This release is dedicated to my beloved son - Tigran, who turned 11!

    This release introduces minor backwards incompatible changes.

• Minor improvements in PDF generation. If you have been using
  DynamicTemplate to generate complex PDFs, you are likely affected
  by the change. Make sure to at least add an additional argument
  named generator to the functions passed to the DynamicTemplate
  class. See the example below:

  Old:

  def add_pb(provider, story, data, counter, **kwargs):

  New:

  def add_pb(provider, generator, story, data, counter, **kwargs):

• Add code examples of how to generate a PDF with 100 pages with
  both PdfkitPdfGenerator and ReportlabPdfGenerator PDF generator
  classes.

• Add version CLI command.

• Add generate-completion and version commands to the CLI
  auto-completion.

• Minor fixes and documentation improvements.

• Improved SFTPStorage tests.
• Stop testing against Python 3.7.
• Stop testing against Django 4.0.