0.4.18 release

Skip invalid URLs when archiving

.dockerignore

@@ -8,7 +8,6 @@ venv/
 .venv/
 .docker-venv/
 
-*.egg-info/
 build/
 dist/
 

.github/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contribution Process
 
-1. Confirm your desired features fit into our bigger project goals roadmap: https://github.com/pirate/ArchiveBox#roadmap
+1. Confirm your desired features fit into our bigger project goals [Roadmap](https://github.com/pirate/ArchiveBox/wiki/Roadmap).
 2. Open an issue with your planned implementation to discuss
 3. Check in with me before starting development to make sure your work wont conflict with or duplicate existing work
 4. Setup your dev environment, make some changes, and test using the test input files

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,5 +17,5 @@ e.g. This PR fixes ABC or adds the ability to do XYZ...
 
 # Roadmap Goals
 
-This PR helps us move towards xyz roadmap goal, as outlined here: https://github.com/pirate/ArchiveBox#roadmap
+This PR helps us move towards xyz roadmap goal, as outlined here: https://github.com/pirate/ArchiveBox/wiki/Roadmap
 (delete this section if it's just a bugfix / simple PR)

.github/workflows/test.yml

@@ -40,28 +40,19 @@ jobs:
         with:
           fetch-depth: 1
 
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 1
-          repository: "gildas-lormeau/SingleFile"
-          ref: "master"
-          path: "singlefile"
-
-      - name: Install npm requirements for singlefile
-        run: npm install --prefix singlefile/cli
-
-      - name: Give singlefile execution permissions
-        run: chmod +x singlefile/cli/single-file
-
-      - name: Set SINGLEFILE_BINARY
-        run: echo "::set-env name=SINGLEFILE_BINARY::$GITHUB_WORKSPACE/singlefile/cli/single-file"
-
+      ### Setup Python & JS Languages
       - name: Set up Python ${{ matrix.python }}
         uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
 
+      - name: Set up Node JS 14.7.0
+        uses: actions/setup-node@v1
+        with:
+          node-version: 14.7.0
+
+      ### Install Python & JS Dependencies
       - name: Get pip cache dir
         id: pip-cache
         run: |
@@ -76,19 +67,40 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-${{ matrix.python }}-venv-
 
-      - name: Use nodejs 14.7.0
-        uses: actions/setup-node@v1
-        with:
-          node-version: 14.7.0
-
-      - name: Debug
-        run: ls ./
-
-      - name: Install dependencies
+      - name: Install pip dependencies
         run: |
           python -m pip install .
           python -m pip install pytest bottle
 
+
+      - name: Get npm cache dir
+        id: npm-cache
+        run: |
+          echo "::set-output name=dir::$GITHUB_WORKSPACE/node_modules"
+
+      - name: Cache npm
+        uses: actions/cache@v2
+        id: cache-npm
+        with:
+          path: ${{ steps.npm-cache.outputs.dir }}
+          key: ${{ runner.os }}-node_modules-${{ hashFiles('package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node_modules
+
+      - name: Install npm requirements
+        run: |
+          npm install
+          echo "::set-env name=SINGLEFILE_BINARY::$GITHUB_WORKSPACE/node_modules/.bin/single-file"
+          echo "::set-env name=READABILITY_BINARY::$GITHUB_WORKSPACE/node_modules/.bin/readability-extractor"
+
+
+      ### Run the tests
+      - name: Directory listing for debugging
+        run: |
+          pwd
+          ls -a ./
+          archivebox version
+
       - name: Test built package with pytest
         run: |
           python -m pytest -s

.gitignore

@@ -8,7 +8,6 @@ venv/
 .venv/
 .docker-venv/
 
-*.egg-info/
 build/
 dist/
 

Dockerfile

@@ -1,82 +1,106 @@
-# This is the Dockerfile for ArchiveBox, it includes the following major pieces:
-#     git, curl, wget, python3, youtube-dl, google-chrome-stable, ArchiveBox
+# This is the Dockerfile for ArchiveBox, it bundles the following dependencies:
+#     python3, ArchiveBox, curl, wget, git, chromium, youtube-dl, single-file
 # Usage:
-#     docker build . -t archivebox
+#     docker build . -t archivebox --no-cache
 #     docker run -v "$PWD/data":/data archivebox init
 #     docker run -v "$PWD/data":/data archivebox add 'https://example.com'
-# Documentation:
-#     https://github.com/pirate/ArchiveBox/wiki/Docker#docker
+#     docker run -v "$PWD/data":/data -it archivebox manage createsuperuser
+#     docker run -v "$PWD/data":/data -p 8000:8000 archivebox server
 
 FROM python:3.8-slim-buster
 
 LABEL name="archivebox" \
-    maintainer="Nick Sweeting <archivebox-git@sweeting.me>" \
-    description="All-in-one personal internet archiving container"
+    maintainer="Nick Sweeting <archivebox-docker@sweeting.me>" \
+    description="All-in-one personal internet archiving container" \
+    homepage="https://github.com/pirate/ArchiveBox" \
+    documentation="https://github.com/pirate/ArchiveBox/wiki/Docker#docker"
 
+# System-level base config
 ENV TZ=UTC \
     LANGUAGE=en_US:en \
     LC_ALL=C.UTF-8 \
     LANG=C.UTF-8 \
     PYTHONIOENCODING=UTF-8 \
     PYTHONUNBUFFERED=1 \
-    APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=1 \
-    CODE_PATH=/app \
+    DEBIAN_FRONTEND=noninteractive \
+    APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=1
+
+# Application-level base config
+ENV CODE_DIR=/app \
     VENV_PATH=/venv \
-    DATA_PATH=/data \
-    EXTRA_PATH=/extra
+    DATA_DIR=/data \
+    NODE_DIR=/node \
+    ARCHIVEBOX_USER="archivebox"
 
-# First install CLI utils and base deps, then Chrome + Fons + nodejs
-RUN echo 'debconf debconf/frontend select Noninteractive' | debconf-set-selections \
+# Create non-privileged user for archivebox and chrome
+RUN groupadd --system $ARCHIVEBOX_USER \
+    && useradd --system --create-home --gid $ARCHIVEBOX_USER --groups audio,video $ARCHIVEBOX_USER
+
+# Install system dependencies
+RUN apt-get update -qq \
+    && apt-get install -qq -y --no-install-recommends \
+        apt-transport-https ca-certificates gnupg2 zlib1g-dev \
+        dumb-init gosu cron unzip curl \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install apt dependencies
+RUN apt-get update -qq \
+    && apt-get install -qq -y --no-install-recommends \
+        wget curl chromium git ffmpeg youtube-dl \
+        fontconfig fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst fonts-symbola fonts-noto fonts-freefont-ttf \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install Node environment
+RUN curl -s https://deb.nodesource.com/gpgkey/nodesource.gpg.key | apt-key add - \
+    && echo 'deb https://deb.nodesource.com/node_14.x buster main' >> /etc/apt/sources.list \
     && apt-get update -qq \
     && apt-get install -qq -y --no-install-recommends \
-    apt-transport-https ca-certificates apt-utils gnupg gosu gnupg2 libgconf-2-4 zlib1g-dev \
-    dumb-init jq git wget curl youtube-dl ffmpeg \
-    && curl -sSL "https://dl.google.com/linux/linux_signing_key.pub" | apt-key add - \
-    && echo "deb https://dl.google.com/linux/chrome/deb/ stable main" > /etc/apt/sources.list.d/google-chrome.list \
-    && curl -sL https://deb.nodesource.com/setup_14.x | bash - \
-    && apt-get update -qq \
-    && apt-get install -qq -y --no-install-recommends \
-    google-chrome-stable \
-    fontconfig \
-    fonts-ipafont-gothic \
-    fonts-wqy-zenhei \
-    fonts-thai-tlwg \
-    fonts-kacst \
-    fonts-symbola \
-    fonts-noto \
-    fonts-freefont-ttf \
-    nodejs \
-    unzip \
-    && rm -rf /var/lib/apt/lists/* 
+        nodejs \
+    && rm -rf /var/lib/apt/lists/*
 
-# Clone singlefile and move it to the /bin folder so archivebox can find it
-
-WORKDIR "$EXTRA_PATH"
-RUN wget -qO - https://github.com/gildas-lormeau/SingleFile/archive/master.zip > SingleFile.zip \
-    && unzip -q SingleFile.zip \
-    && npm install --prefix SingleFile-master/cli --production > /dev/null 2>&1 \
-    && chmod +x SingleFile-master/cli/single-file 
-
-# Run everything from here on out as non-privileged user
-RUN groupadd --system archivebox \
-    && useradd --system --create-home --gid archivebox --groups audio,video archivebox
-
-ADD . "$CODE_PATH"
-WORKDIR "$CODE_PATH"
+# Install Python dependencies
+WORKDIR "$CODE_DIR"
 ENV PATH="${PATH}:$VENV_PATH/bin"
 RUN python -m venv --clear --symlinks "$VENV_PATH" \
-    && pip install --upgrade pip setuptools \
-    && pip install -e .
+    && pip install --upgrade --quiet pip setuptools
+ADD ./archivebox.egg-info/requires.txt "$CODE_DIR/archivebox.egg-info/requires.txt"
+RUN apt-get update -qq \
+    && apt-get install -qq -y --no-install-recommends \
+        build-essential python-dev python3-dev \
+    && grep -B 1000 -E '^$' "$CODE_DIR/archivebox.egg-info/requires.txt" | pip install --quiet -r /dev/stdin \
+    && apt-get purge -y build-essential python-dev python3-dev \
+    && apt-get autoremove -y \
+    && rm -rf /var/lib/apt/lists/*
 
-VOLUME "$DATA_PATH"
-WORKDIR "$DATA_PATH"
-EXPOSE 8000
+# Install Node dependencies
+WORKDIR "$NODE_DIR"
+ENV PATH="${PATH}:$NODE_DIR/node_modules/.bin" \
+    npm_config_loglevel=error
+RUN npm install -g npm
+ADD ./package.json ./package.json
+RUN npm install
+
+# Install ArchiveBox Python package
+WORKDIR "$CODE_DIR"
+ADD . "$CODE_DIR"
+RUN pip install -e .
+
+# Setup ArchiveBox runtime config
+WORKDIR "$DATA_DIR"
 ENV IN_DOCKER=True \
-    CHROME_BINARY=google-chrome \
     CHROME_SANDBOX=False \
-    SINGLEFILE_BINARY="$EXTRA_PATH/SingleFile-master/cli/single-file"
+    CHROME_BINARY="chromium" \
+    USE_SINGLEFILE=True \
+    SINGLEFILE_BINARY="$NODE_DIR/node_modules/.bin/single-file" \
+    USE_READABILITY=True \
+    READABILITY_BINARY="$NODE_DIR/node_modules/.bin/readability-extractor"
 
-RUN env ALLOW_ROOT=True archivebox version
+# Print version for nice docker finish summary
+RUN archivebox version
+
+# Open up the interfaces to the outside world
+VOLUME "$DATA_DIR"
+EXPOSE 8000
 
 ENTRYPOINT ["dumb-init", "--", "/app/bin/docker_entrypoint.sh"]
 CMD ["archivebox", "server", "0.0.0.0:8000"]

MANIFEST.in

@@ -1,4 +1,5 @@
 include LICENSE
 include README.md
-include archivebox/VERSION
+include package.json
+include package-lock.json
 recursive-include archivebox/themes *

README.md

@@ -131,8 +131,10 @@ All the archived links are stored by date bookmarked in `./archive/<timestamp>`,
 
 ```bash
 echo 'http://example.com' | archivebox add
-archivebox add ~/Downloads/firefox_bookmarks_export.html --depth=1
-archivebox add https://example.com/some/rss/feed.xml --depth=1
+archivebox add 'https://example.com/some/page'
+archivebox add < ~/Downloads/firefox_bookmarks_export.html
+archivebox add --depth=1 'https://example.com/some/rss/feed.xml'
+archivebox add --depth=1 'https://news.ycombinator.com#2020-12-12'
 ```
 
 - <img src="https://nicksweeting.com/images/bookmarks.png" height="22px"/> Browser history or bookmarks exports (Chrome, Firefox, Safari, IE, Opera, and more)

archivebox.egg-info/PKG-INFO

@@ -0,0 +1,352 @@
+Metadata-Version: 2.1
+Name: archivebox
+Version: 0.4.18
+Summary: The self-hosted internet archive.
+Home-page: https://github.com/pirate/ArchiveBox
+Author: Nick Sweeting
+Author-email: git@nicksweeting.com
+License: MIT
+Project-URL: Source, https://github.com/pirate/ArchiveBox
+Project-URL: Documentation, https://github.com/pirate/ArchiveBox/wiki
+Project-URL: Bug Tracker, https://github.com/pirate/ArchiveBox/issues
+Project-URL: Changelog, https://github.com/pirate/ArchiveBox/wiki/Changelog
+Project-URL: Roadmap, https://github.com/pirate/ArchiveBox/wiki/Roadmap
+Project-URL: Community, https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community
+Project-URL: Donate, https://github.com/pirate/ArchiveBox/wiki/Donations
+Description: <div align="center">
+        <img src="https://i.imgur.com/4nkFjdv.png" height="80px">
+        <h1>ArchiveBox<br/><sub>The open-source self-hosted web archive.</sub></h1>
+        
+        ▶️ <a href="https://github.com/pirate/ArchiveBox/wiki/Quickstart">Quickstart</a> | 
+        <a href="https://archivebox.zervice.io/">Demo</a> | 
+        <a href="https://github.com/pirate/ArchiveBox">Github</a> | 
+        <a href="https://github.com/pirate/ArchiveBox/wiki">Documentation</a> | 
+        <a href="#background--motivation">Info & Motivation</a> | 
+        <a href="https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community">Community</a> | 
+        <a href="https://github.com/pirate/ArchiveBox/wiki/Roadmap">Roadmap</a>
+        
+        <pre>
+        "Your own personal internet archive" (网站存档 / 爬虫)
+        </pre>
+        
+        <!--<a href="http://webchat.freenode.net?channels=ArchiveBox&uio=d4"><img src="https://img.shields.io/badge/Community_chat-IRC-%2328A745.svg"/></a>-->
+        
+        <a href="https://github.com/pirate/ArchiveBox/blob/master/LICENSE"><img src="https://img.shields.io/badge/Open_source-MIT-green.svg?logo=git&logoColor=green"/></a>
+        <a href="https://github.com/pirate/ArchiveBox/commits/dev"><img src="https://img.shields.io/github/last-commit/pirate/ArchiveBox.svg?logo=Sublime+Text&logoColor=green&label=Active"/></a>
+        <a href="https://github.com/pirate/ArchiveBox"><img src="https://img.shields.io/github/stars/pirate/ArchiveBox.svg?logo=github&label=Stars&logoColor=blue"/></a>
+        <a href="https://test.pypi.org/project/archivebox/"><img src="https://img.shields.io/badge/Python-%3E%3D3.7-yellow.svg?logo=python&logoColor=yellow"/></a>
+        <a href="https://github.com/pirate/ArchiveBox/wiki/Install#dependencies"><img src="https://img.shields.io/badge/Chromium-%3E%3D59-orange.svg?logo=Google+Chrome&logoColor=orange"/></a>
+        <a href="https://hub.docker.com/r/nikisweeting/archivebox"><img src="https://img.shields.io/badge/Docker-all%20platforms-lightblue.svg?logo=docker&logoColor=lightblue"/></a>
+        <hr/>
+        </div>
+        
+        **ArchiveBox takes a list of website URLs you want to archive, and creates a local, static, browsable HTML clone of the content from those websites (it saves HTML, JS, media files, PDFs, images and more).**
+        
+        You can use it to preserve access to websites you care about by storing them locally offline. ArchiveBox imports lists of URLs, renders the pages in a headless, authenticated, user-scriptable browser, and then archives the content in multiple redundant common formats (HTML, PDF, PNG, WARC) that will last long after the originals disappear off the internet. It automatically extracts assets and media from pages and saves them in easily-accessible folders, with out-of-the-box support for extracting git repositories, audio, video, subtitles, images, PDFs, and more.
+        
+        #### How does it work?
+        
+        ```bash
+        mkdir data && cd data
+        archivebox init
+        archivebox add 'https://example.com'
+        archivebox add 'https://getpocket.com/users/USERNAME/feed/all' --depth=1
+        archivebox server
+        ```
+        
+        After installing archivebox, just pass some new links to the `archivebox add` command to start your collection.
+        
+        ArchiveBox is written in Python 3.7 and uses wget, Chrome headless, youtube-dl, pywb, and other common UNIX tools to save each page you add in multiple redundant formats. It doesn't require a constantly running server or backend (though it does include an optional one), just open the generated `data/index.html` in a browser to view the archive or run `archivebox server` to use the interactive Web UI. It can import and export links as JSON (among other formats), so it's easy to script or hook up to other APIs. If you run it on a schedule and import from browser history or bookmarks regularly, you can sleep soundly knowing that the slice of the internet you care about will be automatically preserved in multiple, durable long-term formats that will be accessible for decades (or longer).
+        
+        <div align="center">
+        
+        <img src="https://i.imgur.com/3tBL7PU.png" width="22%" alt="CLI Screenshot" align="top">
+        <img src="https://i.imgur.com/viklZNG.png" width="22%" alt="Desktop index screenshot" align="top">
+        <img src="https://i.imgur.com/RefWsXB.jpg" width="22%" alt="Desktop details page Screenshot"/>
+        <img src="https://i.imgur.com/M6HhzVx.png" width="22%" alt="Desktop details page Screenshot"/><br/>
+        <sup><a href="https://archive.sweeting.me/">Demo</a> | <a href="https://github.com/pirate/ArchiveBox/wiki/Usage">Usage</a> | <a href="#screenshots">Screenshots</a></sup>
+        <br/>
+        <sub>. . . . . . . . . . . . . . . . . . . . . . . . . . . .</sub>
+        </div><br/>
+        
+        ## Quickstart
+        
+        ArchiveBox is written in `python3.7` and has [3 main binary dependencies](https://github.com/pirate/ArchiveBox/wiki/Install#dependencies): `wget`, `chromium`, and `youtube-dl`.
+        To get started, you can [install them manually](https://github.com/pirate/ArchiveBox/wiki/Install) using your system's package manager, use the [automated helper script](https://github.com/pirate/ArchiveBox/wiki/Quickstart), or use the official [Docker](https://github.com/pirate/ArchiveBox/wiki/Docker) container. All three dependencies are optional if [disabled](https://github.com/pirate/ArchiveBox/wiki/Configuration#archive-method-toggles) in settings.
+        
+        ```bash
+        # Docker
+        mkdir data && cd data
+        docker run -v $PWD:/data nikisweeting/archivebox init
+        docker run -v $PWD:/data nikisweeting/archivebox add 'https://example.com'
+        docker run -v $PWD:/data -it nikisweeting/archivebox manage createsuperuser
+        docker run -v $PWD:/data -p 8000:8000 nikisweeting/archivebox server 0.0.0.0:8000
+        open http://127.0.0.1:8000
+        ```
+        
+        ```bash
+        # Docker Compose
+        # first download: https://github.com/pirate/ArchiveBox/blob/master/docker-compose.yml
+        docker-compose run archivebox init
+        docker-compose run archivebox add 'https://example.com'
+        docker-compose run archivebox manage createsuperuser
+        docker-compose up
+        open http://127.0.0.1:8000
+        ```
+        
+        ```bash
+        # Bare Metal
+        # Use apt on Ubuntu/Debian, brew on mac, or pkg on BSD
+        apt install python3 python3-pip git curl wget youtube-dl chromium-browser
+        
+        pip install archivebox      # install archivebox
+        
+        mkdir data && cd data       # (doesn't have to be called data)
+        archivebox init
+        archivebox add 'https://example.com'  # add URLs via args or stdin
+        
+        # or import an RSS/JSON/XML/TXT feed/list of links
+        archivebox add https://getpocket.com/users/USERNAME/feed/all --depth=1
+        ```
+        
+        Once you've added your first links, open `data/index.html` in a browser to view the static archive.
+        
+        You can also start it as a server with a full web UI to manage your links:
+        ```bash
+        archivebox manage createsuperuser
+        archivebox server
+        ```
+        
+        You can visit `http://127.0.0.1:8000` in your browser to access it.
+        
+        [DEMO: archivebox.zervice.io/](https://archivebox.zervice.io)  
+        For more information, see the [full Quickstart guide](https://github.com/pirate/ArchiveBox/wiki/Quickstart), [Usage](https://github.com/pirate/ArchiveBox/wiki/Usage), and [Configuration](https://github.com/pirate/ArchiveBox/wiki/Configuration) docs.
+        
+        ---
+        
+        <div align="center">
+        <img src="https://i.imgur.com/PVO88AZ.png" width="80%"/>
+        </div>
+        
+        # Overview
+        
+        Because modern websites are complicated and often rely on dynamic content,
+        ArchiveBox archives the sites in **several different formats** beyond what public
+        archiving services like Archive.org and Archive.is are capable of saving. Using multiple
+        methods and the market-dominant browser to execute JS ensures we can save even the most
+        complex, finicky websites in at least a few high-quality, long-term data formats.
+        
+        ArchiveBox imports a list of URLs from stdin, remote URL, or file, then adds the pages to a local archive folder using wget to create a browsable HTML clone, youtube-dl to extract media, and a full instance of Chrome headless for PDF, Screenshot, and DOM dumps, and more...
+        
+        Running `archivebox add` adds only new, unique links into your collection on each run. Because it will ignore duplicates and only archive each link the first time you add it, you can schedule it to [run on a timer](https://github.com/pirate/ArchiveBox/wiki/Scheduled-Archiving) and re-import all your feeds multiple times a day. It will run quickly even if the feeds are large, because it's only archiving the newest links since the last run. For each link, it runs through all the archive methods. Methods that fail will save `None` and be automatically retried on the next run, methods that succeed save their output into the data folder and are never retried/overwritten by subsequent runs. Support for saving multiple snapshots of each site over time will be [added soon](https://github.com/pirate/ArchiveBox/issues/179) (along with the ability to view diffs of the changes between runs).
+        
+        All the archived links are stored by date bookmarked in `./archive/<timestamp>`, and everything is indexed nicely with JSON & HTML files. The intent is for all the content to be viewable with common software in 50 - 100 years without needing to run ArchiveBox in a VM.
+        
+        #### Can import links from many formats:
+        
+        ```bash
+        echo 'http://example.com' | archivebox add
+        archivebox add 'https://example.com/some/page'
+        archivebox add < ~/Downloads/firefox_bookmarks_export.html
+        archivebox add --depth=1 'https://example.com/some/rss/feed.xml'
+        archivebox add --depth=1 'https://news.ycombinator.com#2020-12-12'
+        ```
+        
+        - <img src="https://nicksweeting.com/images/bookmarks.png" height="22px"/> Browser history or bookmarks exports (Chrome, Firefox, Safari, IE, Opera, and more)
+        - <img src="https://nicksweeting.com/images/rss.svg" height="22px"/> RSS, XML, JSON, CSV, SQL, HTML, Markdown, TXT, or any other text-based format
+        - <img src="https://getpocket.com/favicon.ico" height="22px"/> Pocket, Pinboard, Instapaper, Shaarli, Delicious, Reddit Saved Posts, Wallabag, Unmark.it, OneTab, and more
+        
+        See the [Usage: CLI](https://github.com/pirate/ArchiveBox/wiki/Usage#CLI-Usage) page for documentation and examples.
+        
+        #### Saves lots of useful stuff for each imported link:
+        
+        ```bash
+         ls ./archive/<timestamp>/
+        ```
+        
+        - **Index:** `index.html` & `index.json` HTML and JSON index files containing metadata and details
+        - **Title:** `title` title of the site
+        - **Favicon:** `favicon.ico` favicon of the site
+        - **WGET Clone:** `example.com/page-name.html` wget clone of the site, with .html appended if not present
+        - **WARC:** `warc/<timestamp>.gz` gzipped WARC of all the resources fetched while archiving
+        - **PDF:** `output.pdf` Printed PDF of site using headless chrome
+        - **Screenshot:** `screenshot.png` 1440x900 screenshot of site using headless chrome
+        - **DOM Dump:** `output.html` DOM Dump of the HTML after rendering using headless chrome
+        - **URL to Archive.org:** `archive.org.txt` A link to the saved site on archive.org
+        - **Audio & Video:** `media/` all audio/video files + playlists, including subtitles & metadata with youtube-dl
+        - **Source Code:** `git/` clone of any repository found on github, bitbucket, or gitlab links
+        - _More coming soon! See the [Roadmap](https://github.com/pirate/ArchiveBox/wiki/Roadmap)..._
+        
+        It does everything out-of-the-box by default, but you can disable or tweak [individual archive methods](https://github.com/pirate/ArchiveBox/wiki/Configuration) via environment variables or config file.
+        
+        If you're importing URLs with secret tokens in them (e.g Google Docs, CodiMD notepads, etc), you may want to disable some of these methods to avoid leaking private URLs to 3rd party APIs during the archiving process. See the [Security Overview](https://github.com/pirate/ArchiveBox/wiki/Security-Overview#stealth-mode) page for more details.
+        
+        ## Key Features
+        
+        - [**Free & open source**](https://github.com/pirate/ArchiveBox/blob/master/LICENSE), doesn't require signing up for anything, stores all data locally
+        - [**Few dependencies**](https://github.com/pirate/ArchiveBox/wiki/Install#dependencies) and [simple command line interface](https://github.com/pirate/ArchiveBox/wiki/Usage#CLI-Usage)
+        - [**Comprehensive documentation**](https://github.com/pirate/ArchiveBox/wiki), [active development](https://github.com/pirate/ArchiveBox/wiki/Roadmap), and [rich community](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community)
+        - **Doesn't require a constantly-running server**, proxy, or native app
+        - Easy to set up **[scheduled importing](https://github.com/pirate/ArchiveBox/wiki/Scheduled-Archiving) from multiple sources**
+        - Uses common, **durable, [long-term formats](#saves-lots-of-useful-stuff-for-each-imported-link)** like HTML, JSON, PDF, PNG, and WARC
+        - ~~**Suitable for paywalled / [authenticated content](https://github.com/pirate/ArchiveBox/wiki/Configuration#chrome_user_data_dir)** (can use your cookies)~~ (do not do this until v0.5 is released with some security fixes)
+        - Can [**run scripts during archiving**](https://github.com/pirate/ArchiveBox/issues/51) to [scroll pages](https://github.com/pirate/ArchiveBox/issues/80), [close modals](https://github.com/pirate/ArchiveBox/issues/175), expand comment threads, etc.
+        - Can also [**mirror content to 3rd-party archiving services**](https://github.com/pirate/ArchiveBox/wiki/Configuration#submit_archive_dot_org) automatically for redundancy
+        
+        ## Background & Motivation
+        
+        Vast treasure troves of knowledge are lost every day on the internet to link rot. As a society, we have an imperative to preserve some important parts of that treasure, just like we preserve our books, paintings, and music in physical libraries long after the originals go out of print or fade into obscurity.
+        
+        Whether it's to resist censorship by saving articles before they get taken down or edited, or
+        just to save a collection of early 2010's flash games you love to play, having the tools to
+        archive internet content enables to you save the stuff you care most about before it disappears.
+        
+        <div align="center">
+        <img src="https://i.imgur.com/bC6eZcV.png" width="50%"/><br/>
+         <sup><i>Image from <a href="https://digiday.com/media/wtf-link-rot/">WTF is Link Rot?</a>...</i><br/></sup>
+        </div>
+        
+        The balance between the permanence and ephemeral nature of content on the internet is part of what makes it beautiful.
+        I don't think everything should be preserved in an automated fashion, making all content permanent and never removable, but I do think people should be able to decide for themselves and effectively archive specific content that they care about.
+        
+        ## Comparison to Other Projects
+        
+        ▶ **Check out our [community page](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community) for an index of web archiving initiatives and projects.**
+        
+        <img src="https://i.imgur.com/4nkFjdv.png" width="10%" align="left"/> The aim of ArchiveBox is to go beyond what the Wayback Machine and other public archiving services can do, by adding a headless browser to replay sessions accurately, and by automatically extracting all the content in multiple redundant formats that will survive being passed down to historians and archivists through many generations.
+        
+        #### User Interface & Intended Purpose
+        
+        ArchiveBox differentiates itself from [similar projects](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community#Web-Archiving-Projects) by being a simple, one-shot CLI interface for users to ingest bulk feeds of URLs over extended periods, as opposed to being a backend service that ingests individual, manually-submitted URLs from a web UI. However, we also have the option to add urls via a web interface through our Django frontend.
+        
+        #### Private Local Archives vs Centralized Public Archives
+        
+        Unlike crawler software that starts from a seed URL and works outwards, or public tools like Archive.org designed for users to manually submit links from the public internet, ArchiveBox tries to be a set-and-forget archiver suitable for archiving your entire browsing history, RSS feeds, or bookmarks, ~~including private/authenticated content that you wouldn't otherwise share with a centralized service~~ (do not do this until v0.5 is released with some security fixes). Also by having each user store their own content locally, we can save much larger portions of everyone's browsing history than a shared centralized service would be able to handle.
+        
+        #### Storage Requirements
+        
+        Because ArchiveBox is designed to ingest a firehose of browser history and bookmark feeds to a local disk, it can be much more disk-space intensive than a centralized service like the Internet Archive or Archive.today. However, as storage space gets cheaper and compression improves, you should be able to use it continuously over the years without having to delete anything. In my experience, ArchiveBox uses about 5gb per 1000 articles, but your milage may vary depending on which options you have enabled and what types of sites you're archiving. By default, it archives everything in as many formats as possible, meaning it takes more space than a using a single method, but more content is accurately replayable over extended periods of time. Storage requirements can be reduced by using a compressed/deduplicated filesystem like ZFS/BTRFS, or by setting `SAVE_MEDIA=False` to skip audio & video files.
+        
+        ## Learn more
+        
+        <!--▶ **Join out our [community chat](http://webchat.freenode.net?channels=ArchiveBox&uio=d4) hosted on IRC freenode.net:`#ArchiveBox`!**-->
+        
+        Whether you want to learn which organizations are the big players in the web archiving space, want to find a specific open-source tool for your web archiving need, or just want to see where archivists hang out online, our Community Wiki page serves as an index of the broader web archiving community. Check it out to learn about some of the coolest web archiving projects and communities on the web!
+        
+        <img src="https://i.imgur.com/0ZOmOvN.png" width="14%" align="right"/>
+        
+        - [Community Wiki](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community)
+          - [The Master Lists](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community#The-Master-Lists)  
+            _Community-maintained indexes of archiving tools and institutions._
+          - [Web Archiving Software](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community#Web-Archiving-Projects)  
+            _Open source tools and projects in the internet archiving space._
+          - [Reading List](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community#Reading-List)  
+            _Articles, posts, and blogs relevant to ArchiveBox and web archiving in general._
+          - [Communities](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community#Communities)  
+            _A collection of the most active internet archiving communities and initiatives._
+        - Check out the ArchiveBox [Roadmap](https://github.com/pirate/ArchiveBox/wiki/Roadmap) and [Changelog](https://github.com/pirate/ArchiveBox/wiki/Changelog)
+        - Learn why archiving the internet is important by reading the "[On the Importance of Web Archiving](https://parameters.ssrc.org/2018/09/on-the-importance-of-web-archiving/)" blog post.
+        - Or reach out to me for questions and comments via [@theSquashSH](https://twitter.com/thesquashSH) on Twitter.
+        
+        ---
+        
+        # Documentation
+        
+        <img src="https://read-the-docs-guidelines.readthedocs-hosted.com/_images/logo-dark.png" width="13%" align="right"/>
+        
+        We use the [Github wiki system](https://github.com/pirate/ArchiveBox/wiki) and [Read the Docs](https://archivebox.readthedocs.io/en/latest/) for documentation.
+        
+        You can also access the docs locally by looking in the [`ArchiveBox/docs/`](https://github.com/pirate/ArchiveBox/wiki/Home) folder.
+        
+        You can build the docs by running:
+        
+        ```python
+        cd ArchiveBox
+        pipenv install --dev
+        sphinx-apidoc -o docs archivebox
+        cd docs/
+        make html
+        # then open docs/_build/html/index.html
+        ```
+        
+        ## Getting Started
+        
+        - [Quickstart](https://github.com/pirate/ArchiveBox/wiki/Quickstart)
+        - [Install](https://github.com/pirate/ArchiveBox/wiki/Install)
+        - [Docker](https://github.com/pirate/ArchiveBox/wiki/Docker)
+        
+        ## Reference
+        
+        - [Usage](https://github.com/pirate/ArchiveBox/wiki/Usage)
+        - [Configuration](https://github.com/pirate/ArchiveBox/wiki/Configuration)
+        - [Supported Sources](https://github.com/pirate/ArchiveBox/wiki/Quickstart#2-get-your-list-of-urls-to-archive)
+        - [Supported Outputs](https://github.com/pirate/ArchiveBox/wiki#can-save-these-things-for-each-site)
+        - [Scheduled Archiving](https://github.com/pirate/ArchiveBox/wiki/Scheduled-Archiving)
+        - [Publishing Your Archive](https://github.com/pirate/ArchiveBox/wiki/Publishing-Your-Archive)
+        - [Chromium Install](https://github.com/pirate/ArchiveBox/wiki/Install-Chromium)
+        - [Security Overview](https://github.com/pirate/ArchiveBox/wiki/Security-Overview)
+        - [Troubleshooting](https://github.com/pirate/ArchiveBox/wiki/Troubleshooting)
+        
+        ## More Info
+        
+        - [Roadmap](https://github.com/pirate/ArchiveBox/wiki/Roadmap)
+        - [Changelog](https://github.com/pirate/ArchiveBox/wiki/Changelog)
+        - [Donations](https://github.com/pirate/ArchiveBox/wiki/Donations)
+        - [Background & Motivation](https://github.com/pirate/ArchiveBox#background--motivation)
+        - [Web Archiving Community](https://github.com/pirate/ArchiveBox/wiki/Web-Archiving-Community)
+        
+        ---
+        
+        <div align="center">
+        <br/><br/>
+        <img src="https://raw.githubusercontent.com/Monadical-SAS/redux-time/HEAD/examples/static/jeremy.jpg" height="40px"/>
+        <br/>
+        <sub><i>This project is maintained mostly in <a href="https://nicksweeting.com/blog#About">my spare time</a> with the help from generous contributors and Monadical.com.</i></sub>
+        <br/><br/>
+        
+        <br/>
+        <a href="https://github.com/sponsors/pirate">Sponsor us on Github</a>
+        <br>
+        <br>
+        <a href="https://www.patreon.com/theSquashSH"><img src="https://img.shields.io/badge/Donate_to_support_development-via_Patreon-%23DD5D76.svg?style=flat"/></a>
+        <br/>
+        
+        <a href="https://twitter.com/thesquashSH"><img src="https://img.shields.io/badge/Tweet-%40theSquashSH-blue.svg?style=flat"/></a>
+        <a href="https://github.com/pirate/ArchiveBox"><img src="https://img.shields.io/github/stars/pirate/ArchiveBox.svg?style=flat&label=Star+on+Github"/></a>
+        
+        <br/><br/>
+        
+        </div>
+        
+Platform: UNKNOWN
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Utilities
+Classifier: Topic :: System :: Archiving
+Classifier: Topic :: System :: Archiving :: Backup
+Classifier: Topic :: System :: Recovery Tools
+Classifier: Topic :: Sociology :: History
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Server
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Legal Industry
+Classifier: Intended Audience :: System Administrators
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Framework :: Django
+Classifier: Typing :: Typed
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Provides-Extra: dev

archivebox.egg-info/SOURCES.txt

@@ -0,0 +1,126 @@
+LICENSE
+MANIFEST.in
+README.md
+package-lock.json
+package.json
+setup.py
+archivebox/__init__.py
+archivebox/__main__.py
+archivebox/logging_util.py
+archivebox/main.py
+archivebox/manage.py
+archivebox/system.py
+archivebox/util.py
+archivebox.egg-info/PKG-INFO
+archivebox.egg-info/SOURCES.txt
+archivebox.egg-info/dependency_links.txt
+archivebox.egg-info/entry_points.txt
+archivebox.egg-info/requires.txt
+archivebox.egg-info/top_level.txt
+archivebox/cli/__init__.py
+archivebox/cli/archivebox_add.py
+archivebox/cli/archivebox_config.py
+archivebox/cli/archivebox_help.py
+archivebox/cli/archivebox_init.py
+archivebox/cli/archivebox_list.py
+archivebox/cli/archivebox_manage.py
+archivebox/cli/archivebox_oneshot.py
+archivebox/cli/archivebox_remove.py
+archivebox/cli/archivebox_schedule.py
+archivebox/cli/archivebox_server.py
+archivebox/cli/archivebox_shell.py
+archivebox/cli/archivebox_status.py
+archivebox/cli/archivebox_update.py
+archivebox/cli/archivebox_version.py
+archivebox/cli/tests.py
+archivebox/config/__init__.py
+archivebox/config/stubs.py
+archivebox/core/__init__.py
+archivebox/core/admin.py
+archivebox/core/apps.py
+archivebox/core/forms.py
+archivebox/core/models.py
+archivebox/core/settings.py
+archivebox/core/tests.py
+archivebox/core/urls.py
+archivebox/core/views.py
+archivebox/core/welcome_message.py
+archivebox/core/wsgi.py
+archivebox/core/migrations/0001_initial.py
+archivebox/core/migrations/0002_auto_20200625_1521.py
+archivebox/core/migrations/0003_auto_20200630_1034.py
+archivebox/core/migrations/0004_auto_20200713_1552.py
+archivebox/core/migrations/0005_auto_20200728_0326.py
+archivebox/core/migrations/__init__.py
+archivebox/extractors/__init__.py
+archivebox/extractors/archive_org.py
+archivebox/extractors/dom.py
+archivebox/extractors/favicon.py
+archivebox/extractors/git.py
+archivebox/extractors/media.py
+archivebox/extractors/pdf.py
+archivebox/extractors/readability.py
+archivebox/extractors/screenshot.py
+archivebox/extractors/singlefile.py
+archivebox/extractors/title.py
+archivebox/extractors/wget.py
+archivebox/index/__init__.py
+archivebox/index/csv.py
+archivebox/index/html.py
+archivebox/index/json.py
+archivebox/index/schema.py
+archivebox/index/sql.py
+archivebox/parsers/__init__.py
+archivebox/parsers/generic_html.py
+archivebox/parsers/generic_json.py
+archivebox/parsers/generic_rss.py
+archivebox/parsers/generic_txt.py
+archivebox/parsers/medium_rss.py
+archivebox/parsers/netscape_html.py
+archivebox/parsers/pinboard_rss.py
+archivebox/parsers/pocket_html.py
+archivebox/parsers/shaarli_rss.py
+archivebox/themes/admin/actions_as_select.html
+archivebox/themes/admin/app_index.html
+archivebox/themes/admin/base.html
+archivebox/themes/admin/login.html
+archivebox/themes/default/add_links.html
+archivebox/themes/default/main_index.html
+archivebox/themes/default/static/admin.css
+archivebox/themes/default/static/archive.png
+archivebox/themes/default/static/bootstrap.min.css
+archivebox/themes/default/static/external.png
+archivebox/themes/default/static/jquery.dataTables.min.css
+archivebox/themes/default/static/jquery.dataTables.min.js
+archivebox/themes/default/static/jquery.min.js
+archivebox/themes/default/static/sort_asc.png
+archivebox/themes/default/static/sort_both.png
+archivebox/themes/default/static/sort_desc.png
+archivebox/themes/default/static/spinner.gif
+archivebox/themes/legacy/favicon.ico
+archivebox/themes/legacy/link_details.html
+archivebox/themes/legacy/main_index.html
+archivebox/themes/legacy/main_index_row.html
+archivebox/themes/legacy/robots.txt
+archivebox/themes/legacy/static/archive.png
+archivebox/themes/legacy/static/bootstrap.min.css
+archivebox/themes/legacy/static/external.png
+archivebox/themes/legacy/static/jquery.dataTables.min.css
+archivebox/themes/legacy/static/jquery.dataTables.min.js
+archivebox/themes/legacy/static/jquery.min.js
+archivebox/themes/legacy/static/sort_asc.png
+archivebox/themes/legacy/static/sort_both.png
+archivebox/themes/legacy/static/sort_desc.png
+archivebox/themes/legacy/static/spinner.gif
+tests/__init__.py
+tests/conftest.py
+tests/fixtures.py
+tests/test_args.py
+tests/test_extractors.py
+tests/test_init.py
+tests/test_oneshot.py
+tests/test_remove.py
+tests/test_title.py
+tests/test_util.py
+tests/mock_server/__init__.py
+tests/mock_server/server.py

archivebox.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

archivebox.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+archivebox = archivebox.cli:main
+

archivebox.egg-info/requires.txt

@@ -0,0 +1,26 @@
+requests==2.24.0
+atomicwrites==1.4.0
+mypy-extensions==0.4.3
+base32-crockford==0.3.0
+django==3.0.8
+django-extensions==3.0.3
+dateparser
+ipython
+youtube-dl
+python-crontab==2.5.1
+croniter==0.3.34
+w3lib==1.22.0
+
+[dev]
+setuptools
+wheel
+twine
+flake8
+ipdb
+mypy
+django-stubs
+sphinx
+sphinx-rtd-theme
+recommonmark
+pytest
+bottle

archivebox.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+archivebox
+tests

archivebox/VERSION

@@ -1 +0,0 @@
-0.4.13

archivebox/cli/archivebox_add.py

@@ -55,6 +55,17 @@ def main(args: Optional[List[str]]=None, stdin: Optional[IO]=None, pwd: Optional
         type=int,
         help="Recursively archive all linked pages up to this many hops away"
     )
+    parser.add_argument(
+        "--overwrite",
+        default=False,
+        action="store_true",
+        help="Re-archive URLs from scratch, overwriting any existing files"
+    )
+    parser.add_argument(
+        '--init', #'-i',
+        action='store_true',
+        help="Init/upgrade the curent data directory before adding",
+    )
     command = parser.parse_args(args or ())
     urls = command.urls
     stdin_urls = accept_stdin(stdin)
@@ -69,6 +80,8 @@ def main(args: Optional[List[str]]=None, stdin: Optional[IO]=None, pwd: Optional
         depth=command.depth,
         update_all=command.update_all,
         index_only=command.index_only,
+        overwrite=command.overwrite,
+        init=command.init,
         out_dir=pwd or OUTPUT_DIR,
     )
 

archivebox/cli/archivebox_schedule.py

@@ -36,8 +36,14 @@ def main(args: Optional[List[str]]=None, stdin: Optional[IO]=None, pwd: Optional
     parser.add_argument(
         '--every', # '-e',
         type=str,
-        default='day',
-        help='Run ArchiveBox once every [timeperiod] (hour/day/week/month/year or cron format e.g. "0 0 * * *")',
+        default=None,
+        help='Run ArchiveBox once every [timeperiod] (hour/day/month/year or cron format e.g. "0 0 * * *")',
+    )
+    parser.add_argument(
+        '--depth', # '-d',
+        type=int,
+        default=0,
+        help='Depth to archive to [0] or 1, see "add" command help for more info.',
     )
     group.add_argument(
         '--clear', # '-c'
@@ -80,6 +86,7 @@ def main(args: Optional[List[str]]=None, stdin: Optional[IO]=None, pwd: Optional
         run_all=command.run_all,
         quiet=command.quiet,
         every=command.every,
+        depth=command.depth,
         import_path=command.import_path,
         out_dir=pwd or OUTPUT_DIR,
     )

archivebox/cli/archivebox_server.py

@@ -10,10 +10,9 @@ from typing import Optional, List, IO
 
 from ..main import server
 from ..util import docstring
-from ..config import OUTPUT_DIR
+from ..config import OUTPUT_DIR, BIND_ADDR
 from ..logging_util import SmartFormatter, reject_stdin
 
-
 @docstring(server.__doc__)
 def main(args: Optional[List[str]]=None, stdin: Optional[IO]=None, pwd: Optional[str]=None) -> None:
     parser = argparse.ArgumentParser(
@@ -26,7 +25,7 @@ def main(args: Optional[List[str]]=None, stdin: Optional[IO]=None, pwd: Optional
         'runserver_args',
         nargs='*',
         type=str,
-        default=None,
+        default=[BIND_ADDR],
         help='Arguments to pass to Django runserver'
     )
     parser.add_argument(

archivebox/config/__init__.py

@@ -4,13 +4,15 @@ import os
 import io
 import re
 import sys
-import django
+import json
 import getpass
 import shutil
+import platform
+import django
 
 from hashlib import md5
 from pathlib import Path
-from typing import Optional, Type, Tuple, Dict
+from typing import Optional, Type, Tuple, Dict, Union, List
 from subprocess import run, PIPE, DEVNULL
 from configparser import ConfigParser
 from collections import defaultdict
@@ -44,7 +46,7 @@ CONFIG_DEFAULTS: Dict[str, ConfigDefaultDict] = {
     'SHELL_CONFIG': {
         'IS_TTY':                   {'type': bool,  'default': lambda _: sys.stdout.isatty()},
         'USE_COLOR':                {'type': bool,  'default': lambda c: c['IS_TTY']},
-        'SHOW_PROGRESS':            {'type': bool,  'default': lambda c: c['IS_TTY']},
+        'SHOW_PROGRESS':            {'type': bool,  'default': lambda c: False if platform.system() == 'Darwin' else c['IS_TTY']},  # TODO: remove this temporary hack once progress bars are fixed on macOS
         'IN_DOCKER':                {'type': bool,  'default': False},
         # TODO: 'SHOW_HINTS':       {'type:  bool,  'default': True},
     },
@@ -57,11 +59,12 @@ CONFIG_DEFAULTS: Dict[str, ConfigDefaultDict] = {
         'MEDIA_TIMEOUT':            {'type': int,   'default': 3600},
         'OUTPUT_PERMISSIONS':       {'type': str,   'default': '755'},
         'RESTRICT_FILE_NAMES':      {'type': str,   'default': 'windows'},
-        'URL_BLACKLIST':            {'type': str,   'default': None},
+        'URL_BLACKLIST':            {'type': str,   'default': r'\.(css|js|otf|ttf|woff|woff2)(\?.*)?$'},  # to avoid downloading code assets as their own pages
     },
 
     'SERVER_CONFIG': {
         'SECRET_KEY':               {'type': str,   'default': None},
+        'BIND_ADDR':                {'type': str,   'default': lambda c: ['127.0.0.1:8000', '0.0.0.0:8000'][c['IN_DOCKER']]},
         'ALLOWED_HOSTS':            {'type': str,   'default': '*'},
         'DEBUG':                    {'type': bool,  'default': False},
         'PUBLIC_INDEX':             {'type': bool,  'default': True},
@@ -76,6 +79,7 @@ CONFIG_DEFAULTS: Dict[str, ConfigDefaultDict] = {
         'SAVE_WGET':                {'type': bool,  'default': True, 'aliases': ('FETCH_WGET',)},
         'SAVE_WGET_REQUISITES':     {'type': bool,  'default': True, 'aliases': ('FETCH_WGET_REQUISITES',)},
         'SAVE_SINGLEFILE':          {'type': bool,  'default': True, 'aliases': ('FETCH_SINGLEFILE',)},
+        'SAVE_READABILITY':         {'type': bool,  'default': True, 'aliases': ('FETCH_READABILITY',)},
         'SAVE_PDF':                 {'type': bool,  'default': True, 'aliases': ('FETCH_PDF',)},
         'SAVE_SCREENSHOT':          {'type': bool,  'default': True, 'aliases': ('FETCH_SCREENSHOT',)},
         'SAVE_DOM':                 {'type': bool,  'default': True, 'aliases': ('FETCH_DOM',)},
@@ -99,14 +103,14 @@ CONFIG_DEFAULTS: Dict[str, ConfigDefaultDict] = {
         'CHROME_USER_DATA_DIR':     {'type': str,   'default': None},
 
         'CHROME_HEADLESS':          {'type': bool,  'default': True},
-        'CHROME_SANDBOX':           {'type': bool,  'default': True},
-
+        'CHROME_SANDBOX':           {'type': bool,  'default': lambda c: not c['IN_DOCKER']},
     },
 
     'DEPENDENCY_CONFIG': {
         'USE_CURL':                 {'type': bool,  'default': True},
         'USE_WGET':                 {'type': bool,  'default': True},
         'USE_SINGLEFILE':           {'type': bool,  'default': True},
+        'USE_READABILITY':          {'type': bool,  'default': True},
         'USE_GIT':                  {'type': bool,  'default': True},
         'USE_CHROME':               {'type': bool,  'default': True},
         'USE_YOUTUBEDL':            {'type': bool,  'default': True},
@@ -115,6 +119,7 @@ CONFIG_DEFAULTS: Dict[str, ConfigDefaultDict] = {
         'GIT_BINARY':               {'type': str,   'default': 'git'},
         'WGET_BINARY':              {'type': str,   'default': 'wget'},
         'SINGLEFILE_BINARY':        {'type': str,   'default': 'single-file'},
+        'READABILITY_BINARY':       {'type': str,   'default': 'readability-extractor'},
         'YOUTUBEDL_BINARY':         {'type': str,   'default': 'youtube-dl'},
         'CHROME_BINARY':            {'type': str,   'default': None},
     },
@@ -181,7 +186,6 @@ STATICFILE_EXTENSIONS = {
     # html, htm, shtml, xhtml, xml, aspx, php, cgi
 }
 
-VERSION_FILENAME = 'VERSION'
 PYTHON_DIR_NAME = 'archivebox'
 TEMPLATES_DIR_NAME = 'themes'
 
@@ -227,10 +231,10 @@ DERIVED_CONFIG_DEFAULTS: ConfigDefaultDict = {
     'CONFIG_FILE':              {'default': lambda c: os.path.abspath(os.path.expanduser(c['CONFIG_FILE'])) if c['CONFIG_FILE'] else os.path.join(c['OUTPUT_DIR'], CONFIG_FILENAME)},
     'COOKIES_FILE':             {'default': lambda c: c['COOKIES_FILE'] and os.path.abspath(os.path.expanduser(c['COOKIES_FILE']))},
     'CHROME_USER_DATA_DIR':     {'default': lambda c: find_chrome_data_dir() if c['CHROME_USER_DATA_DIR'] is None else (os.path.abspath(os.path.expanduser(c['CHROME_USER_DATA_DIR'])) or None)},
-    'URL_BLACKLIST_PTN':        {'default': lambda c: c['URL_BLACKLIST'] and re.compile(c['URL_BLACKLIST'], re.IGNORECASE)},
+    'URL_BLACKLIST_PTN':        {'default': lambda c: c['URL_BLACKLIST'] and re.compile(c['URL_BLACKLIST'] or '', re.IGNORECASE | re.UNICODE | re.MULTILINE)},
 
     'ARCHIVEBOX_BINARY':        {'default': lambda c: sys.argv[0]},
-    'VERSION':                  {'default': lambda c: open(os.path.join(c['PYTHON_DIR'], VERSION_FILENAME), 'r').read().strip()},
+    'VERSION':                  {'default': lambda c: json.loads((Path(c['REPO_DIR']) / 'package.json').read_text().strip())['version']},
     'GIT_SHA':                  {'default': lambda c: c['VERSION'].split('+')[-1] or 'unknown'},
 
     'PYTHON_BINARY':            {'default': lambda c: sys.executable},
@@ -256,6 +260,9 @@ DERIVED_CONFIG_DEFAULTS: ConfigDefaultDict = {
     'USE_SINGLEFILE':           {'default': lambda c: c['USE_SINGLEFILE'] and c['SAVE_SINGLEFILE']},
     'SINGLEFILE_VERSION':       {'default': lambda c: bin_version(c['SINGLEFILE_BINARY']) if c['USE_SINGLEFILE'] else None},
 
+    'USE_READABILITY':          {'default': lambda c: c['USE_READABILITY'] and c['SAVE_READABILITY']},
+    'READABILITY_VERSION':      {'default': lambda c: bin_version(c['READABILITY_BINARY']) if c['USE_READABILITY'] else None},
+
     'USE_GIT':                  {'default': lambda c: c['USE_GIT'] and c['SAVE_GIT']},
     'GIT_VERSION':              {'default': lambda c: bin_version(c['GIT_BINARY']) if c['USE_GIT'] else None},
     'SAVE_GIT':                 {'default': lambda c: c['USE_GIT'] and c['SAVE_GIT']},
@@ -272,6 +279,7 @@ DERIVED_CONFIG_DEFAULTS: ConfigDefaultDict = {
     'SAVE_SCREENSHOT':          {'default': lambda c: c['USE_CHROME'] and c['SAVE_SCREENSHOT']},
     'SAVE_DOM':                 {'default': lambda c: c['USE_CHROME'] and c['SAVE_DOM']},
     'SAVE_SINGLEFILE':          {'default': lambda c: c['USE_CHROME'] and c['USE_SINGLEFILE']},
+    'SAVE_READABILITY':         {'default': lambda c: c['USE_READABILITY']},
 
     'DEPENDENCIES':             {'default': lambda c: get_dependency_info(c)},
     'CODE_LOCATIONS':           {'default': lambda c: get_code_locations(c)},
@@ -461,9 +469,7 @@ def load_config(defaults: ConfigDefaultDict,
 
 #     with open(os.path.join(config['OUTPUT_DIR'], CONFIG_FILENAME), 'w+') as f:
 
-
-
-def stderr(*args, color: Optional[str]=None, config: Optional[ConfigDict]=None) -> None:
+def stdout(*args, color: Optional[str]=None, prefix: str='', config: Optional[ConfigDict]=None) -> None:
     ansi = DEFAULT_CLI_COLORS if (config or {}).get('USE_COLOR') else ANSI
 
     if color:
@@ -471,28 +477,49 @@ def stderr(*args, color: Optional[str]=None, config: Optional[ConfigDict]=None)
     else:
         strs = [' '.join(str(a) for a in args), '\n']
 
-    sys.stderr.write(''.join(strs))
+    sys.stdout.write(prefix + ''.join(strs))
+
+def stderr(*args, color: Optional[str]=None, prefix: str='', config: Optional[ConfigDict]=None) -> None:
+    ansi = DEFAULT_CLI_COLORS if (config or {}).get('USE_COLOR') else ANSI
+
+    if color:
+        strs = [ansi[color], ' '.join(str(a) for a in args), ansi['reset'], '\n']
+    else:
+        strs = [' '.join(str(a) for a in args), '\n']
+
+    sys.stderr.write(prefix + ''.join(strs))
+
+def hint(text: Union[Tuple[str, ...], List[str], str], prefix='    ', config: Optional[ConfigDict]=None) -> None:
+    ansi = DEFAULT_CLI_COLORS if (config or {}).get('USE_COLOR') else ANSI
+
+    if isinstance(text, str):
+        stderr('{}{lightred}Hint:{reset} {}'.format(prefix, text, **ansi))
+    else:
+        stderr('{}{lightred}Hint:{reset} {}'.format(prefix, text[0], **ansi))
+        for line in text[1:]:
+            stderr('{}      {}'.format(prefix, line))
+
 
 def bin_version(binary: Optional[str]) -> Optional[str]:
     """check the presence and return valid version line of a specified binary"""
 
     abspath = bin_path(binary)
-    if not abspath:
+    if not binary or not abspath:
         return None
 
     try:
         version_str = run([abspath, "--version"], stdout=PIPE).stdout.strip().decode()
         # take first 3 columns of first line of version info
         return ' '.join(version_str.split('\n')[0].strip().split()[:3])
-    except Exception:
+    except OSError:
+        pass
         # stderr(f'[X] Unable to find working version of dependency: {binary}', color='red')
         # stderr('    Make sure it\'s installed, then confirm it\'s working by running:')
         # stderr(f'        {binary} --version')
         # stderr()
         # stderr('    If you don\'t want to install it, you can disable it via config. See here for more info:')
         # stderr('        https://github.com/pirate/ArchiveBox/wiki/Install')
-        # stderr()
-        return None
+    return None
 
 def bin_path(binary: Optional[str]) -> Optional[str]:
     if binary is None:
@@ -689,6 +716,13 @@ def get_dependency_info(config: ConfigDict) -> ConfigValue:
             'enabled': config['USE_SINGLEFILE'],
             'is_valid': bool(config['SINGLEFILE_VERSION']),
         },
+        'READABILITY_BINARY': {
+            'path': bin_path(config['READABILITY_BINARY']),
+            'version': config['READABILITY_VERSION'],
+            'hash': bin_hash(config['READABILITY_BINARY']),
+            'enabled': config['USE_READABILITY'],
+            'is_valid': bool(config['READABILITY_VERSION']),
+        },
         'GIT_BINARY': {
             'path': bin_path(config['GIT_BINARY']),
             'version': config['GIT_VERSION'],
@@ -738,6 +772,9 @@ def load_all_config():
 CONFIG = load_all_config()
 globals().update(CONFIG)
 
+# Timezone set as UTC
+os.environ["TZ"] = 'UTC'
+
 
 ############################## Importable Checkers #############################
 
@@ -779,29 +816,36 @@ def check_system_config(config: ConfigDict=CONFIG) -> None:
                 stderr('        CHROME_USER_DATA_DIR="{}"'.format(config['CHROME_USER_DATA_DIR'].split('/Default')[0]))
             raise SystemExit(2)
 
-def dependency_additional_info(dependency: str) -> str:
+def print_dependency_additional_info(dependency: str) -> None:
     if dependency == "SINGLEFILE_BINARY":
-        return "Please follow the installation instructions at https://github.com/gildas-lormeau/SingleFile/tree/master/cli and set SINGLEFILE_BINARY or set USE_SINGLEFILE=false"
-    return ""
+        hint(('npm install -g git+https://github.com/gildas-lormeau/SingleFile.git"',
+              'or set SAVE_SINGLEFILE=False to silence this warning',
+              ''))
+    if dependency == "READABILITY_BINARY":
+        hint(('npm install -g git+https://github.com/pirate/readability-extractor.git"',
+              'or set SAVE_READABILITY=False to silence this warning',
+              ''))
 
 
 def check_dependencies(config: ConfigDict=CONFIG, show_help: bool=True) -> None:
-    invalid = [
-        '{}: {} ({}). {}'.format(name, info['path'] or 'unable to find binary', info['version'] or 'unable to detect version',
-                                 dependency_additional_info(name))
-        for name, info in config['DEPENDENCIES'].items()
+    invalid_dependencies = [
+        (name, info) for name, info in config['DEPENDENCIES'].items()
         if info['enabled'] and not info['is_valid']
     ]
-
-    if invalid:
-        stderr('[X] Missing some required dependencies.', color='red')
-        stderr()
-        stderr('    {}'.format('\n    '.join(invalid)))
-        if show_help:
-            stderr()
-            stderr('    To get more info on dependency status run:')
-            stderr('        archivebox --version')
-        raise SystemExit(2)
+    if invalid_dependencies and show_help:
+        stderr(f'[!] Warning: Missing {len(invalid_dependencies)} recommended dependencies', color='lightyellow')
+        for dependency, info in invalid_dependencies:
+            stderr(
+                '    ! {}: {} ({})'.format(
+                    dependency,
+                    info['path'] or 'unable to find binary',
+                    info['version'] or 'unable to detect version',
+                )
+            )
+            print_dependency_additional_info(dependency)
+        stderr('    {lightred}Hint:{reset} To get more info on dependencies run:'.format(**ANSI))
+        stderr('          archivebox --version')
+        stderr('')
 
     if config['TIMEOUT'] < 5:
         stderr()

archivebox/config/stubs.py

@@ -40,6 +40,7 @@ class ConfigDict(BaseConfig, total=False):
     URL_BLACKLIST: Optional[str]
 
     SECRET_KEY: str
+    BIND_ADDR: str
     ALLOWED_HOSTS: str
     DEBUG: bool
     PUBLIC_INDEX: bool

archivebox/core/admin.py

@@ -33,7 +33,7 @@ def update_titles(modeladmin, request, queryset):
     archive_links([
         snapshot.as_link()
         for snapshot in queryset
-    ], overwrite=True, methods=('title',), out_dir=OUTPUT_DIR)
+    ], overwrite=True, methods=('title','favicon'), out_dir=OUTPUT_DIR)
 update_titles.short_description = "Pull title"
 
 def overwrite_snapshots(modeladmin, request, queryset):
@@ -58,9 +58,9 @@ delete_snapshots.short_description = "Delete"
 class SnapshotAdmin(admin.ModelAdmin):
     list_display = ('added', 'title_str', 'url_str', 'files', 'size')
     sort_fields = ('title_str', 'url_str', 'added')
-    readonly_fields = ('id', 'url', 'timestamp', 'num_outputs', 'is_archived', 'url_hash', 'added', 'updated')
+    readonly_fields = ('id', 'url', 'timestamp', 'title', 'tags', 'num_outputs', 'is_archived', 'url_hash', 'added', 'updated')
     search_fields = ('url', 'timestamp', 'title', 'tags')
-    fields = ('title', 'tags', *readonly_fields)
+    fields = (*readonly_fields,)
     list_filter = ('added', 'updated', 'tags')
     ordering = ['-added']
     actions = [delete_snapshots, overwrite_snapshots, update_snapshots, update_titles, verify_snapshots]
@@ -82,12 +82,12 @@ class SnapshotAdmin(admin.ModelAdmin):
             '<a href="/{}">'
                 '<img src="/{}/{}" class="favicon" onerror="this.remove()">'
             '</a>'
-            '<a href="/{}/{}">'
+            '<a href="/{}/index.html">'
                 '<b class="status-{}">{}</b>'
             '</a>',
             obj.archive_path,
             obj.archive_path, canon['favicon_path'],
-            obj.archive_path, canon['wget_path'] or '',
+            obj.archive_path,
             'fetched' if obj.latest_title or obj.title else 'pending',
             urldecode(htmldecode(obj.latest_title or obj.title or ''))[:128] or 'Pending...'
         ) + mark_safe(f'<span class="tags">{tags}</span>')

archivebox/extractors/__init__.py

@@ -26,6 +26,7 @@ from .title import should_save_title, save_title
 from .favicon import should_save_favicon, save_favicon
 from .wget import should_save_wget, save_wget
 from .singlefile import should_save_singlefile, save_singlefile
+from .readability import should_save_readability, save_readability
 from .pdf import should_save_pdf, save_pdf
 from .screenshot import should_save_screenshot, save_screenshot
 from .dom import should_save_dom, save_dom
@@ -35,17 +36,18 @@ from .archive_org import should_save_archive_dot_org, save_archive_dot_org
 
 def get_default_archive_methods():
     return [
-            ('title', should_save_title, save_title),
-            ('favicon', should_save_favicon, save_favicon),
-            ('wget', should_save_wget, save_wget),
-            ('singlefile', should_save_singlefile, save_singlefile),
-            ('pdf', should_save_pdf, save_pdf),
-            ('screenshot', should_save_screenshot, save_screenshot),
-            ('dom', should_save_dom, save_dom),
-            ('git', should_save_git, save_git),
-            ('media', should_save_media, save_media),
-            ('archive_org', should_save_archive_dot_org, save_archive_dot_org),
-        ]
+        ('title', should_save_title, save_title),
+        ('favicon', should_save_favicon, save_favicon),
+        ('wget', should_save_wget, save_wget),
+        ('singlefile', should_save_singlefile, save_singlefile),
+        ('pdf', should_save_pdf, save_pdf),
+        ('screenshot', should_save_screenshot, save_screenshot),
+        ('dom', should_save_dom, save_dom),
+        ('readability', should_save_readability, save_readability), #keep readability below wget and singlefile, as it depends on them
+        ('git', should_save_git, save_git),
+        ('media', should_save_media, save_media),
+        ('archive_org', should_save_archive_dot_org, save_archive_dot_org),
+    ]
 
 @enforce_types
 def ignore_methods(to_ignore: List[str]):
@@ -60,10 +62,10 @@ def archive_link(link: Link, overwrite: bool=False, methods: Optional[Iterable[s
 
     ARCHIVE_METHODS = get_default_archive_methods()
     
-    if methods is not None:
+    if methods:
         ARCHIVE_METHODS = [
             method for method in ARCHIVE_METHODS
-            if method[1] in methods
+            if method[0] in methods
         ]
 
     out_dir = out_dir or link.link_dir
@@ -93,6 +95,7 @@ def archive_link(link: Link, overwrite: bool=False, methods: Optional[Iterable[s
                     stats[result.status] += 1
                     log_archive_method_finished(result)
                 else:
+                    # print('{black}      X {}{reset}'.format(method_name, **ANSI))
                     stats['skipped'] += 1
             except Exception as e:
                 raise Exception('Exception in archive_methods.save_{}(Link(url={}))'.format(

archivebox/extractors/readability.py

@@ -0,0 +1,115 @@
+__package__ = 'archivebox.extractors'
+
+from pathlib import Path
+from tempfile import NamedTemporaryFile
+
+from typing import Optional
+import json
+
+from ..index.schema import Link, ArchiveResult, ArchiveError
+from ..system import run, atomic_write
+from ..util import (
+    enforce_types,
+    download_url,
+    is_static_file,
+    
+)
+from ..config import (
+    TIMEOUT,
+    SAVE_READABILITY,
+    READABILITY_BINARY,
+    READABILITY_VERSION,
+)
+from ..logging_util import TimedProgress
+
+@enforce_types
+def get_html(link: Link, path: Path) -> str:
+    """
+    Try to find wget, singlefile and then dom files.
+    If none is found, download the url again.
+    """
+    canonical = link.canonical_outputs()
+    abs_path = path.absolute()
+    sources = [canonical["singlefile_path"], canonical["wget_path"], canonical["dom_path"]]
+    document = None
+    for source in sources:
+        try:
+            with open(abs_path / source, "r") as f:
+                document = f.read()
+                break
+        except (FileNotFoundError, TypeError):
+            continue
+    if document is None:
+        return download_url(link.url)
+    else:
+        return document
+
+@enforce_types
+def should_save_readability(link: Link, out_dir: Optional[str]=None) -> bool:
+    out_dir = out_dir or link.link_dir
+    if is_static_file(link.url):
+        return False
+
+    output = Path(out_dir or link.link_dir) / 'readability'
+    return SAVE_READABILITY and READABILITY_VERSION and (not output.exists())
+
+
+@enforce_types
+def save_readability(link: Link, out_dir: Optional[str]=None, timeout: int=TIMEOUT) -> ArchiveResult:
+    """download reader friendly version using @mozilla/readability"""
+
+    out_dir = Path(out_dir or link.link_dir)
+    output_folder = out_dir.absolute() / "readability"
+    output = str(output_folder)
+
+    # Readability Docs: https://github.com/mozilla/readability
+
+    status = 'succeeded'
+    timer = TimedProgress(timeout, prefix='      ')
+    try:
+        document = get_html(link, out_dir)
+        temp_doc = NamedTemporaryFile(delete=False)
+        temp_doc.write(document.encode("utf-8"))
+        temp_doc.close()
+
+        cmd = [
+            READABILITY_BINARY,
+            temp_doc.name
+        ]
+
+        result = run(cmd, cwd=out_dir, timeout=timeout)
+        result_json = json.loads(result.stdout)
+        output_folder.mkdir(exist_ok=True)
+        atomic_write(str(output_folder / "content.html"), result_json.pop("content"))
+        atomic_write(str(output_folder / "content.txt"), result_json.pop("textContent"))
+        atomic_write(str(output_folder / "article.json"), result_json)
+
+        # parse out number of files downloaded from last line of stderr:
+        #  "Downloaded: 76 files, 4.0M in 1.6s (2.52 MB/s)"
+        output_tail = [
+            line.strip()
+            for line in (result.stdout + result.stderr).decode().rsplit('\n', 3)[-3:]
+            if line.strip()
+        ]
+        hints = (
+            'Got readability response code: {}.'.format(result.returncode),
+            *output_tail,
+        )
+
+        # Check for common failure cases
+        if (result.returncode > 0):
+            raise ArchiveError('Readability was not able to archive the page', hints)
+    except Exception as err:
+        status = 'failed'
+        output = err
+    finally:
+        timer.end()
+
+    return ArchiveResult(
+        cmd=cmd,
+        pwd=str(out_dir),
+        cmd_version=READABILITY_VERSION,
+        output=output,
+        status=status,
+        **timer.stats,
+    )

archivebox/extractors/singlefile.py

@@ -29,7 +29,7 @@ def should_save_singlefile(link: Link, out_dir: Optional[str]=None) -> bool:
         return False
 
     output = Path(out_dir or link.link_dir) / 'singlefile.html'
-    return SAVE_SINGLEFILE and (not output.exists())
+    return SAVE_SINGLEFILE and SINGLEFILE_VERSION and (not output.exists())
 
 
 @enforce_types

archivebox/index/__init__.py

@@ -9,6 +9,7 @@ from itertools import chain
 from typing import List, Tuple, Dict, Optional, Iterable
 from collections import OrderedDict
 from contextlib import contextmanager
+from urllib.parse import urlparse
 
 from ..system import atomic_write
 from ..util import (
@@ -62,7 +63,7 @@ def merge_links(a: Link, b: Link) -> Link:
     """deterministially merge two links, favoring longer field values over shorter,
     and "cleaner" values over worse ones.
     """
-    assert a.base_url == b.base_url, 'Cannot merge two links with different URLs'
+    assert a.base_url == b.base_url, f'Cannot merge two links with different URLs ({a.base_url} != {b.base_url})'
 
     # longest url wins (because a fuzzy url will always be shorter)
     url = a.url if len(a.url) > len(b.url) else b.url
@@ -128,7 +129,7 @@ def validate_links(links: Iterable[Link]) -> List[Link]:
     try:
         links = archivable_links(links)  # remove chrome://, about:, mailto: etc.
         links = sorted_links(links)      # deterministically sort the links based on timstamp, url
-        links = uniquefied_links(links)  # merge/dedupe duplicate timestamps & urls
+        links = fix_duplicate_links(links)  # merge/dedupe duplicate timestamps & urls
     finally:
         timer.end()
 
@@ -139,34 +140,43 @@ def validate_links(links: Iterable[Link]) -> List[Link]:
 def archivable_links(links: Iterable[Link]) -> Iterable[Link]:
     """remove chrome://, about:// or other schemed links that cant be archived"""
     for link in links:
-        scheme_is_valid = scheme(link.url) in ('http', 'https', 'ftp')
-        not_blacklisted = (not URL_BLACKLIST_PTN.match(link.url)) if URL_BLACKLIST_PTN else True
-        if scheme_is_valid and not_blacklisted:
-            yield link
+        try:
+            urlparse(link.url)
+        except ValueError:
+            continue
+        if scheme(link.url) not in ('http', 'https', 'ftp'):
+            continue
+        if URL_BLACKLIST_PTN and URL_BLACKLIST_PTN.search(link.url):
+            continue
+
+        yield link
 
 
 @enforce_types
-def uniquefied_links(sorted_links: Iterable[Link]) -> Iterable[Link]:
+def fix_duplicate_links(sorted_links: Iterable[Link]) -> Iterable[Link]:
     """
     ensures that all non-duplicate links have monotonically increasing timestamps
     """
+    # from core.models import Snapshot
 
     unique_urls: OrderedDict[str, Link] = OrderedDict()
 
     for link in sorted_links:
-        if link.base_url in unique_urls:
+        if link.url in unique_urls:
             # merge with any other links that share the same url
-            link = merge_links(unique_urls[link.base_url], link)
-        unique_urls[link.base_url] = link
+            link = merge_links(unique_urls[link.url], link)
+        unique_urls[link.url] = link
 
-    unique_timestamps: OrderedDict[str, Link] = OrderedDict()
-    for link in unique_urls.values():
-        new_link = link.overwrite(
-            timestamp=lowest_uniq_timestamp(unique_timestamps, link.timestamp),
-        )
-        unique_timestamps[new_link.timestamp] = new_link
+    # unique_timestamps: OrderedDict[str, Link] = OrderedDict()
+    # for link in unique_urls.values():
+    #     closest_non_duplicate_ts = lowest_uniq_timestamp(unique_timestamps, link.timestamp)
+    #     if closest_non_duplicate_ts != link.timestamp:
+    #         link = link.overwrite(timestamp=closest_non_duplicate_ts)
+    #         Snapshot.objects.filter(url=link.url).update(timestamp=link.timestamp)
+    #     unique_timestamps[link.timestamp] = link
 
-    return unique_timestamps.values()
+    # return unique_timestamps.values()
+    return unique_urls.values()
 
 
 @enforce_types
@@ -231,16 +241,23 @@ def write_main_index(links: List[Link], out_dir: str=OUTPUT_DIR, finished: bool=
 
     log_indexing_process_started(len(links))
 
-    with timed_index_update(os.path.join(out_dir, SQL_INDEX_FILENAME)):
-        write_sql_main_index(links, out_dir=out_dir)
-        os.chmod(os.path.join(out_dir, SQL_INDEX_FILENAME), int(OUTPUT_PERMISSIONS, base=8)) # set here because we don't write it with atomic writes
+    try:
+        with timed_index_update(os.path.join(out_dir, SQL_INDEX_FILENAME)):
+            write_sql_main_index(links, out_dir=out_dir)
+            os.chmod(os.path.join(out_dir, SQL_INDEX_FILENAME), int(OUTPUT_PERMISSIONS, base=8)) # set here because we don't write it with atomic writes
 
+        with timed_index_update(os.path.join(out_dir, JSON_INDEX_FILENAME)):
+            write_json_main_index(links, out_dir=out_dir)
 
-    with timed_index_update(os.path.join(out_dir, JSON_INDEX_FILENAME)):
-        write_json_main_index(links, out_dir=out_dir)
-
-    with timed_index_update(os.path.join(out_dir, HTML_INDEX_FILENAME)):
-        write_html_main_index(links, out_dir=out_dir, finished=finished)
+        with timed_index_update(os.path.join(out_dir, HTML_INDEX_FILENAME)):
+            write_html_main_index(links, out_dir=out_dir, finished=finished)
+    except (KeyboardInterrupt, SystemExit):
+        stderr('[!] Warning: Still writing index to disk...', color='lightyellow')
+        stderr('    Run archivebox init to fix any inconsisntencies from an ungraceful exit.')
+        with timed_index_update(os.path.join(out_dir, SQL_INDEX_FILENAME)):
+            write_sql_main_index(links, out_dir=out_dir)
+            os.chmod(os.path.join(out_dir, SQL_INDEX_FILENAME), int(OUTPUT_PERMISSIONS, base=8)) # set here because we don't write it with atomic writes
+        raise SystemExit(0)
 
     log_indexing_process_finished()
 
@@ -250,13 +267,29 @@ def load_main_index(out_dir: str=OUTPUT_DIR, warn: bool=True) -> List[Link]:
     """parse and load existing index with any new links from import_path merged in"""
 
     all_links: List[Link] = []
-    all_links = list(parse_json_main_index(out_dir))
-    links_from_sql = list(parse_sql_main_index(out_dir))
+    try:
+        all_links = list(parse_json_main_index(out_dir))
+        links_from_sql = list(parse_sql_main_index(out_dir))
 
-    if warn and not set(l.url for l in all_links) == set(l.url for l in links_from_sql):
-        stderr('{red}[!] Warning: SQL index does not match JSON index!{reset}'.format(**ANSI))
-        stderr('    To repair the index and re-import any orphaned links run:')
-        stderr('        archivebox init')
+        json_urls = set(l.url for l in all_links)
+        sql_urls = set(l.url for l in links_from_sql)
+        only_in_sql = sql_urls - json_urls
+        only_in_json = json_urls - sql_urls
+
+        if only_in_json:
+            stderr('{red}[!] Warning: SQL index does not match JSON index!{reset}'.format(**ANSI))
+            if only_in_json:
+                stderr('    > Only in JSON: {}...'.format(', '.join(list(only_in_json)[:5])))
+            if only_in_sql:
+                stderr('    > Only in SQL: {}...'.format(', '.join(list(only_in_sql)[:5])))
+
+            stderr('    To repair the index and re-import any orphaned links run:')
+            stderr('        archivebox init')
+        if only_in_sql:
+            # meh, this harmless, it'll get overwritten on next run anyway
+            pass
+    except (KeyboardInterrupt, SystemExit):
+        raise SystemExit(0)
 
     return all_links
 
@@ -273,14 +306,14 @@ def load_main_index_meta(out_dir: str=OUTPUT_DIR) -> Optional[dict]:
 
 
 @enforce_types
-def parse_links_from_source(source_path: str) -> Tuple[List[Link], List[Link]]:
+def parse_links_from_source(source_path: str, root_url: Optional[str]=None) -> Tuple[List[Link], List[Link]]:
 
     from ..parsers import parse_links
 
     new_links: List[Link] = []
 
     # parse and validate the import file
-    raw_links, parser_name = parse_links(source_path)
+    raw_links, parser_name = parse_links(source_path, root_url=root_url)
     new_links = validate_links(raw_links)
 
     if parser_name:

archivebox/index/html.py

@@ -8,6 +8,7 @@ from typing import List, Optional, Iterator, Mapping
 
 from .schema import Link
 from ..system import atomic_write, copy_and_overwrite
+from ..logging_util import printable_filesize
 from ..util import (
     enforce_types,
     ts_to_date,
@@ -140,6 +141,7 @@ def link_details_template(link: Link) -> str:
         ) or 'about:blank',
         'extension': link.extension or 'html',
         'tags': link.tags or 'untagged',
+        'size': printable_filesize(link.archive_size) if link.archive_size else 'pending',
         'status': 'archived' if link.is_archived else 'not yet archived',
         'status_color': 'success' if link.is_archived else 'danger',
         'oldest_archive_date': ts_to_date(link.oldest_archive_date),

archivebox/index/schema.py

@@ -407,6 +407,7 @@ class Link:
             'wget_path': wget_output_path(self),
             'warc_path': 'warc',
             'singlefile_path': 'singlefile.html',
+            'readability_path': 'readability/content.html',
             'pdf_path': 'output.pdf',
             'screenshot_path': 'screenshot.png',
             'dom_path': 'output.html',
@@ -427,6 +428,7 @@ class Link:
                 'screenshot_path': static_path,
                 'dom_path': static_path,
                 'singlefile_path': static_path,
+                'readability_path': static_path,
             })
         return canonical
 

archivebox/index/sql.py

@@ -39,6 +39,10 @@ def write_sql_main_index(links: List[Link], out_dir: str=OUTPUT_DIR) -> None:
     with transaction.atomic():
         for link in links:
             info = {k: v for k, v in link._asdict().items() if k in Snapshot.keys}
+            try:
+                info['timestamp'] = Snapshot.objects.get(url=link.url).timestamp
+            except Snapshot.DoesNotExist:
+                pass
             Snapshot.objects.update_or_create(url=link.url, defaults=info)
 
 @enforce_types
@@ -48,7 +52,7 @@ def write_sql_link_details(link: Link, out_dir: str=OUTPUT_DIR) -> None:
     from django.db import transaction
 
     with transaction.atomic():
-        snap = Snapshot.objects.get(url=link.url, timestamp=link.timestamp)
+        snap = Snapshot.objects.get(url=link.url)
         snap.title = link.title
         snap.tags = link.tags
         snap.save()

archivebox/logging_util.py

@@ -162,12 +162,10 @@ def progress_bar(seconds: int, prefix: str='') -> None:
 def log_cli_command(subcommand: str, subcommand_args: List[str], stdin: Optional[str], pwd: str):
     from .config import VERSION, ANSI
     cmd = ' '.join(('archivebox', subcommand, *subcommand_args))
-    stdin_hint = ' < /dev/stdin' if not stdin.isatty() else ''
-    stderr('{black}[i] [{now}] ArchiveBox v{VERSION}: {cmd}{stdin_hint}{reset}'.format(
+    stderr('{black}[i] [{now}] ArchiveBox v{VERSION}: {cmd}{reset}'.format(
         now=datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
         VERSION=VERSION,
         cmd=cmd,
-        stdin_hint=stdin_hint,
         **ANSI,
     ))
     stderr('{black}    > {pwd}{reset}'.format(pwd=pwd, **ANSI))
@@ -198,7 +196,8 @@ def log_deduping_finished(num_new_links: int):
 
 
 def log_crawl_started(new_links):
-    print('{lightred}[*] Starting crawl of {} sites 1 hop out from starting point{reset}'.format(len(new_links), **ANSI))
+    print()
+    print('{green}[*] Starting crawl of {} sites 1 hop out from starting point{reset}'.format(len(new_links), **ANSI))
 
 ### Indexing Stage
 
@@ -283,7 +282,7 @@ def log_archiving_finished(num_links: int):
         ANSI['reset'],
     ))
     print('    - {} links skipped'.format(_LAST_RUN_STATS.skipped))
-    print('    - {} links updated'.format(_LAST_RUN_STATS.succeeded))
+    print('    - {} links updated'.format(_LAST_RUN_STATS.succeeded + _LAST_RUN_STATS.failed))
     print('    - {} links had errors'.format(_LAST_RUN_STATS.failed))
     print()
     print('    {lightred}Hint:{reset} To view your archive index, open:'.format(**ANSI))
@@ -347,7 +346,7 @@ def log_archive_method_finished(result: "ArchiveResult"):
 
         # Collect and prefix output lines with indentation
         output_lines = [
-            '{lightred}Failed:{reset}'.format(**ANSI),
+            '{lightyellow}Extractor failed:{reset}'.format(**ANSI),
             '    {reset}{} {red}{}{reset}'.format(
                 result.output.__class__.__name__.replace('ArchiveError', ''),
                 result.output, 

archivebox/main.py

@@ -55,6 +55,7 @@ from .index.html import parse_html_main_index
 from .extractors import archive_links, archive_link, ignore_methods
 from .config import (
     stderr,
+    hint,
     ConfigDict,
     ANSI,
     IS_TTY,
@@ -169,7 +170,7 @@ def help(out_dir: str=OUTPUT_DIR) -> None:
     archivebox add --depth=1 ~/Downloads/bookmarks_export.html
     
     archivebox list --sort=timestamp --csv=timestamp,url,is_archived
-    archivebox schedule --every=week https://example.com/some/feed.rss
+    archivebox schedule --every=day https://example.com/some/feed.rss
     archivebox update --resume=15109948213.123
 
 {lightred}Documentation:{reset}
@@ -216,14 +217,15 @@ def version(quiet: bool=False,
             print(printable_folder_status(name, folder))
 
         print()
-        print('{white}[i] External locations:{reset}'.format(**ANSI))
+        print('{white}[i] Secrets locations:{reset}'.format(**ANSI))
         for name, folder in EXTERNAL_LOCATIONS.items():
             print(printable_folder_status(name, folder))
 
-        print()
-        print('{white}[i] Data locations:{reset}'.format(**ANSI))
-        for name, folder in DATA_LOCATIONS.items():
-            print(printable_folder_status(name, folder))
+        if DATA_LOCATIONS['OUTPUT_DIR']['is_valid']:
+            print()
+            print('{white}[i] Data locations:{reset}'.format(**ANSI))
+            for name, folder in DATA_LOCATIONS.items():
+                print(printable_folder_status(name, folder))
 
         print()
         check_dependencies()
@@ -521,11 +523,16 @@ def add(urls: Union[str, List[str]],
         depth: int=0,
         update_all: bool=not ONLY_NEW,
         index_only: bool=False,
+        overwrite: bool=False,
+        init: bool=False,
         out_dir: str=OUTPUT_DIR) -> List[Link]:
     """Add a new URL or list of URLs to your archive"""
 
     assert depth in (0, 1), 'Depth must be 0 or 1 (depth >1 is not supported yet)'
 
+    if init:
+        run_subcommand('init', stdin=None, pwd=out_dir)
+
     # Load list of links from the existing index
     check_data_folder(out_dir=out_dir)
     check_dependencies()
@@ -541,29 +548,37 @@ def add(urls: Union[str, List[str]],
         # save verbatim args to sources
         write_ahead_log = save_text_as_source('\n'.join(urls), filename='{ts}-import.txt', out_dir=out_dir)
     
-    new_links += parse_links_from_source(write_ahead_log)
+    new_links += parse_links_from_source(write_ahead_log, root_url=None)
 
     # If we're going one level deeper, download each link and look for more links
     new_links_depth = []
     if new_links and depth == 1:
         log_crawl_started(new_links)
         for new_link in new_links:
-            downloaded_file = save_file_as_source(new_link.url, filename='{ts}-crawl-{basename}.txt', out_dir=out_dir)
-            new_links_depth += parse_links_from_source(downloaded_file)
-    all_links, new_links = dedupe_links(all_links, new_links + new_links_depth)
+            downloaded_file = save_file_as_source(new_link.url, filename=f'{new_link.timestamp}-crawl-{new_link.domain}.txt', out_dir=out_dir)
+            new_links_depth += parse_links_from_source(downloaded_file, root_url=new_link.url)
+
+    imported_links = list({link.url: link for link in (new_links + new_links_depth)}.values())
+    all_links, new_links = dedupe_links(all_links, imported_links)
     write_main_index(links=all_links, out_dir=out_dir, finished=not new_links)
 
     if index_only:
         return all_links
 
     # Run the archive methods for each link
-    to_archive = all_links if update_all else new_links
-    archive_links(to_archive, out_dir=out_dir)
+    if update_all:
+        archive_links(all_links, overwrite=overwrite, out_dir=out_dir)
+    elif overwrite:
+        archive_links(imported_links, overwrite=True, out_dir=out_dir)
+    elif new_links:
+        archive_links(new_links, overwrite=False, out_dir=out_dir)
+    else:
+        # nothing was updated, don't bother re-saving the index
+        return all_links
 
     # Step 4: Re-write links index with updated titles, icons, and resources
-    if to_archive:
-        all_links = load_main_index(out_dir=out_dir)
-        write_main_index(links=list(all_links), out_dir=out_dir, finished=True)
+    all_links = load_main_index(out_dir=out_dir)
+    write_main_index(links=list(all_links), out_dir=out_dir, finished=True)
     return all_links
 
 @enforce_types
@@ -595,8 +610,8 @@ def remove(filter_str: Optional[str]=None,
                 color='red',
             )
             stderr()
-            stderr('    {lightred}Hint:{reset} To remove all urls you can run:'.format(**ANSI))
-            stderr("        archivebox remove --filter-type=regex '.*'")
+            hint(('To remove all urls you can run:',
+                  'archivebox remove --filter-type=regex ".*"'))
             stderr()
             raise SystemExit(2)
         elif filter_str:
@@ -696,6 +711,16 @@ def update(resume: Optional[float]=None,
         
     # Step 3: Run the archive methods for each link
     to_archive = new_links if only_new else all_links
+    if resume:
+        to_archive = [
+            link for link in to_archive
+            if link.timestamp >= str(resume)
+        ]
+        if not to_archive:
+            stderr('')
+            stderr(f'[√] Nothing found to resume after {resume}', color='green')
+            return all_links
+
     archive_links(to_archive, overwrite=overwrite, out_dir=out_dir)
 
     # Step 4: Re-write links index with updated titles, icons, and resources
@@ -909,6 +934,7 @@ def schedule(add: bool=False,
              run_all: bool=False,
              quiet: bool=False,
              every: Optional[str]=None,
+             depth: int=0,
              import_path: Optional[str]=None,
              out_dir: str=OUTPUT_DIR):
     """Set ArchiveBox to regularly import URLs at specific times using cron"""
@@ -920,68 +946,37 @@ def schedule(add: bool=False,
     cron = CronTab(user=True)
     cron = dedupe_cron_jobs(cron)
 
-    existing_jobs = list(cron.find_comment(CRON_COMMENT))
-    if foreground or run_all:
-        if import_path or (not existing_jobs):
-            stderr('{red}[X] You must schedule some jobs first before running in foreground mode.{reset}'.format(**ANSI))
-            stderr('    archivebox schedule --every=hour https://example.com/some/rss/feed.xml')
-            raise SystemExit(1)
-        print('{green}[*] Running {} ArchiveBox jobs in foreground task scheduler...{reset}'.format(len(existing_jobs), **ANSI))
-        if run_all:
-            try:
-                for job in existing_jobs:
-                    sys.stdout.write(f'  > {job.command}')
-                    sys.stdout.flush()
-                    job.run()
-                    sys.stdout.write(f'\r  √ {job.command}\n')
-            except KeyboardInterrupt:
-                print('\n{green}[√] Stopped.{reset}'.format(**ANSI))
-                raise SystemExit(1)
-        if foreground:
-            try:
-                for result in cron.run_scheduler():
-                    print(result)
-            except KeyboardInterrupt:
-                print('\n{green}[√] Stopped.{reset}'.format(**ANSI))
-                raise SystemExit(1)
-
-    elif show:
-        if existing_jobs:
-            print('\n'.join(str(cmd) for cmd in existing_jobs))
-        else:
-            stderr('{red}[X] There are no ArchiveBox cron jobs scheduled for your user ({}).{reset}'.format(USER, **ANSI))
-            stderr('    To schedule a new job, run:')
-            stderr('        archivebox schedule --every=[timeperiod] https://example.com/some/rss/feed.xml')
-        raise SystemExit(0)
-
-    elif clear:
+    if clear:
         print(cron.remove_all(comment=CRON_COMMENT))
         cron.write()
         raise SystemExit(0)
 
-    elif every:
+    existing_jobs = list(cron.find_comment(CRON_COMMENT))
+
+    if every or add:
+        every = every or 'day'
         quoted = lambda s: f'"{s}"' if s and ' ' in s else s
         cmd = [
             'cd',
             quoted(out_dir),
             '&&',
             quoted(ARCHIVEBOX_BINARY),
-            *(['add', f'"{import_path}"'] if import_path else ['update']),
-            '2>&1',
+            *(['add', f'--depth={depth}', f'"{import_path}"'] if import_path else ['update']),
             '>',
             quoted(os.path.join(LOGS_DIR, 'archivebox.log')),
+            '2>&1',
 
         ]
         new_job = cron.new(command=' '.join(cmd), comment=CRON_COMMENT)
 
-        if every in ('minute', 'hour', 'day', 'week', 'month', 'year'):
+        if every in ('minute', 'hour', 'day', 'month', 'year'):
             set_every = getattr(new_job.every(), every)
             set_every()
         elif CronSlices.is_valid(every):
             new_job.setall(every)
         else:
             stderr('{red}[X] Got invalid timeperiod for cron task.{reset}'.format(**ANSI))
-            stderr('    It must be one of minute/hour/day/week/month')
+            stderr('    It must be one of minute/hour/day/month')
             stderr('    or a quoted cron-format schedule like:')
             stderr('        archivebox init --every=day https://example.com/some/rss/feed.xml')
             stderr('        archivebox init --every="0/5 * * * *" https://example.com/some/rss/feed.xml')
@@ -1003,9 +998,50 @@ def schedule(add: bool=False,
             stderr()
             stderr('    Make sure you have enough storage space available to hold all the data.')
             stderr('    Using a compressed/deduped filesystem like ZFS is recommended if you plan on archiving a lot.')
+            stderr('')
+    elif show:
+        if existing_jobs:
+            print('\n'.join(str(cmd) for cmd in existing_jobs))
+        else:
+            stderr('{red}[X] There are no ArchiveBox cron jobs scheduled for your user ({}).{reset}'.format(USER, **ANSI))
+            stderr('    To schedule a new job, run:')
+            stderr('        archivebox schedule --every=[timeperiod] https://example.com/some/rss/feed.xml')
         raise SystemExit(0)
 
+    cron = CronTab(user=True)
+    cron = dedupe_cron_jobs(cron)
+    existing_jobs = list(cron.find_comment(CRON_COMMENT))
 
+    if foreground or run_all:
+        if not existing_jobs:
+            stderr('{red}[X] You must schedule some jobs first before running in foreground mode.{reset}'.format(**ANSI))
+            stderr('    archivebox schedule --every=hour https://example.com/some/rss/feed.xml')
+            raise SystemExit(1)
+
+        print('{green}[*] Running {} ArchiveBox jobs in foreground task scheduler...{reset}'.format(len(existing_jobs), **ANSI))
+        if run_all:
+            try:
+                for job in existing_jobs:
+                    sys.stdout.write(f'  > {job.command.split("/archivebox ")[0].split(" && ")[0]}\n')
+                    sys.stdout.write(f'    > {job.command.split("/archivebox ")[-1].split(" > ")[0]}')
+                    sys.stdout.flush()
+                    job.run()
+                    sys.stdout.write(f'\r    √ {job.command.split("/archivebox ")[-1]}\n')
+            except KeyboardInterrupt:
+                print('\n{green}[√] Stopped.{reset}'.format(**ANSI))
+                raise SystemExit(1)
+
+        if foreground:
+            try:
+                for job in existing_jobs:
+                    print(f'  > {job.command.split("/archivebox ")[-1].split(" > ")[0]}')
+                for result in cron.run_scheduler():
+                    print(result)
+            except KeyboardInterrupt:
+                print('\n{green}[√] Stopped.{reset}'.format(**ANSI))
+                raise SystemExit(1)
+
+    
 @enforce_types
 def server(runserver_args: Optional[List[str]]=None,
            reload: bool=False,
@@ -1034,7 +1070,7 @@ def server(runserver_args: Optional[List[str]]=None,
 
     print('{green}[+] Starting ArchiveBox webserver...{reset}'.format(**ANSI))
     if admin_user:
-        print("{lightred}[i] The admin username is:{lightblue} {}{reset}".format(admin_user.username, **ANSI))
+        hint('The admin username is{lightblue} {}{reset}\n'.format(admin_user.username, **ANSI))
     else:
         print('{lightyellow}[!] No admin users exist yet, you will not be able to edit links in the UI.{reset}'.format(**ANSI))
         print()

archivebox/parsers/__init__.py

@@ -11,7 +11,7 @@ import re
 import os
 from io import StringIO
 
-from typing import IO, Tuple, List
+from typing import IO, Tuple, List, Optional
 from datetime import datetime
 
 from ..system import atomic_write
@@ -23,12 +23,14 @@ from ..config import (
 )
 from ..util import (
     basename,
+    htmldecode,
     download_url,
     enforce_types,
     URL_REGEX,
 )
 from ..index.schema import Link
 from ..logging_util import TimedProgress, log_source_saved
+
 from .pocket_html import parse_pocket_html_export
 from .pinboard_rss import parse_pinboard_rss_export
 from .shaarli_rss import parse_shaarli_rss_export
@@ -36,26 +38,29 @@ from .medium_rss import parse_medium_rss_export
 from .netscape_html import parse_netscape_html_export
 from .generic_rss import parse_generic_rss_export
 from .generic_json import parse_generic_json_export
+from .generic_html import parse_generic_html_export
 from .generic_txt import parse_generic_txt_export
 
 PARSERS = (
-        # Specialized parsers
-        ('Pocket HTML', parse_pocket_html_export),
-        ('Pinboard RSS', parse_pinboard_rss_export),
-        ('Shaarli RSS', parse_shaarli_rss_export),
-        ('Medium RSS', parse_medium_rss_export),
-        
-        # General parsers
-        ('Netscape HTML', parse_netscape_html_export),
-        ('Generic RSS', parse_generic_rss_export),
-        ('Generic JSON', parse_generic_json_export),
+    # Specialized parsers
+    ('Pocket HTML', parse_pocket_html_export),
+    ('Pinboard RSS', parse_pinboard_rss_export),
+    ('Shaarli RSS', parse_shaarli_rss_export),
+    ('Medium RSS', parse_medium_rss_export),
+    
+    # General parsers
+    ('Netscape HTML', parse_netscape_html_export),
+    ('Generic RSS', parse_generic_rss_export),
+    ('Generic JSON', parse_generic_json_export),
+    ('Generic HTML', parse_generic_html_export),
+
+    # Fallback parser
+    ('Plain Text', parse_generic_txt_export),
+)
 
-        # Fallback parser
-        ('Plain Text', parse_generic_txt_export),
-    )
 
 @enforce_types
-def parse_links_memory(urls: List[str]):
+def parse_links_memory(urls: List[str], root_url: Optional[str]=None):
     """
     parse a list of URLS without touching the filesystem
     """
@@ -66,17 +71,16 @@ def parse_links_memory(urls: List[str]):
     file = StringIO()
     file.writelines(urls)
     file.name = "io_string"
-    output = _parse(file, timer)
-
-    if output is not None:
-        return output
-
+    links, parser = run_parser_functions(file, timer, root_url=root_url)
     timer.end()
-    return [], 'Failed to parse'
+
+    if parser is None:
+        return [], 'Failed to parse'
+    return links, parser
     
 
 @enforce_types
-def parse_links(source_file: str) -> Tuple[List[Link], str]:
+def parse_links(source_file: str, root_url: Optional[str]=None) -> Tuple[List[Link], str]:
     """parse a list of URLs with their metadata from an 
        RSS feed, bookmarks export, or text file
     """
@@ -85,28 +89,39 @@ def parse_links(source_file: str) -> Tuple[List[Link], str]:
 
     timer = TimedProgress(TIMEOUT * 4)
     with open(source_file, 'r', encoding='utf-8') as file:
-        output = _parse(file, timer)
-
-    if output is not None:
-        return output
+        links, parser = run_parser_functions(file, timer, root_url=root_url)
 
     timer.end()
-    return [], 'Failed to parse'
+    if parser is None:
+        return [], 'Failed to parse'
+    return links, parser
+
+
+def run_parser_functions(to_parse: IO[str], timer, root_url: Optional[str]=None) -> Tuple[List[Link], Optional[str]]:
+    most_links: List[Link] = []
+    best_parser_name = None
 
-def _parse(to_parse: IO[str], timer) -> Tuple[List[Link], str]:
     for parser_name, parser_func in PARSERS:
         try:
-            links = list(parser_func(to_parse))
-            if links:
-                timer.end()
-                return links, parser_name
-        except Exception as err:   # noqa
-            pass
+            parsed_links = list(parser_func(to_parse, root_url=root_url))
+            if not parsed_links:
+                raise Exception('no links found')
+
+            # print(f'[√] Parser {parser_name} succeeded: {len(parsed_links)} links parsed')
+            if len(parsed_links) > len(most_links):
+                most_links = parsed_links
+                best_parser_name = parser_name
+                
+        except Exception as err:                                                # noqa
             # Parsers are tried one by one down the list, and the first one
             # that succeeds is used. To see why a certain parser was not used
             # due to error or format incompatibility, uncomment this line:
+            
             # print('[!] Parser {} failed: {} {}'.format(parser_name, err.__class__.__name__, err))
             # raise
+            pass
+    timer.end()
+    return most_links, best_parser_name
 
 
 @enforce_types
@@ -126,15 +141,11 @@ def save_file_as_source(path: str, timeout: int=TIMEOUT, filename: str='{ts}-{ba
 
     if any(path.startswith(s) for s in ('http://', 'https://', 'ftp://')):
         # Source is a URL that needs to be downloaded
-        print('{}[*] [{}] Downloading {}{}'.format(
-            ANSI['green'],
-            datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
-            path,
-            ANSI['reset'],
-        ))
+        print(f'    > Downloading {path} contents')
         timer = TimedProgress(timeout, prefix='      ')
         try:
             raw_source_text = download_url(path, timeout=timeout)
+            raw_source_text = htmldecode(raw_source_text)
             timer.end()
         except Exception as e:
             timer.end()

archivebox/parsers/generic_html.py

@@ -0,0 +1,53 @@
+__package__ = 'archivebox.parsers'
+
+
+import re
+
+from typing import IO, Iterable, Optional
+from datetime import datetime
+
+from ..index.schema import Link
+from ..util import (
+    htmldecode,
+    enforce_types,
+    URL_REGEX,
+)
+from html.parser import HTMLParser
+from urllib.parse import urljoin
+
+
+class HrefParser(HTMLParser):
+    def __init__(self):
+        super().__init__()
+        self.urls = []
+
+    def handle_starttag(self, tag, attrs):
+        if tag == "a":
+            for attr, value in attrs:
+                if attr == "href":
+                    self.urls.append(value)
+
+
+@enforce_types
+def parse_generic_html_export(html_file: IO[str], root_url: Optional[str]=None, **_kwargs) -> Iterable[Link]:
+    """Parse Generic HTML for href tags and use only the url (support for title coming later)"""
+
+    html_file.seek(0)
+    for line in html_file:
+        parser = HrefParser()
+        # example line
+        # <li><a href="http://example.com/ time_added="1478739709" tags="tag1,tag2">example title</a></li>
+        parser.feed(line)
+        for url in parser.urls:
+            if root_url:
+                # resolve relative urls /home.html -> https://example.com/home.html
+                url = urljoin(root_url, url)
+            
+            for archivable_url in re.findall(URL_REGEX, url):
+                yield Link(
+                    url=htmldecode(archivable_url),
+                    timestamp=str(datetime.now().timestamp()),
+                    title=None,
+                    tags=None,
+                    sources=[html_file.name],
+                )

archivebox/parsers/generic_json.py

@@ -13,7 +13,7 @@ from ..util import (
 
 
 @enforce_types
-def parse_generic_json_export(json_file: IO[str]) -> Iterable[Link]:
+def parse_generic_json_export(json_file: IO[str], **_kwargs) -> Iterable[Link]:
     """Parse JSON-format bookmarks export files (produced by pinboard.in/export/, or wallabag)"""
 
     json_file.seek(0)

archivebox/parsers/generic_rss.py

@@ -12,7 +12,7 @@ from ..util import (
 )
 
 @enforce_types
-def parse_generic_rss_export(rss_file: IO[str]) -> Iterable[Link]:
+def parse_generic_rss_export(rss_file: IO[str], **_kwargs) -> Iterable[Link]:
     """Parse RSS XML-format files into links"""
 
     rss_file.seek(0)

archivebox/parsers/generic_txt.py

@@ -16,7 +16,7 @@ from ..util import (
 
 
 @enforce_types
-def parse_generic_txt_export(text_file: IO[str]) -> Iterable[Link]:
+def parse_generic_txt_export(text_file: IO[str], **_kwargs) -> Iterable[Link]:
     """Parse raw links from each line in a text file"""
 
     text_file.seek(0)
@@ -25,14 +25,18 @@ def parse_generic_txt_export(text_file: IO[str]) -> Iterable[Link]:
             continue
 
         # if the line is a local file path that resolves, then we can archive it
-        if Path(line).exists():
-            yield Link(
-                url=line,
-                timestamp=str(datetime.now().timestamp()),
-                title=None,
-                tags=None,
-                sources=[text_file.name],
-            )
+        try:
+            if Path(line).exists():
+                yield Link(
+                    url=line,
+                    timestamp=str(datetime.now().timestamp()),
+                    title=None,
+                    tags=None,
+                    sources=[text_file.name],
+                )
+        except (OSError, PermissionError):
+            # nvm, not a valid path...
+            pass
 
         # otherwise look for anything that looks like a URL in the line
         for url in re.findall(URL_REGEX, line):

archivebox/parsers/medium_rss.py

@@ -14,7 +14,7 @@ from ..util import (
 
 
 @enforce_types
-def parse_medium_rss_export(rss_file: IO[str]) -> Iterable[Link]:
+def parse_medium_rss_export(rss_file: IO[str], **_kwargs) -> Iterable[Link]:
     """Parse Medium RSS feed files into links"""
 
     rss_file.seek(0)

archivebox/parsers/netscape_html.py

@@ -14,7 +14,7 @@ from ..util import (
 
 
 @enforce_types
-def parse_netscape_html_export(html_file: IO[str]) -> Iterable[Link]:
+def parse_netscape_html_export(html_file: IO[str], **_kwargs) -> Iterable[Link]:
     """Parse netscape-format bookmarks export files (produced by all browsers)"""
 
     html_file.seek(0)

archivebox/parsers/pinboard_rss.py

@@ -14,7 +14,7 @@ from ..util import (
 
 
 @enforce_types
-def parse_pinboard_rss_export(rss_file: IO[str]) -> Iterable[Link]:
+def parse_pinboard_rss_export(rss_file: IO[str], **_kwargs) -> Iterable[Link]:
     """Parse Pinboard RSS feed files into links"""
 
     rss_file.seek(0)

archivebox/parsers/pocket_html.py

@@ -14,7 +14,7 @@ from ..util import (
 
 
 @enforce_types
-def parse_pocket_html_export(html_file: IO[str]) -> Iterable[Link]:
+def parse_pocket_html_export(html_file: IO[str], **_kwargs) -> Iterable[Link]:
     """Parse Pocket-format bookmarks export files (produced by getpocket.com/export/)"""
 
     html_file.seek(0)

archivebox/parsers/shaarli_rss.py

@@ -13,7 +13,7 @@ from ..util import (
 
 
 @enforce_types
-def parse_shaarli_rss_export(rss_file: IO[str]) -> Iterable[Link]:
+def parse_shaarli_rss_export(rss_file: IO[str], **_kwargs) -> Iterable[Link]:
     """Parse Shaarli-specific RSS XML-format files into links"""
 
     rss_file.seek(0)

archivebox/system.py

@@ -16,6 +16,7 @@ from .util import enforce_types, ExtendedEncoder
 from .config import OUTPUT_PERMISSIONS
 
 
+
 def run(*args, input=None, capture_output=True, text=False, **kwargs):
     """Patched of subprocess.run to fix blocking io making timeout=innefective"""
 

archivebox/themes/legacy/link_details.html

@@ -298,6 +298,10 @@
                             <h5>Errors</h5>
                             ❌  $num_failures
                         </div>
+                        <div class="info-chunk">
+                            <h5>Size</h5>
+                            $size
+                        </div>
                     </div>
                     <div class="col-lg-4">
                         <div class="info-chunk">
@@ -312,87 +316,100 @@
                     </div>
                 </div>
                 <div class="row header-bottom-frames">
-                    <div class="col-lg-2">
+                    <div class="col-lg-3">
                         <div class="card selected-card">
                           <iframe class="card-img-top" src="$archive_url" sandbox="allow-same-origin allow-scripts allow-forms" scrolling="no"></iframe>
                           <div class="card-body">
-                            <a href="$archive_url" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
-                                <img src="../../static/external.png" class="external"/>
-                            </a>
-                            <a href="$archive_url" target="preview"><h4 class="card-title">Local Archive</h4></a>
-                            <p class="card-text">archive/$domain</p>
+                                <a href="$archive_url" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
+                                    <img src="../../static/external.png" class="external"/>
+                                </a>
+                                <a href="$archive_url" target="preview"><h4 class="card-title">Wget &gt; WARC</h4></a>
+                                <p class="card-text">archive/$domain</p>
+                            </div>
+                        </div>
+                    </div>
+                    <div class="col-lg-3">
+                        <div class="card">
+                            <iframe class="card-img-top" src="$singlefile_path" sandbox="allow-same-origin allow-scripts allow-forms" scrolling="no"></iframe>
+                            <div class="card-body">
+                                <a href="$singlefile_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
+                                    <img src="../../static/external.png" class="external"/>
+                                </a>
+                                <a href="$singlefile_path" target="preview"><h4 class="card-title">Chrome &gt; SingleFile</h4></a>
+                                <p class="card-text">archive/singlefile.html</p>
                           </div>
                         </div>
                     </div>
-                    <div class="col-lg-2">
+                    <div class="col-lg-3">
                         <div class="card">
-                          <iframe class="card-img-top" src="$dom_path" sandbox="allow-same-origin allow-scripts allow-forms" scrolling="no"></iframe>
-                          <div class="card-body">
-                            <a href="$dom_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
-                                <img src="../../static/external.png" class="external"/>
-                            </a>
-                            <a href="$dom_path" target="preview"><h4 class="card-title">HTML</h4></a>
-                            <p class="card-text">archive/output.html</p>
+                            <iframe class="card-img-top" src="$archive_org_path" sandbox="allow-same-origin allow-scripts allow-forms" scrolling="no"></iframe>
+                            <div class="card-body">
+                                <a href="$archive_org_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
+                                    <img src="../../static/external.png" class="external"/>
+                                </a>
+                                <a href="$archive_org_path" target="preview"><h4 class="card-title">Archive.Org</h4></a>
+                                <p class="card-text">web.archive.org/web/...</p>
                           </div>
                         </div>
                     </div>
-                    <div class="col-lg-2">
+                    <div class="col-lg-3">
                         <div class="card">
-                          <iframe class="card-img-top" src="$singlefile_path" sandbox="allow-same-origin allow-scripts allow-forms" scrolling="no"></iframe>
-                          <div class="card-body">
-                            <a href="$singlefile_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
-                                <img src="../../static/external.png" class="external"/>
-                            </a>
-                            <a href="$singlefile_path" target="preview"><h4 class="card-title">SingleFile</h4></a>
-                            <p class="card-text">archive/singlefile.html</p>
+                            <iframe class="card-img-top" src="$url" sandbox="allow-same-origin allow-scripts allow-forms" scrolling="no"></iframe>
+                            <div class="card-body">
+                                <a href="$url" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
+                                    <img src="../../static/external.png" class="external"/>
+                                </a>
+                                <a href="$url" target="preview"><h4 class="card-title">Original</h4></a>
+                                <p class="card-text">$domain</p>
                           </div>
                         </div>
                     </div>
-                    <div class="col-lg-2">
+                    <br/>
+                    <div class="col-lg-3">
                         <div class="card">
-                          <iframe class="card-img-top pdf-frame" src="$pdf_path" scrolling="no"></iframe>
-                          <div class="card-body">
-                            <a href="$pdf_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
-                                <img src="../../static/external.png" class="external"/>
-                            </a>
-                            <a href="$pdf_path" target="preview" id="pdf-btn"><h4 class="card-title">PDF</h4></a>
-                            <p class="card-text">archive/output.pdf</p>
+                            <iframe class="card-img-top pdf-frame" src="$pdf_path" scrolling="no"></iframe>
+                            <div class="card-body">
+                                <a href="$pdf_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
+                                    <img src="../../static/external.png" class="external"/>
+                                </a>
+                                <a href="$pdf_path" target="preview" id="pdf-btn"><h4 class="card-title">Chrome &gt; PDF</h4></a>
+                                <p class="card-text">archive/output.pdf</p>
                           </div>
                         </div>
                     </div>
-                    <div class="col-lg-2">
+                    <div class="col-lg-3">
                         <div class="card">
-                          <img class="card-img-top screenshot" src="$screenshot_path"></iframe>
-                          <div class="card-body">
-                            <a href="$screenshot_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
-                                <img src="../../static/external.png" class="external"/>
-                            </a>
-                            <a href="$screenshot_path" target="preview"><h4 class="card-title">Screenshot</h4></a>
-                            <p class="card-text">archive/screenshot.png</p>
+                            <img class="card-img-top screenshot" src="$screenshot_path"></iframe>
+                            <div class="card-body">
+                                <a href="$screenshot_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
+                                    <img src="../../static/external.png" class="external"/>
+                                </a>
+                                <a href="$screenshot_path" target="preview"><h4 class="card-title">Chrome &gt; Screenshot</h4></a>
+                                <p class="card-text">archive/screenshot.png</p>
                           </div>
                         </div>
                     </div>
-                    <div class="col-lg-2">
+                    <div class="col-lg-3">
                         <div class="card">
-                          <iframe class="card-img-top" src="$archive_org_path" sandbox="allow-same-origin allow-scripts allow-forms" scrolling="no"></iframe>
-                          <div class="card-body">
-                            <a href="$archive_org_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
-                                <img src="../../static/external.png" class="external"/>
-                            </a>
-                            <a href="$archive_org_path" target="preview"><h4 class="card-title">Archive.Org</h4></a>
-                            <p class="card-text">web.archive.org/web/...</p>
+                            <iframe class="card-img-top" src="$dom_path" sandbox="allow-same-origin allow-scripts allow-forms" scrolling="no"></iframe>
+                            <div class="card-body">
+                                <a href="$dom_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
+                                    <img src="../../static/external.png" class="external"/>
+                                </a>
+                                <a href="$dom_path" target="preview"><h4 class="card-title">Chrome &gt; HTML</h4></a>
+                                <p class="card-text">archive/output.html</p>
                           </div>
                         </div>
                     </div>
-                    <div class="col-lg-2">
+                    <div class="col-lg-3">
                         <div class="card">
-                          <iframe class="card-img-top" src="$url" sandbox="allow-same-origin allow-scripts allow-forms" scrolling="no"></iframe>
-                          <div class="card-body">
-                            <a href="$url" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
-                                <img src="../../static/external.png" class="external"/>
-                            </a>
-                            <a href="$url" target="preview"><h4 class="card-title">Original</h4></a>
-                            <p class="card-text">$domain</p>
+                            <iframe class="card-img-top" src="$readability_path" sandbox="allow-same-origin allow-scripts allow-forms" scrolling="no"></iframe>
+                            <div class="card-body">
+                                <a href="$readability_path" style="float:right" title="Open in new tab..." target="_blank" rel="noopener">
+                                    <img src="../../static/external.png" class="external"/>
+                                </a>
+                                <a href="$readability_path" target="preview"><h4 class="card-title">Readability</h4></a>
+                                <p class="card-text">archive/readability/...</p>
                           </div>
                         </div>
                     </div>

archivebox/util.py

@@ -59,7 +59,7 @@ URL_REGEX = re.compile(
     r'(?:[a-zA-Z]|[0-9]'              # followed by allowed alphanum characters
     r'|[$-_@.&+]|[!*\(\),]'           #    or allowed symbols
     r'|(?:%[0-9a-fA-F][0-9a-fA-F]))'  #    or allowed unicode bytes
-    r'[^\]\[\(\)<>\""\'\s]+',         # stop parsing at these symbols
+    r'[^\]\[\(\)<>"\'\s]+',         # stop parsing at these symbols
     re.IGNORECASE,
 )
 

bin/archive

@@ -1,7 +1,11 @@
-#!/bin/sh
+#!/bin/bash
 
-echo "[X] This method of running ArchiveBox is deprecated as of >= v0.4."
-echo "    You should 'pip install archivebox' and use the installed 'archivebox' binary instead."
-echo "    For more info, see the Quickstart section of the README.md:"
-echo "        https://github.com/pirate/ArchiveBox#Quickstart"
-exit 2
+if python3 -m django --version >/dev/null 2>&1; then
+    python3 -m archivebox "$*"
+else
+    echo '[X] ArchiveBox must be installed before using:'
+    echo "    pip install archivebox"
+    echo
+    echo "Hint: Did you forget to activate a virtuenv or set your $$PATH?"
+    exit 2
+fi

bin/export_browser_history.sh

@@ -1,21 +1,22 @@
 #!/bin/bash
 
-REPO_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )"; cd .. && pwd )"
-
-mkdir -p "$REPO_DIR/output/sources"
+OUTPUT_DIR="$(pwd)"
 
 if [[ "$1" == "--chrome" ]]; then
     # Google Chrome / Chromium
     if [[ -e "$2" ]]; then
-        cp "$2" "$REPO_DIR/output/sources/chrome_history.db.tmp"
+        cp "$2" "$OUTPUT_DIR/chrome_history.db.tmp"
     else
         default=$(ls ~/Library/Application\ Support/Google/Chrome/Default/History)
         echo "Defaulting to history db: $default"
         echo "Optionally specify the path to a different sqlite history database as the 2nd argument."
-        cp "$default" "$REPO_DIR/output/sources/chrome_history.db.tmp"
+        cp "$default" "$OUTPUT_DIR/chrome_history.db.tmp"
     fi
-    sqlite3 "$REPO_DIR/output/sources/chrome_history.db.tmp" "SELECT \"[\" || group_concat(json_object('timestamp', last_visit_time, 'description', title, 'href', url)) || \"]\" FROM urls;" > "$REPO_DIR/output/sources/chrome_history.json"
-    rm "$REPO_DIR"/output/sources/chrome_history.db.*
+
+    sqlite3 "$OUTPUT_DIR/chrome_history.db.tmp" "SELECT \"[\" || group_concat(json_object('timestamp', last_visit_time, 'description', title, 'href', url)) || \"]\" FROM urls;" > "$OUTPUT_DIR/chrome_history.json"
+    jq < "$(dirname "${2:-$default}")"/Bookmarks '.roots.other.children[] | {href: .url, description: .name, timestamp: .date_added}' > "$OUTPUT_DIR/chrome_bookmarks.json"
+    
+    rm "$DATA_DIR"/output/sources/chrome_history.db.*
     echo "Chrome history exported to:"
     echo "    output/sources/chrome_history.json"
 fi
@@ -23,31 +24,37 @@ fi
 if [[ "$1" == "--firefox" ]]; then
     # Firefox
     if [[ -e "$2" ]]; then
-        cp "$2" "$REPO_DIR/output/sources/firefox_history.db.tmp"
+        cp "$2" "$OUTPUT_DIR/firefox_history.db.tmp"
     else
         default=$(ls ~/Library/Application\ Support/Firefox/Profiles/*.default/places.sqlite)
         echo "Defaulting to history db: $default"
         echo "Optionally specify the path to a different sqlite history database as the 2nd argument."
-        cp "$default" "$REPO_DIR/output/sources/firefox_history.db.tmp"
+        cp "$default" "$OUTPUT_DIR/firefox_history.db.tmp"
     fi
-    sqlite3 "$REPO_DIR/output/sources/firefox_history.db.tmp" "SELECT \"[\" || group_concat(json_object('timestamp', last_visit_date, 'description', title, 'href', url)) || \"]\" FROM moz_places;" > "$REPO_DIR/output/sources/firefox_history.json"
-    rm "$REPO_DIR"/output/sources/firefox_history.db.*
+    
+    sqlite3 "$OUTPUT_DIR/firefox_history.db.tmp" "SELECT \"[\" || group_concat(json_object('timestamp', last_visit_date, 'description', title, 'href', url)) || \"]\" FROM moz_places;" > "$OUTPUT_DIR/firefox_history.json"
+    sqlite3 "$OUTPUT_DIR/firefox_history.db.tmp" "SELECT \"[\" || group_concat(json_object('timestamp', b.dateAdded, 'description', b.title, 'href', f.url)) || \"]\" FROM moz_bookmarks AS b JOIN moz_places AS f ON f.id = b.fk" > "$OUTPUT_DIR/firefox_bookmarks.json"
+    
+    rm "$DATA_DIR"/output/sources/firefox_history.db.*
     echo "Firefox history exported to:"
     echo "    output/sources/firefox_history.json"
+    echo "    output/sources/firefox_bookmarks.json"
 fi
 
 if [[ "$1" == "--safari" ]]; then
     # Safari
     if [[ -e "$2" ]]; then
-        cp "$2" "$REPO_DIR/output/sources/safari_history.db.tmp"
+        cp "$2" "$OUTPUT_DIR/safari_history.db.tmp"
     else
         default="~/Library/Safari/History.db"
         echo "Defaulting to history db: $default"
         echo "Optionally specify the path to a different sqlite history database as the 2nd argument."
-        cp "$default" "$REPO_DIR/output/sources/safari_history.db.tmp"
+        cp "$default" "$OUTPUT_DIR/safari_history.db.tmp"
     fi
-    sqlite3 "$REPO_DIR/output/sources/safari_history.db.tmp" "select url from history_items" > "$REPO_DIR/output/sources/safari_history.json"
-    rm "$REPO_DIR"/output/sources/safari_history.db.*
+    
+    sqlite3 "$OUTPUT_DIR/safari_history.db.tmp" "select url from history_items" > "$OUTPUT_DIR/safari_history.json"
+    
+    rm "$DATA_DIR"/output/sources/safari_history.db.*
     echo "Safari history exported to:"
     echo "    output/sources/safari_history.json"
 fi

bin/release.sh

@@ -10,52 +10,58 @@ set -o nounset
 set -o pipefail
 IFS=$'\n'
 
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && cd .. && pwd )"
-VERSION_FILE="$DIR/archivebox/VERSION"
+REPO_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && cd .. && pwd )"
 
 function bump_semver {
     echo "$1" | awk -F. '{$NF = $NF + 1;} 1' | sed 's/ /./g'
 }
 
-source "$DIR/.venv/bin/activate"
-cd "$DIR"
+source "$REPO_DIR/.venv/bin/activate"
+cd "$REPO_DIR"
 
-OLD_VERSION="$(cat "$VERSION_FILE")"
+OLD_VERSION="$(jq -r '.version' < "$REPO_DIR/package.json")"
 NEW_VERSION="$(bump_semver "$OLD_VERSION")"
 
 echo "[*] Fetching latest docs version"
-cd "$DIR/docs"
+cd "$REPO_DIR/docs"
 git pull
-cd "$DIR"
+cd "$REPO_DIR"
 
 echo "[+] Building docs"
 sphinx-apidoc -o docs archivebox
-cd "$DIR/docs"
+cd "$REPO_DIR/docs"
 make html
-cd "$DIR"
+cd "$REPO_DIR"
 
 if [ -z "$(git status --porcelain)" ] && [[ "$(git branch --show-current)" == "master" ]]; then 
     git pull
 else
-    echo "[X] Commit your changes and make sure git is checked out on clean master."
-    exit 4
+    echo "[!] Warning: git status is dirty!"
+    echo "    Press Ctrl-C to cancel, or wait 10sec to continue..."
+    sleep 10
 fi
 
 echo "[*] Bumping VERSION from $OLD_VERSION to $NEW_VERSION"
-echo "$NEW_VERSION" > "$VERSION_FILE"
-git add "$VERSION_FILE"
-git commit -m "$NEW_VERSION release"
-git tag -a "v$NEW_VERSION" -m "v$NEW_VERSION"
-git push origin master
-git push origin --tags
+contents="$(jq ".version = \"$NEW_VERSION\"" "$REPO_DIR/package.json")" && \
+echo "${contents}" > package.json
+git add "$REPO_DIR/docs"
+git add "$REPO_DIR/package.json"
+git add "$REPO_DIR/package-lock.json"
 
 echo "[*] Cleaning up build dirs"
-cd "$DIR"
+cd "$REPO_DIR"
 rm -Rf build dist
 
 echo "[+] Building sdist and bdist_wheel"
 python3 setup.py sdist bdist_wheel
 
+echo "[^] Pushing source to github"
+git add "$REPO_DIR/archivebox.egg-info"
+git commit -m "$NEW_VERSION release"
+git tag -a "v$NEW_VERSION" -m "v$NEW_VERSION"
+git push origin master
+git push origin --tags
+
 echo "[^] Uploading to test.pypi.org"
 python3 -m twine upload --repository testpypi dist/*
 

docker-compose.yml

@@ -31,7 +31,7 @@ services:
     # host machine, add tasks and see more info with archivebox schedule --help
     # scheduler:
     #    image: nikisweeting/archivebox:latest
-    #    command: schedule --foreground
+    #    command: schedule --foreground --every=day --depth=1 'https://getpocket.com/users/USERNA<E/feed/all'
     #    environment:
     #        - USE_COLOR=True
     #        - SHOW_PROGRESS=False

package.json

@@ -0,0 +1,19 @@
+{
+  "name": "archivebox",
+  "version": "0.4.18",
+  "description": "ArchiveBox: The self-hosted internet archive",
+  "author": "Nick Sweeting <archivebox-npm@sweeting.me>",
+  "license": "MIT",
+  "scripts": {
+    "archivebox": "./bin/archive"
+  },
+  "bin": {
+    "archivebox-node": "./bin/archive",
+    "single-file": "./node_modules/.bin/single-file",
+    "readability-extractor": "./node_modules/.bin/single-file"
+  },
+  "dependencies": {
+    "readability-extractor": "git+https://github.com/pirate/readability-extractor.git",
+    "single-file": "git+https://github.com/gildas-lormeau/SingleFile.git"
+  }
+}

setup.py

@@ -1,4 +1,6 @@
+import json
 import setuptools
+
 from pathlib import Path
 
 PKG_NAME = "archivebox"
@@ -6,13 +8,13 @@ REPO_URL = "https://github.com/pirate/ArchiveBox"
 BASE_DIR = Path(__file__).parent.resolve()
 SOURCE_DIR = BASE_DIR / PKG_NAME
 README = (BASE_DIR / "README.md").read_text()
-VERSION = (SOURCE_DIR / "VERSION").read_text().strip()
+VERSION = json.loads((BASE_DIR / "package.json").read_text().strip())['version']
 
 # To see when setup.py gets called (uncomment for debugging)
 # import sys
 # print(SOURCE_DIR, f"     (v{VERSION})")
 # print('>', sys.executable, *sys.argv)
-# raise SystemExit(0)
+
 
 setuptools.setup(
     name=PKG_NAME,
@@ -46,6 +48,7 @@ setuptools.setup(
         "ipython",
         "youtube-dl",
         "python-crontab==2.5.1",
+        "croniter==0.3.34",
         "w3lib==1.22.0",
         # Some/all of these will likely be added in the future:
         # wpull

tests/fixtures.py

@@ -15,6 +15,7 @@ def disable_extractors_dict():
     env.update({
         "USE_WGET": "false",
         "USE_SINGLEFILE": "false",
+        "USE_READABILITY": "false",
         "SAVE_PDF": "false",
         "SAVE_SCREENSHOT": "false",
         "SAVE_DOM": "false",

tests/test_args.py

@@ -8,26 +8,58 @@ def test_depth_flag_is_accepted(process, disable_extractors_dict):
                                   capture_output=True, env=disable_extractors_dict)
     assert 'unrecognized arguments: --depth' not in arg_process.stderr.decode("utf-8")
 
+
 def test_depth_flag_fails_if_it_is_not_0_or_1(process, disable_extractors_dict):
-    arg_process = subprocess.run(["archivebox", "add", "http://127.0.0.1:8080/static/example.com.html", "--depth=5"],
-                                  capture_output=True, env=disable_extractors_dict)
+    arg_process = subprocess.run(
+        ["archivebox", "add", "--depth=5", "http://127.0.0.1:8080/static/example.com.html"],
+        capture_output=True,
+        env=disable_extractors_dict,
+    )
     assert 'invalid choice' in arg_process.stderr.decode("utf-8")
-    arg_process = subprocess.run(["archivebox", "add", "http://127.0.0.1:8080/static/example.com.html", "--depth=-1"],
-                                  capture_output=True, env=disable_extractors_dict)
+    arg_process = subprocess.run(
+        ["archivebox", "add", "--depth=-1", "http://127.0.0.1:8080/static/example.com.html"],
+        capture_output=True,
+        env=disable_extractors_dict,
+    )
     assert 'invalid choice' in arg_process.stderr.decode("utf-8")
 
+
 def test_depth_flag_0_crawls_only_the_arg_page(tmp_path, process, disable_extractors_dict):
-    arg_process = subprocess.run(["archivebox", "add", "http://127.0.0.1:8080/static/example.com.html", "--depth=0"],
-                                  capture_output=True, env=disable_extractors_dict)
+    arg_process = subprocess.run(
+        ["archivebox", "add", "--depth=0", "http://127.0.0.1:8080/static/example.com.html"],
+        capture_output=True,
+        env=disable_extractors_dict,
+    )
+    
     archived_item_path = list(tmp_path.glob('archive/**/*'))[0]
     with open(archived_item_path / "index.json", "r") as f:
         output_json = json.load(f)
     assert output_json["base_url"] == "127.0.0.1:8080/static/example.com.html"
 
+
 def test_depth_flag_1_crawls_the_page_AND_links(tmp_path, process, disable_extractors_dict):
-    arg_process = subprocess.run(["archivebox", "add", "http://127.0.0.1:8080/static/example.com.html", "--depth=1"],
-                                  capture_output=True, env=disable_extractors_dict)
+    arg_process = subprocess.run(
+        ["archivebox", "add", "--depth=1", "http://127.0.0.1:8080/static/example.com.html"],
+        capture_output=True,
+        env=disable_extractors_dict,
+    )
+    
     with open(tmp_path / "index.json", "r") as f:
         archive_file = f.read()
     assert "http://127.0.0.1:8080/static/example.com.html" in archive_file
     assert "http://127.0.0.1:8080/static/iana.org.html" in archive_file
+
+
+def test_overwrite_flag_is_accepted(process, disable_extractors_dict):
+    subprocess.run(
+        ["archivebox", "add", "--depth=0", "http://127.0.0.1:8080/static/example.com.html"],
+        capture_output=True,
+        env=disable_extractors_dict,
+    )
+    arg_process = subprocess.run(
+        ["archivebox", "add", "--overwrite", "http://127.0.0.1:8080/static/example.com.html"],
+        capture_output=True,
+        env=disable_extractors_dict,
+    )
+    assert 'unrecognized arguments: --overwrite' not in arg_process.stderr.decode("utf-8")
+    assert 'favicon' in arg_process.stdout.decode('utf-8'), 'archive methods probably didnt run, did overwrite work?'

tests/test_extractors.py

@@ -21,3 +21,35 @@ def test_singlefile_works(tmp_path, process, disable_extractors_dict):
     archived_item_path = list(tmp_path.glob('archive/**/*'))[0]
     output_file = archived_item_path / "singlefile.html" 
     assert output_file.exists()
+
+def test_readability_works(tmp_path, process, disable_extractors_dict):
+    disable_extractors_dict.update({"USE_READABILITY": "true"})
+    add_process = subprocess.run(['archivebox', 'add', 'http://127.0.0.1:8080/static/example.com.html'],
+                                  capture_output=True, env=disable_extractors_dict)
+    archived_item_path = list(tmp_path.glob("archive/**/*"))[0]
+    output_file = archived_item_path / "readability" / "content.html"
+    assert output_file.exists()
+
+def test_readability_works_with_wget(tmp_path, process, disable_extractors_dict):
+    disable_extractors_dict.update({"USE_READABILITY": "true", "USE_WGET": "true"})
+    add_process = subprocess.run(['archivebox', 'add', 'http://127.0.0.1:8080/static/example.com.html'],
+                                  capture_output=True, env=disable_extractors_dict)
+    archived_item_path = list(tmp_path.glob("archive/**/*"))[0]
+    output_file = archived_item_path / "readability" / "content.html"
+    assert output_file.exists()
+
+def test_readability_works_with_singlefile(tmp_path, process, disable_extractors_dict):
+    disable_extractors_dict.update({"USE_READABILITY": "true", "USE_SINGLEFILE": "true"})
+    add_process = subprocess.run(['archivebox', 'add', 'http://127.0.0.1:8080/static/example.com.html'],
+                                  capture_output=True, env=disable_extractors_dict)
+    archived_item_path = list(tmp_path.glob("archive/**/*"))[0]
+    output_file = archived_item_path / "readability" / "content.html"
+    assert output_file.exists()
+
+def test_readability_works_with_dom(tmp_path, process, disable_extractors_dict):
+    disable_extractors_dict.update({"USE_READABILITY": "true", "SAVE_DOM": "true"})
+    add_process = subprocess.run(['archivebox', 'add', 'http://127.0.0.1:8080/static/example.com.html'],
+                                  capture_output=True, env=disable_extractors_dict)
+    archived_item_path = list(tmp_path.glob("archive/**/*"))[0]
+    output_file = archived_item_path / "readability" / "content.html"
+    assert output_file.exists()

tests/test_init.py

@@ -19,6 +19,7 @@ def test_update(tmp_path, process):
     assert "Updating existing ArchiveBox collection in this folder" in update_process.stdout.decode("utf-8")
 
 def test_add_link(tmp_path, process, disable_extractors_dict):
+    disable_extractors_dict.update({"USE_WGET": "true"})
     os.chdir(tmp_path)
     add_process = subprocess.run(['archivebox', 'add', 'http://127.0.0.1:8080/static/example.com.html'],
                                   capture_output=True, env=disable_extractors_dict)
@@ -35,6 +36,7 @@ def test_add_link(tmp_path, process, disable_extractors_dict):
     assert "Example Domain" in output_html
 
 def test_add_link_support_stdin(tmp_path, process, disable_extractors_dict):
+    disable_extractors_dict.update({"USE_WGET": "true"})
     os.chdir(tmp_path)
     stdin_process = subprocess.Popen(["archivebox", "add"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
                                       env=disable_extractors_dict)