turns a collection of documents into a browsable ZIM file
Project description
Nautilus
nautilus turns a collection of documents into a browsable ZIM file.
It downloads the video (webm or mp4 format – optionally recompress it in lower-quality, smaller size), the thumbnails, the subtitles and the authors' profile pictures ; then, it creates a static HTML files folder of it before creating a ZIM off of it.
Preparing the archive
To be used with nautilus, your archive should be a ZIP file.
- it doesn't need to be structured, but it can.
- it doesn't need to be compressed. It's usually recommended not to.
- it should contain a
collection.jsonfile, but it can also be provided separately (see below). - it should only contain to-be-included files. No filtering is done.
- Audio and video files should be in ogg format with an
.ogg/.ogvextension to be supported on all platforms (mp3/mp4would work only on platforms with native support).
cd content/path
zip -r -0 -T ../content_name.zip *
JSON collection file
Either inside the archive ZIP as /collection.json or elsewhere,
specified via --collection mycollection.json, you must supply a JSON file describing your content.
The user-interface only gives access to files referenced properly in the collection.
At the moment, the JSON file needs to provide the following fields for each item in an array:
[
{
"title": "...",
"description": "...",
"authors": "...",
"files": ["relative/path/to/file"]
}
]
About page
Either inside the archive ZIP as /about.html or elsewhere, specified via --about myabout.html,
- You may supply an about page in HTML format. It will be displayed in a modal popup and will be included.
- At its bottom your secondary-logo if provided.
- Use only content tags (no
<html />nor<head />nor<script />etc) - Use inline styling if required, but no styling is recommended.
- Include one logo inline if required.
Requirements
wgetandunzipto install JS dependencies. Seeget_js_deps.shif you want to do it manually.wgetis used to download archive files as well.handlebarsis used to compile JS templates
Installation
nautilus is a python program. if you are not using the docker image, you are advised to use it in a virtual-environment. See requirements.txt for the list of python dependencies.
docker
docker run -v my_dir:/output ghcr.io/openzim/nautilus nautiluszim --help
pip
pip install nautiluszim
nautiluszim --help
Usage
nautiluszim --archive my-content.zip
Notes
- On macOS, the locale setting is buggy. You need to launch it with the
LANGUAGEenvironment variable (as ISO-639-1) for the translations to work.
LANGUAGE=fr nautiluszim --language fra
Development
See CONTRIBUTING.md
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file nautiluszim-1.1.0.tar.gz.
File metadata
- Download URL: nautiluszim-1.1.0.tar.gz
- Upload date:
- Size: 3.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e21f182b54137204df21a471c8a2f9b64fcc564d1c27703fff22a2853ed2e3fd |
|
| MD5 | 6413a9816106d30ca476ca24ff95f391 |
|
| BLAKE2b-256 | 352eaf44fcebe127389223bca2c2040b341bfbad57549edf9cacc7965eebe529 |
File details
Details for the file nautiluszim-1.1.0-py3-none-any.whl.
File metadata
- Download URL: nautiluszim-1.1.0-py3-none-any.whl
- Upload date:
- Size: 4.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f61004e6c07ff2782337b5bb219eb5e936af07165f2e1567889a6dbcd156260b |
|
| MD5 | d2dcbb835b25cb8a141174e5e595c5b5 |
|
| BLAKE2b-256 | 06583c6a38a66434dee1690d78beeda53539188c7fc516fd09e1e6f7bf79cf8b |
