openzim · pirate · Mar 31, 2020 · Mar 31, 2020 · Mar 31, 2020 · Mar 31, 2020
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,51 @@
+FROM ubuntu:bionic
+
+# Update system
+RUN echo 'debconf debconf/frontend select Noninteractive' | debconf-set-selections
+
+# Configure locales
+RUN apt-get update -y && \
+    apt-get install -y --no-install-recommends locales && \
+    apt-get clean -y && \
+    rm -rf /var/lib/apt/lists/*
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+RUN locale-gen en_US.UTF-8
+
+# Install necessary packages
+RUN apt-get update -y && \
+    apt-get install -y --no-install-recommends git pkg-config libtool automake autoconf make g++ liblzma-dev coreutils meson ninja-build wget zlib1g-dev libicu-dev libgumbo-dev libmagic-dev ca-certificates && \
+    apt-get clean -y && \
+    rm -rf /var/lib/apt/lists/*
+
+# Update CA certificates
+RUN update-ca-certificates
+
+# Install Xapian (wget zlib1g-dev)
+RUN wget https://oligarchy.co.uk/xapian/1.4.14/xapian-core-1.4.14.tar.xz
+RUN tar xvf xapian-core-1.4.14.tar.xz
+RUN cd xapian-core-1.4.14 && ./configure
+RUN cd xapian-core-1.4.14 && make all install
+RUN rm -rf xapian
+
+# Install zimlib (libicu-dev)
+RUN git clone https://github.com/openzim/libzim.git
+RUN cd libzim && git checkout 6.0.2
+RUN cd libzim && meson . build
+RUN cd libzim && ninja -C build install
+RUN rm -rf libzim
+
+RUN ldconfig
+ENV LD_LIBRARY_PATH /usr/local/lib/x86_64-linux-gnu/
+
+# Install python dependecies
+
+RUN apt-get update -y && \
+    apt-get install -y --no-install-recommends python-dev python3-dev python3-pip && \
+    apt-get clean -y && \
+    rm -rf /var/lib/apt/lists/*
+
+# Install Cython
+
+RUN pip3 install Cython
diff --git a/README.md b/README.md
@@ -0,0 +1,82 @@
+
+# Setup
+
+```bash
+docker-compose build
+docker-compose run libzim /bin/bash
+```
+```bash
+python setup.py build_ext -i
+python tests/test_libzim.py
+
+# or
+
+./rebuild.sh
+./run_tests
+```
+
+Example:
+
+```python3
+from libzim import ZimArticle, ZimBlob, ZimCreator
+
+class ZimTestArticle(ZimArticle):
+    content = '''<!DOCTYPE html> 
+                <html class="client-js">
+                <head><meta charset="UTF-8">
+                <title>Monadical</title>
+                </head>
+                <h1> ñññ Hello, it works ñññ </h1></html>'''
+
+    def __init__(self):
+        ZimArticle.__init__(self)
+
+    def is_redirect(self):
+        return False
+
+    def get_url(self):
+        return "A/Monadical_SAS"
+
+    def get_title(self):
+        return "Monadical SAS"
+
+    def get_mime_type(self):
+        return "text/html"
+
+    def get_filename(self):
+        return ""
+
+    def should_compress(self):
+        return True
+
+    def should_index(self):
+        return True
+
+    def get_data(self):
+        return ZimBlob(self.content.encode('UTF-8'))
+
+# Create a ZimTestArticle article
+
+article = ZimTestArticle()
+print(article.content)
+
+# Write the articles
+import uuid
+rnd_str = str(uuid.uuid1()) 
+
+test_zim_file_path = "/opt/python-libzim/tests/kiwix-test"
+
+zim_creator = ZimCreator(test_zim_file_path + '-' + rnd_str + '.zim',main_page = "welcome",index_language= "eng", min_chunk_size= 2048)
+
+# Add article to zim file
+zim_creator.add_article(article)
+
+
+# Set mandatory metadata
+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')
+
+# Write article to zim file
+zim_creator.finalize()
+
+```
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,13 @@
+version: '3'
+
+services:
+  libzim:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    image: kiwix:python-libzim
+    working_dir: /opt/python-libzim
+    stdin_open: true
+    tty: true
+    volumes:
+      - .:/opt/python-libzim
diff --git a/libzim/examples.py b/libzim/examples.py
@@ -0,0 +1,75 @@
+from libzim import ZimArticle, ZimBlob, ZimCreator
+
+class ZimTestArticle(ZimArticle):
+
+    def __init__(self, url, title, content):
+        ZimArticle.__init__(self)
+        self.url = url
+        self.title = title
+        self.content = content
+
+    def is_redirect(self):
+        return False
+
+    def get_url(self):
+        return f"A/{self.url}"
+
+    def get_title(self):
+        return f"{self.title}"
+
+    def get_mime_type(self):
+        return "text/html"
+
+    def get_filename(self):
+        return ""
+
+    def should_compress(self):
+        return True
+
+    def should_index(self):
+        return True
+
+    def get_data(self):
+        return ZimBlob(self.content)
+
+# Create a ZimTestArticle article
+
+content = '''<!DOCTYPE html> 
+                <html class="client-js">
+                <head><meta charset="UTF-8">
+                <title>Monadical</title>
+                </head>
+                <h1> ñññ Hello, it works ñññ </h1></html>'''
+
+content2 = '''<!DOCTYPE html> 
+                <html class="client-js">
+                <head><meta charset="UTF-8">
+                <title>Monadical 2</title>
+                </head>
+                <h1> ñññ Hello, it works 2 ñññ </h1></html>'''
+
+article = ZimTestArticle("Monadical_SAS", "Monadical", content)
+article2 = ZimTestArticle("Monadical_2", "Monadical 2", content2)
+
+print(article.content)
+
+# Write the article
+import uuid
+rnd_str = str(uuid.uuid1()) 
+
+test_zim_file_path = "/opt/python-libzim/tests/kiwix-test"
+
+zim_creator = ZimCreator(test_zim_file_path + '-' + rnd_str + '.zim',main_page = "Monadical",index_language= "eng", min_chunk_size= 2048)
+
+# Add articles to zim file
+zim_creator.add_article(article)
+zim_creator.add_article(article2)
+
+# Set mandatory metadata
+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')
+
+print(zim_creator._get_metadata())
+
+# Write articles to zim file
+zim_creator.finalize()