File download

Beta License: AGPL-3 sygel-technology/sy-server-backend

This module lets you call a wizard to download any file.

Table of contents

Usage

To use this module, you need to:

  1. Create a model that inherits from file.download.model.

  2. Override the following functions:

    • `get_filename`: Return the desired file name.

    • `get_content`: Return the binary string file to download. For example:

      from io import StringIO
      
      def get_content(self):
          output = StringIO()
          file.save(output)
          output.seek(0)
          return output.read()
      
  3. After this, create a wizard with a button that calls the function set_file. This function will open a new wizard with the downloadable file.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Sygel

Contributors

  • Sygel:
    • Valentín Vinagre
    • Ángel García de la Chica Herrera

Maintainers

This module is part of the sygel-technology/sy-server-backend project on GitHub.

You are welcome to contribute.