Add write metadata function

Author: jdcaballerov

libzim/examples.py

@@ -59,6 +59,8 @@ def get_data(self):
 if not zim_creator.mandatory_metadata_ok:
     zim_creator.update_metadata(creator='python-libzim',description='Created in python',name='Hola',publisher='Monadical',title='Test Zim')
 
+zim_creator.write_metadata(zim_creator._get_metadata())
+
 # Write articles to zim file
 zim_creator.finalize()
 

libzim/libzim.pyx

@@ -134,6 +134,42 @@ cdef public api:
 
 #TODO Write metadata
 
+class ZimMetadataArticle(ZimArticle):
+
+    def __init__(self,url, metadata_content):
+        ZimArticle.__init__(self)
+        self.url = url
+        self.metadata_content = metadata_content
+
+    def is_redirect(self):
+        return False
+
+    @property
+    def can_write(self):
+        return True
+
+    def get_url(self):
+        return f"M/{self.url}"
+
+    def get_title(self):
+        return f"{self.url}"
+    
+    def get_mime_type(self):
+        return "text/plain"
+    
+    def get_filename(self):
+        return ""
+    
+    def should_compress(self):
+        return True
+
+    def should_index(self):
+        return True
+
+    def get_data(self):
+        return ZimBlob(self.metadata_content)
+
+
 MANDATORY_METADATA_KEYS =[
         "Name", 
         "Title", 
@@ -301,6 +337,11 @@ cdef class ZimCreator:
             if not article.is_redirect():
                 self._update_article_counter(article)
 
+    def write_metadata(self, dict metadata):
+        for key in metadata:
+            metadata_article = ZimMetadataArticle(url=key, metadata_content=metadata[key])
+            self.add_article(metadata_article)
+
     def finalize(self):
         """finalize and write added articles to the file.
         

tests/test_libzim.py

@@ -93,6 +93,9 @@ def test_write_article(self):
         rnd_str = str(uuid.uuid1()) 
         zim_creator = ZimCreator(self.test_zim_file_path + '-' + rnd_str + '.zim',main_page = "welcome",index_language= "eng", min_chunk_size= 2048)
         zim_creator.add_article(self.test_article)
+        # Set mandatory metadata
+        zim_creator.update_metadata(creator='python-libzim',description='Created in python',name='Hola',publisher='Monadical',title='Test Zim')
+        zim_creator.write_metadata(zim_creator._get_metadata())
         zim_creator.finalize()