local_storage
=============

.. py:module:: local_storage


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/local_storage/local_storage/index




Package Contents
----------------

.. py:class:: LocalStorage

   Bases: :py:obj:`auto_archiver.core.Storage`


   Base class for implementing storage modules in the media archiving framework.

   Subclasses must implement the `get_cdn_url` and `uploadf` methods to define their behavior.


   .. py:method:: setup() -> None


   .. py:method:: get_cdn_url(media: auto_archiver.core.Media) -> str

      Returns the URL of the media object stored in the CDN.



   .. py:method:: set_key(media, url, metadata)

      takes the media and optionally item info and generates a key



   .. py:method:: upload(media: auto_archiver.core.Media, **kwargs) -> bool

      Uploads a media object to the storage service.

      This method should not be called directly, but instead be called through the 'store' method,
      which sets up the media for storage.



   .. py:method:: uploadf(file: IO[bytes], key: str, **kwargs: dict) -> bool

      Uploads (or saves) a file to the storage service/location.

      This method should not be called directly, but instead through the 'store' method,
      which sets up the media for storage.