0.4.14 release

Switch Docker to use chromium instead of Google Chrome

.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

@@ -27,11 +27,6 @@ jobs:
           # one pass for small stylistic things
           flake8 archivebox --count --max-line-length="$MAX_LINE_LENGTH" --statistics
 
-      # - name: Lint with mypy
-      #   run: |
-      #     pip install mypy
-      #     mypy archivebox || true
-
   test:
     runs-on: ${{ matrix.os }}
 
@@ -45,37 +40,69 @@ jobs:
         with:
           fetch-depth: 1
 
+      ### Setup Python & JS Languages
       - name: Set up Python ${{ matrix.python }}
         uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.python }}
           architecture: x64
 
-      - name: Cache virtualenv
-        uses: actions/cache@v2
-        id: cache-venv
+      - name: Set up Node JS 14.7.0
+        uses: actions/setup-node@v1
         with:
-          path: .venv
+          node-version: 14.7.0
+
+      ### Install Python & JS Dependencies
+      - name: Get pip cache dir
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+
+      - name: Cache pip
+        uses: actions/cache@v2
+        id: cache-pip
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
           key: ${{ runner.os }}-${{ matrix.python }}-venv-${{ hashFiles('setup.py') }}
           restore-keys: |
             ${{ runner.os }}-${{ matrix.python }}-venv-
 
-      - name: Create virtualenv
-        if: steps.cache-venv.outputs.cache-hit != 'true'
+      - name: Install pip dependencies
         run: |
-          python3 -m venv .venv
-          source .venv/bin/activate
-          python3 -m pip install --upgrade pip setuptools
-
-      - name: Install dependencies
-        run: |
-          source .venv/bin/activate
           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: |
-          source .venv/bin/activate
           python -m pytest -s
 
   docker-test:
@@ -115,31 +142,16 @@ jobs:
           docker run -v "$PWD"/data:/data archivebox list | grep -q "www.test-nginx-1.local" || { echo "The site 1 isn't in the list"; exit 1; }
           docker run -v "$PWD"/data:/data archivebox list | grep -q "www.test-nginx-2.local" || { echo "The site 2 isn't in the list"; exit 1; }
 
-
       - name: Start docker-compose stack
         run: |
           docker-compose run archivebox init
           docker-compose up -d
-          sleep 4
+          sleep 5
+          curl --silent --location 'http://127.0.0.1:8000' | grep 'ArchiveBox'
           curl --silent --location 'http://127.0.0.1:8000/static/admin/js/jquery.init.js' | grep 'django.jQuery'
 
       - name: Check added urls show up in index
         run: |
           docker-compose run archivebox add 'http://example.com/#test_docker' --index-only
           curl --silent --location 'http://127.0.0.1:8000' | grep 'http://example.com/#test_docker'
-
-      - name: Curl index with PUBLIC_INDEX=False
-        run: |
-          docker-compose run archivebox config --set PUBLIC_INDEX=False
-          docker-compose up -d || true
-          sleep 8
-          curl --silent --location 'http://127.0.0.1:8000' | grep 'Log in'
-          docker-compose down
-
-      - name: Curl index with PUBLIC_INDEX=True
-        run: |
-          docker-compose run archivebox config --set PUBLIC_INDEX=True
-          docker-compose up -d || true
-          sleep 8
-          curl --silent --location 'http://127.0.0.1:8000' | grep 'Add Links'
-          docker-compose down
+          docker-compose down || true

.gitignore

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

Dockerfile

@@ -1,68 +1,107 @@
-# 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 \
-    VENV_PATH=/venv \
-    DATA_PATH=/data
+    DEBIAN_FRONTEND=noninteractive \
+    APT_KEY_DONT_WARN_ON_DANGEROUS_USAGE=1
 
-# First install CLI utils and base deps, then Chrome + Fons
-RUN echo 'debconf debconf/frontend select Noninteractive' | debconf-set-selections \
-    && apt-get update -qq \
+# Application-level base config
+ENV CODE_DIR=/app \
+    VENV_PATH=/venv \
+    DATA_DIR=/data \
+    NODE_DIR=/node \
+    ARCHIVEBOX_USER="archivebox"
+
+# 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 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 \
-    && 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 \
+        apt-transport-https ca-certificates gnupg2 zlib1g-dev \
+        dumb-init gosu unzip curl \
     && rm -rf /var/lib/apt/lists/*
 
-# Run everything from here on out as non-privileged user
-RUN groupadd --system archivebox \
-    && useradd --system --create-home --gid archivebox --groups audio,video archivebox
+# 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/*
 
-ADD . "$CODE_PATH"
-WORKDIR "$CODE_PATH"
+# 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 \
+        nodejs \
+    && rm -rf /var/lib/apt/lists/*
+
+# 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"
+# 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_SANDBOX=False \
+    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"
+
+# Print version for nice docker finish summary
+RUN archivebox version
+
+# Open up the interfaces to the outside world
+VOLUME "$DATA_DIR"
+VOLUME "$CODE_DIR"
 EXPOSE 8000
-ENV CHROME_BINARY=google-chrome \
-    CHROME_SANDBOX=False
 
-RUN env ALLOW_ROOT=True archivebox version
-
-ENTRYPOINT ["dumb-init", "--", "/app/bin/docker_entrypoint.sh", "archivebox"]
-CMD ["server", "0.0.0.0:8000"]
+ENTRYPOINT ["dumb-init", "--", "/app/bin/docker_entrypoint.sh"]
+CMD ["archivebox", "server", "0.0.0.0:8000"]

README.md

@@ -19,18 +19,10 @@
 <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.5-yellow.svg?logo=python&logoColor=yellow"/></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/>
-<br/>
-<i>💥 Attention: Big API changes are coming with the current release (including <code>pip install archivebox</code>)!
-<br/><br/>
-See the <a href="https://github.com/pirate/ArchiveBox/pull/207#issuecomment-494107553">v0.4 release PR</a> for more information.</b>
-<br/>
-<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).**
@@ -49,7 +41,7 @@ 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, just open the generated `output/index.html` in a browser to view the archive. 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).
+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">
 
@@ -70,18 +62,21 @@ To get started, you can [install them manually](https://github.com/pirate/Archiv
 ```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 -p 8000 nikisweeting:archivebox server
-open https://127.0.0.1:8000
+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
-# Download https://github.com/pirate/ArchiveBox/tree/master/docker-compose.yml
+# 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
@@ -107,7 +102,7 @@ archivebox manage createsuperuser
 archivebox server
 ```
 
-You can visit `https://127.0.0.1:8000` in your browser to access it.
+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.
@@ -128,16 +123,18 @@ 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 `./archive` adds only new, unique links into `output/` 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).
+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 `output/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.
+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 ~/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)
@@ -149,7 +146,7 @@ See the [Usage: CLI](https://github.com/pirate/ArchiveBox/wiki/Usage#CLI-Usage)
 #### Saves lots of useful stuff for each imported link:
 
 ```bash
- ls output/archive/<timestamp>/
+ ls ./archive/<timestamp>/
 ```
 
 - **Index:** `index.html` & `index.json` HTML and JSON index files containing metadata and details
@@ -289,16 +286,8 @@ make html
 <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.</i></sub>
+<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/>
-Contributor Spotlight:<br/><br/>
- 
-<a href="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/links/0"><img src="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/images/0"></a>
-<a href="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/links/1"><img src="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/images/1"></a>
-<a href="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/links/2"><img src="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/images/2"></a>
-<a href="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/links/3"><img src="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/images/3"></a>
-<a href="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/links/4"><img src="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/images/4"></a>
-<a href="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/links/5"><img src="https://sourcerer.io/fame/pirate/pirate/ArchiveBox/images/5"></a>
 
 <br/>
 <a href="https://github.com/sponsors/pirate">Sponsor us on Github</a>

_config.yml

@@ -1 +1 @@
-theme: jekyll-theme-merlot
+theme: jekyll-theme-minimal

archivebox.egg-info/PKG-INFO

@@ -0,0 +1,352 @@
+Metadata-Version: 2.1
+Name: archivebox
+Version: 0.4.13
+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,124 @@
+LICENSE
+MANIFEST.in
+README.md
+setup.py
+archivebox/VERSION
+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_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,25 @@
+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
+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 +1 @@
-0.4.9
+0.4.14

archivebox/cli/archivebox_oneshot.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+
+__package__ = 'archivebox.cli'
+__command__ = 'archivebox oneshot'
+
+import sys
+import argparse
+
+from pathlib import Path
+from typing import List, Optional, IO
+
+from ..main import oneshot
+from ..util import docstring
+from ..config import OUTPUT_DIR
+from ..logging_util import SmartFormatter, accept_stdin, stderr
+
+
+@docstring(oneshot.__doc__)
+def main(args: Optional[List[str]]=None, stdin: Optional[IO]=None, pwd: Optional[str]=None) -> None:
+    parser = argparse.ArgumentParser(
+        prog=__command__,
+        description=oneshot.__doc__,
+        add_help=True,
+        formatter_class=SmartFormatter,
+    )
+    parser.add_argument(
+        'url',
+        type=str,
+        default=None,
+        help=(
+            'URLs or paths to archive e.g.:\n'
+            '    https://getpocket.com/users/USERNAME/feed/all\n'
+            '    https://example.com/some/rss/feed.xml\n'
+            '    https://example.com\n'
+            '    ~/Downloads/firefox_bookmarks_export.html\n'
+            '    ~/Desktop/sites_list.csv\n'
+        )
+    )
+    parser.add_argument(
+        '--out-dir',
+        type=str,
+        default=OUTPUT_DIR,
+        help= "Path to save the single archive folder to, e.g. ./example.com_archive"
+    )
+    command = parser.parse_args(args or ())
+    url = command.url
+    stdin_url = accept_stdin(stdin)
+    if (stdin_url and url) or (not stdin and not url):
+        stderr(
+            '[X] You must pass a URL/path to add via stdin or CLI arguments.\n',
+            color='red',
+        )
+        raise SystemExit(2)
+    
+    oneshot(
+        url=stdin_url or url,
+        out_dir=str(Path(command.out_dir).absolute()),
+    )
+
+
+if __name__ == '__main__':
+    main(args=sys.argv[1:], stdin=sys.stdin)

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

@@ -45,6 +45,7 @@ CONFIG_DEFAULTS: Dict[str, ConfigDefaultDict] = {
         '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']},
+        'IN_DOCKER':                {'type': bool,  'default': False},
         # TODO: 'SHOW_HINTS':       {'type:  bool,  'default': True},
     },
 
@@ -61,6 +62,7 @@ CONFIG_DEFAULTS: Dict[str, ConfigDefaultDict] = {
 
     '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},
@@ -74,6 +76,8 @@ CONFIG_DEFAULTS: Dict[str, ConfigDefaultDict] = {
         'SAVE_FAVICON':             {'type': bool,  'default': True, 'aliases': ('FETCH_FAVICON',)},
         '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',)},
@@ -97,13 +101,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': False},
+        'USE_READABILITY':          {'type': bool,  'default': False},
         'USE_GIT':                  {'type': bool,  'default': True},
         'USE_CHROME':               {'type': bool,  'default': True},
         'USE_YOUTUBEDL':            {'type': bool,  'default': True},
@@ -111,6 +116,8 @@ CONFIG_DEFAULTS: Dict[str, ConfigDefaultDict] = {
         'CURL_BINARY':              {'type': str,   'default': 'curl'},
         '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},
     },
@@ -236,7 +243,7 @@ DERIVED_CONFIG_DEFAULTS: ConfigDefaultDict = {
     'DJANGO_BINARY':            {'default': lambda c: django.__file__.replace('__init__.py', 'bin/django-admin.py')},
     'DJANGO_VERSION':           {'default': lambda c: '{}.{}.{} {} ({})'.format(*django.VERSION)},
 
-    'USE_CURL':                 {'default': lambda c: c['USE_CURL'] and (c['SAVE_FAVICON'] or c['FETCH_TITLE'] or c['SAVE_ARCHIVE_DOT_ORG'])},
+    'USE_CURL':                 {'default': lambda c: c['USE_CURL'] and (c['SAVE_FAVICON'] or c['SAVE_TITLE'] or c['SAVE_ARCHIVE_DOT_ORG'])},
     'CURL_VERSION':             {'default': lambda c: bin_version(c['CURL_BINARY']) if c['USE_CURL'] else None},
     'CURL_USER_AGENT':          {'default': lambda c: c['CURL_USER_AGENT'].format(**c)},
     'SAVE_FAVICON':             {'default': lambda c: c['USE_CURL'] and c['SAVE_FAVICON']},
@@ -249,6 +256,12 @@ DERIVED_CONFIG_DEFAULTS: ConfigDefaultDict = {
     'SAVE_WGET':                {'default': lambda c: c['USE_WGET'] and c['SAVE_WGET']},
     'SAVE_WARC':                {'default': lambda c: c['USE_WGET'] and c['SAVE_WARC']},
 
+    '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']},
@@ -258,12 +271,14 @@ DERIVED_CONFIG_DEFAULTS: ConfigDefaultDict = {
     'SAVE_MEDIA':               {'default': lambda c: c['USE_YOUTUBEDL'] and c['SAVE_MEDIA']},
     'SAVE_PLAYLISTS':           {'default': lambda c: c['SAVE_PLAYLISTS'] and c['SAVE_MEDIA']},
 
-    'USE_CHROME':               {'default': lambda c: c['USE_CHROME'] and (c['SAVE_PDF'] or c['SAVE_SCREENSHOT'] or c['SAVE_DOM'])},
+    'USE_CHROME':               {'default': lambda c: c['USE_CHROME'] and (c['SAVE_PDF'] or c['SAVE_SCREENSHOT'] or c['SAVE_DOM'] or c['SAVE_SINGLEFILE'])},
     'CHROME_BINARY':            {'default': lambda c: c['CHROME_BINARY'] if c['CHROME_BINARY'] else find_chrome_binary()},
     'CHROME_VERSION':           {'default': lambda c: bin_version(c['CHROME_BINARY']) if c['USE_CHROME'] else None},
     'SAVE_PDF':                 {'default': lambda c: c['USE_CHROME'] and c['SAVE_PDF']},
     '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)},
@@ -674,6 +689,20 @@ def get_dependency_info(config: ConfigDict) -> ConfigValue:
             'enabled': config['USE_WGET'],
             'is_valid': bool(config['WGET_VERSION']),
         },
+        'SINGLEFILE_BINARY': {
+            'path': bin_path(config['SINGLEFILE_BINARY']),
+            'version': config['SINGLEFILE_VERSION'],
+            'hash': bin_hash(config['SINGLEFILE_BINARY']),
+            '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'],
@@ -723,6 +752,9 @@ def load_all_config():
 CONFIG = load_all_config()
 globals().update(CONFIG)
 
+# Timezone set as UTC
+os.environ["TZ"] = 'UTC'
+
 
 ############################## Importable Checkers #############################
 
@@ -764,9 +796,16 @@ 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:
+    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 ""
+
+
 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')
+        '{}: {} ({}). {}'.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()
         if info['enabled'] and not info['is_valid']
     ]

archivebox/config/stubs.py

@@ -29,6 +29,7 @@ class ConfigDict(BaseConfig, total=False):
     IS_TTY: bool
     USE_COLOR: bool
     SHOW_PROGRESS: bool
+    IN_DOCKER: bool
 
     OUTPUT_DIR: str
     CONFIG_FILE: str
@@ -39,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
@@ -53,6 +55,7 @@ class ConfigDict(BaseConfig, total=False):
     SAVE_PDF: bool
     SAVE_SCREENSHOT: bool
     SAVE_DOM: bool
+    SAVE_SINGLEFILE: bool
     SAVE_WARC: bool
     SAVE_GIT: bool
     SAVE_MEDIA: bool
@@ -75,12 +78,14 @@ class ConfigDict(BaseConfig, total=False):
     USE_GIT: bool
     USE_CHROME: bool
     USE_YOUTUBEDL: bool
+    USE_SINGLEFILE: bool
 
     CURL_BINARY: Optional[str]
     GIT_BINARY: Optional[str]
     WGET_BINARY: Optional[str]
     YOUTUBEDL_BINARY: Optional[str]
     CHROME_BINARY: Optional[str]
+    SINGLEFILE_BINARY: Optional[str]
 
     TERM_WIDTH: Callable[[], int]
     USER: str

archivebox/core/admin.py

@@ -56,8 +56,8 @@ delete_snapshots.short_description = "Delete"
 
 
 class SnapshotAdmin(admin.ModelAdmin):
-    list_display = ('added', 'title_str', 'url_str', 'files', 'size', 'updated')
-    sort_fields = ('title_str', 'url_str', 'added', 'updated')
+    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')
     search_fields = ('url', 'timestamp', 'title', 'tags')
     fields = ('title', 'tags', *readonly_fields)
@@ -97,7 +97,7 @@ class SnapshotAdmin(admin.ModelAdmin):
         canon = link.canonical_outputs()
         out_dir = Path(link.link_dir)
 
-        link_tuple = lambda link, method: (link.archive_path, canon[method], canon[method] and (out_dir / canon[method]).exists())
+        link_tuple = lambda link, method: (link.archive_path, canon[method] or '', canon[method] and (out_dir / (canon[method] or 'notdone')).exists())
 
         return format_html(
             '<span class="files-icons" style="font-size: 1.2em; opacity: 0.8">'
@@ -106,6 +106,7 @@ class SnapshotAdmin(admin.ModelAdmin):
                 '<a href="/{}/{}" class="exists-{}" title="Screenshot">🖥 </a> '
                 '<a href="/{}/{}" class="exists-{}" title="HTML dump">🅷 </a> '
                 '<a href="/{}/{}/" class="exists-{}" title="WARC">🆆 </a> '
+                '<a href="/{}/{}" class="exists-{}" title="SingleFile">&#128476; </a>'
                 '<a href="/{}/{}/" class="exists-{}" title="Media files">📼 </a> '
                 '<a href="/{}/{}/" class="exists-{}" title="Git repos">📦 </a> '
                 '<a href="{}" class="exists-{}" title="Archive.org snapshot">🏛 </a> '
@@ -115,6 +116,7 @@ class SnapshotAdmin(admin.ModelAdmin):
             *link_tuple(link, 'screenshot_path'),
             *link_tuple(link, 'dom_path'),
             *link_tuple(link, 'warc_path')[:2], any((out_dir / canon['warc_path']).glob('*.warc.gz')),
+            *link_tuple(link, 'singlefile_path'),
             *link_tuple(link, 'media_path')[:2], any((out_dir / canon['media_path']).glob('*')),
             *link_tuple(link, 'git_path')[:2], any((out_dir / canon['git_path']).glob('*')),
             canon['archive_org_path'], (out_dir / 'archive.org.txt').exists(),

archivebox/extractors/__init__.py

@@ -25,6 +25,8 @@ from ..logging_util import (
 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
@@ -32,22 +34,34 @@ from .git import should_save_git, save_git
 from .media import should_save_media, save_media
 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),
+            ('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 archive_link(link: Link, overwrite: bool=False, methods: Optional[Iterable[str]]=None, out_dir: Optional[str]=None) -> Link:
+def ignore_methods(to_ignore: List[str]):
+    ARCHIVE_METHODS = get_default_archive_methods()
+    methods = filter(lambda x: x[0] not in to_ignore, ARCHIVE_METHODS)
+    methods = map(lambda x: x[1], methods)
+    return list(methods)
+
+@enforce_types
+def archive_link(link: Link, overwrite: bool=False, methods: Optional[Iterable[str]]=None, out_dir: Optional[str]=None, skip_index: bool=False) -> Link:
     """download the DOM, PDF, and a screenshot into a folder named after the link's timestamp"""
 
-    ARCHIVE_METHODS = [
-        ('title', should_save_title, save_title),
-        ('favicon', should_save_favicon, save_favicon),
-        ('wget', should_save_wget, save_wget),
-        ('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),
-    ]
+    ARCHIVE_METHODS = get_default_archive_methods()
+    
     if methods is not None:
         ARCHIVE_METHODS = [
             method for method in ARCHIVE_METHODS
@@ -61,7 +75,7 @@ def archive_link(link: Link, overwrite: bool=False, methods: Optional[Iterable[s
             os.makedirs(out_dir)
 
         link = load_link_details(link, out_dir=out_dir)
-        write_link_details(link, out_dir=link.link_dir)
+        write_link_details(link, out_dir=out_dir, skip_sql_index=skip_index)
         log_link_archiving_started(link, out_dir, is_new)
         link = link.overwrite(updated=datetime.now())
         stats = {'skipped': 0, 'succeeded': 0, 'failed': 0}
@@ -81,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('      X {}'.format(method_name))
                     stats['skipped'] += 1
             except Exception as e:
                 raise Exception('Exception in archive_methods.save_{}(Link(url={}))'.format(
@@ -97,8 +112,9 @@ def archive_link(link: Link, overwrite: bool=False, methods: Optional[Iterable[s
         except Exception:
             pass
 
-        write_link_details(link, out_dir=link.link_dir)
-        patch_main_index(link)
+        write_link_details(link, out_dir=out_dir, skip_sql_index=skip_index)
+        if not skip_index:
+            patch_main_index(link)
 
         # # If any changes were made, update the main links index json and html
         # was_changed = stats['succeeded'] or stats['failed']

archivebox/extractors/readability.py

@@ -0,0 +1,113 @@
+__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 (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)
+
+    document = get_html(link, out_dir)
+    temp_doc = NamedTemporaryFile(delete=False)
+    temp_doc.write(document.encode("utf-8"))
+    temp_doc.close()
+    # Readability Docs: https://github.com/mozilla/readability
+    cmd = [
+        READABILITY_BINARY,
+        temp_doc.name
+    ]
+
+    status = 'succeeded'
+    timer = TimedProgress(timeout, prefix='      ')
+    try:
+        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

@@ -0,0 +1,87 @@
+__package__ = 'archivebox.extractors'
+
+from pathlib import Path
+
+from typing import Optional
+import json
+
+from ..index.schema import Link, ArchiveResult, ArchiveError
+from ..system import run, chmod_file
+from ..util import (
+    enforce_types,
+    is_static_file,
+    chrome_args,
+)
+from ..config import (
+    TIMEOUT,
+    SAVE_SINGLEFILE,
+    SINGLEFILE_BINARY,
+    SINGLEFILE_VERSION,
+    CHROME_BINARY,
+)
+from ..logging_util import TimedProgress
+
+
+@enforce_types
+def should_save_singlefile(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) / 'singlefile.html'
+    return SAVE_SINGLEFILE and (not output.exists())
+
+
+@enforce_types
+def save_singlefile(link: Link, out_dir: Optional[str]=None, timeout: int=TIMEOUT) -> ArchiveResult:
+    """download full site using single-file"""
+
+    out_dir = out_dir or link.link_dir
+    output = str(Path(out_dir).absolute() / "singlefile.html")
+
+    browser_args = chrome_args(TIMEOUT=0)
+
+    # SingleFile CLI Docs: https://github.com/gildas-lormeau/SingleFile/tree/master/cli
+    cmd = [
+        SINGLEFILE_BINARY,
+        '--browser-executable-path={}'.format(CHROME_BINARY),
+        '--browser-args="{}"'.format(json.dumps(browser_args[1:])),
+        link.url,
+        output
+    ]
+
+    status = 'succeeded'
+    timer = TimedProgress(timeout, prefix='      ')
+    try:
+        result = run(cmd, cwd=out_dir, timeout=timeout)
+
+        # 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 single-file response code: {}.'.format(result.returncode),
+            *output_tail,
+        )
+
+        # Check for common failure cases
+        if (result.returncode > 0):
+            raise ArchiveError('SingleFile was not able to archive the page', hints)
+        chmod_file(output)
+    except Exception as err:
+        status = 'failed'
+        output = err
+    finally:
+        timer.end()
+
+    return ArchiveResult(
+        cmd=cmd,
+        pwd=out_dir,
+        cmd_version=SINGLEFILE_VERSION,
+        output=output,
+        status=status,
+        **timer.stats,
+    )

archivebox/index/__init__.py

@@ -354,12 +354,13 @@ def patch_main_index(link: Link, out_dir: str=OUTPUT_DIR) -> None:
 ### Link Details Index
 
 @enforce_types
-def write_link_details(link: Link, out_dir: Optional[str]=None) -> None:
+def write_link_details(link: Link, out_dir: Optional[str]=None, skip_sql_index: bool=False) -> None:
     out_dir = out_dir or link.link_dir
 
     write_json_link_details(link, out_dir=out_dir)
     write_html_link_details(link, out_dir=out_dir)
-    write_sql_link_details(link)
+    if not skip_sql_index:
+        write_sql_link_details(link)
 
 
 @enforce_types

archivebox/index/schema.py

@@ -365,6 +365,7 @@ class Link:
             'screenshot.png',
             'output.html',
             'media',
+            'singlefile.html'
         )
 
         return any(
@@ -376,7 +377,7 @@ class Link:
         """get the latest output that each archive method produced for link"""
         
         ARCHIVE_METHODS = (
-            'title', 'favicon', 'wget', 'warc', 'pdf',
+            'title', 'favicon', 'wget', 'warc', 'singlefile', 'pdf',
             'screenshot', 'dom', 'git', 'media', 'archive_org',
         )
         latest: Dict[str, ArchiveOutput] = {}
@@ -392,7 +393,6 @@ class Link:
                 latest[archive_method] = history[0].output
             else:
                 latest[archive_method] = None
-
         return latest
 
 
@@ -406,6 +406,8 @@ class Link:
             'google_favicon_path': 'https://www.google.com/s2/favicons?domain={}'.format(self.domain),
             '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',
@@ -425,7 +427,8 @@ class Link:
                 'pdf_path': static_path,
                 'screenshot_path': static_path,
                 'dom_path': static_path,
+                'singlefile_path': static_path,
+                'readability_path': static_path,
             })
         return canonical
 
-

archivebox/logging_util.py

@@ -518,6 +518,7 @@ def printable_folder_status(name: str, folder: Dict) -> str:
 
 @enforce_types
 def printable_dependency_version(name: str, dependency: Dict) -> str:
+    version = None
     if dependency['enabled']:
         if dependency['is_valid']:
             color, symbol, note, version = 'green', '√', 'valid', ''

archivebox/main.py

@@ -18,6 +18,7 @@ from .cli import (
 from .parsers import (
     save_text_as_source,
     save_file_as_source,
+    parse_links_memory,
 )
 from .index.schema import Link
 from .util import enforce_types                         # type: ignore
@@ -51,12 +52,13 @@ from .index.sql import (
     remove_from_sql_main_index,
 )
 from .index.html import parse_html_main_index
-from .extractors import archive_links
+from .extractors import archive_links, archive_link, ignore_methods
 from .config import (
     stderr,
     ConfigDict,
     ANSI,
-    # IS_TTY,
+    IS_TTY,
+    IN_DOCKER,
     USER,
     ARCHIVEBOX_BINARY,
     ONLY_NEW,
@@ -177,6 +179,10 @@ def help(out_dir: str=OUTPUT_DIR) -> None:
     else:
         print('{green}Welcome to ArchiveBox v{}!{reset}'.format(VERSION, **ANSI))
         print()
+        if IN_DOCKER:
+            print('When using Docker, you need to mount a volume to use as your data dir:')
+            print('    docker run -v /some/path:/data archivebox ...')
+            print()
         print('To import an existing archive (from a previous version of ArchiveBox):')
         print('    1. cd into your data dir OUTPUT_DIR (usually ArchiveBox/output) and run:')
         print('    2. archivebox init')
@@ -210,14 +216,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()
@@ -493,6 +500,23 @@ def status(out_dir: str=OUTPUT_DIR) -> None:
     print(ANSI['black'], '   ...', ANSI['reset'])
 
 
+@enforce_types
+def oneshot(url: str, out_dir: str=OUTPUT_DIR):
+    """
+    Create a single URL archive folder with an index.json and index.html, and all the archive method outputs.
+    You can run this to archive single pages without needing to create a whole collection with archivebox init.
+    """
+    oneshot_link, _ = parse_links_memory([url])
+    if len(oneshot_link) > 1:
+        stderr(
+                '[X] You should pass a single url to the oneshot command',
+                color='red'
+            )
+        raise SystemExit(2)
+    methods = ignore_methods(['title'])
+    archive_link(oneshot_link[0], out_dir=out_dir, methods=methods, skip_index=True)
+    return oneshot_link
+
 @enforce_types
 def add(urls: Union[str, List[str]],
         depth: int=0,
@@ -1039,10 +1063,14 @@ def manage(args: Optional[List[str]]=None, out_dir: str=OUTPUT_DIR) -> None:
     """Run an ArchiveBox Django management command"""
 
     check_data_folder(out_dir=out_dir)
-
     setup_django(out_dir)
     from django.core.management import execute_from_command_line
 
+    if (args and "createsuperuser" in args) and (IN_DOCKER and not IS_TTY):
+        stderr('[!] Warning: you need to pass -it to use interactive commands in docker', color='lightyellow')
+        stderr('    docker run -it archivebox manage {}'.format(' '.join(args or ['...'])), color='lightyellow')
+        stderr()
+
     execute_from_command_line([f'{ARCHIVEBOX_BINARY} manage', *(args or ['help'])])
 
 
@@ -1055,3 +1083,4 @@ def shell(out_dir: str=OUTPUT_DIR) -> None:
     setup_django(OUTPUT_DIR)
     from django.core.management import call_command
     call_command("shell_plus")
+

archivebox/parsers/__init__.py

@@ -9,8 +9,9 @@ __package__ = 'archivebox.parsers'
 
 import re
 import os
+from io import StringIO
 
-from typing import Tuple, List
+from typing import IO, Tuple, List
 from datetime import datetime
 
 from ..system import atomic_write
@@ -37,15 +38,7 @@ from .generic_rss import parse_generic_rss_export
 from .generic_json import parse_generic_json_export
 from .generic_txt import parse_generic_txt_export
 
-
-@enforce_types
-def parse_links(source_file: str) -> Tuple[List[Link], str]:
-    """parse a list of URLs with their metadata from an 
-       RSS feed, bookmarks export, or text file
-    """
-
-    check_url_parsing_invariants()
-    PARSERS = (
+PARSERS = (
         # Specialized parsers
         ('Pocket HTML', parse_pocket_html_export),
         ('Pinboard RSS', parse_pinboard_rss_export),
@@ -60,30 +53,66 @@ def parse_links(source_file: str) -> Tuple[List[Link], str]:
         # Fallback parser
         ('Plain Text', parse_generic_txt_export),
     )
+
+@enforce_types
+def parse_links_memory(urls: List[str]):
+    """
+    parse a list of URLS without touching the filesystem
+    """
+    check_url_parsing_invariants()
+
     timer = TimedProgress(TIMEOUT * 4)
-    with open(source_file, 'r', encoding='utf-8') as file:
-        for parser_name, parser_func in PARSERS:
-            try:
-                links = list(parser_func(file))
-                if links:
-                    timer.end()
-                    return links, parser_name
-            except Exception as err:   # noqa
-                pass
-                # 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
+    #urls = list(map(lambda x: x + "\n", urls))
+    file = StringIO()
+    file.writelines(urls)
+    file.name = "io_string"
+    output = _parse(file, timer)
+
+    if output is not None:
+        return output
 
     timer.end()
     return [], 'Failed to parse'
+    
+
+@enforce_types
+def parse_links(source_file: str) -> Tuple[List[Link], str]:
+    """parse a list of URLs with their metadata from an 
+       RSS feed, bookmarks export, or text file
+    """
+
+    check_url_parsing_invariants()
+
+    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
+
+    timer.end()
+    return [], 'Failed to parse'
+
+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
+            # 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
 
 
 @enforce_types
 def save_text_as_source(raw_text: str, filename: str='{ts}-stdin.txt', out_dir: str=OUTPUT_DIR) -> str:
     ts = str(datetime.now().timestamp()).split('.', 1)[0]
-    source_path = os.path.join(OUTPUT_DIR, SOURCES_DIR_NAME, filename.format(ts=ts))
+    source_path = os.path.join(out_dir, SOURCES_DIR_NAME, filename.format(ts=ts))
     atomic_write(source_path, raw_text)
     log_source_saved(source_file=source_path)
     return source_path

archivebox/themes/legacy/link_details.html

@@ -79,6 +79,7 @@
             .card {
                 overflow: hidden;
                 box-shadow: 2px 3px 14px 0px rgba(0,0,0,0.02);
+                margin-top: 10px;
             }
             .card h4 {
                 font-size: 1.4vw;
@@ -335,6 +336,30 @@
                           </div>
                         </div>
                     </div>
+                    <div class="col-lg-2">
+                        <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>
+                          </div>
+                        </div>
+                    </div>
+                    <div class="col-lg-2">
+                        <div class="card">
+                          <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>
                     <div class="col-lg-2">
                         <div class="card">
                           <iframe class="card-img-top pdf-frame" src="$pdf_path" scrolling="no"></iframe>

archivebox/util.py

@@ -1,3 +1,5 @@
+__package__ = 'archivebox'
+
 import re
 import json as pyjson
 

bin/archive

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+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/docker_entrypoint.sh

@@ -1,7 +1,5 @@
 #!/usr/bin/env bash
 
-COMMAND="$*"
-
 # Autodetect UID,GID of host user based on ownership of files in the data volume
 DATA_DIR="${DATA_DIR:-/data}"
 ARCHIVEBOX_USER="${ARCHIVEBOX_USER:-archivebox}"
@@ -18,8 +16,19 @@ if [[ "$USID" != 0 && "$GRID" != 0 ]]; then
     chown "$USID":"$GRID" "$DATA_DIR/*" > /dev/null 2>&1 || true
 fi
 
-# run django as the new archivebox user
-# any files touched will have the same uid,gid
-# inside docker and outside docker on the host
-gosu "$ARCHIVEBOX_USER" bash -c "$COMMAND"
-# e.g. "archivebox server"
+# Run commands as the new archivebox user in Docker.
+#   Any files touched will have the same uid & gid
+#   inside Docker and outside on the host machine.
+if [[ "$1" == /* || "$1" == "echo" || "$1" == "archivebox" ]]; then
+    # arg 1 is a binary, execute it verbatim
+    # e.g. "archivebox init"
+    #      "/bin/bash"
+    #      "echo"
+    gosu "$ARCHIVEBOX_USER" bash -c "$*"
+else
+    # no command given, assume args were meant to be passed to archivebox cmd
+    # e.g. "add https://example.com"
+    #      "manage createsupseruser"
+    #      "server 0.0.0.0:8000"
+    gosu "$ARCHIVEBOX_USER" bash -c "archivebox $*"
+fi

docker-compose.yml

@@ -1,10 +1,9 @@
-# This docker-compose config for ArchiveBox runs the following containers:
-#     - ArchiveBox (it creates the initial archive, then sleeps forever to allow commands to be run with exec to add links)
-#     - nginx webserver running on https://127.0.0.1:8098
 # Usage:
 #     docker-compose up -d
+#     docker-compose run archivebox init
 #     echo "https://example.com" | docker-compose run archivebox archivebox add
-#     docker-compose run archivebox archivebox https://example.com/some/feed.rss
+#     docker-compose run archivebox add --depth=1 https://example.com/some/feed.rss
+#     docker-compose run archivebox config --set PUBLIC_INDEX=True
 # Documentation:
 #     https://github.com/pirate/ArchiveBox/wiki/Docker#docker-compose
 
@@ -22,10 +21,48 @@ services:
         environment:
             - USE_COLOR=True
             - SHOW_PROGRESS=False
-            # - HTTP_PROXY=http://pywb:8080
         volumes:
             - ./data:/data
 
+
+    # Optional Addons: tweak these examples as needed for your specific use case
+
+    # Example: Run scheduled imports in a docker instead of using cron on the
+    # host machine, add tasks and see more info with archivebox schedule --help
+    # scheduler:
+    #    image: nikisweeting/archivebox:latest
+    #    command: schedule --foreground
+    #    environment:
+    #        - USE_COLOR=True
+    #        - SHOW_PROGRESS=False
+    #    volumes:
+    #        - ./data:/data
+    
+    # Example: Put Nginx in front of the ArchiveBox server for SSL termination
+    # nginx:
+    #     image: nginx:alpine
+    #     ports:
+    #         - 443:443
+    #         - 80:80
+    #     volumes:
+    #         - ./etc/nginx/nginx.conf:/etc/nginx/nginx.conf
+    #         - ./data:/var/www
+
+    # Example: run all your ArchiveBox traffic through a WireGuard VPN tunnel
+    # wireguard:
+    #   image: linuxserver/wireguard
+    #   network_mode: 'service:archivebox'
+    #   cap_add:
+    #     - NET_ADMIN
+    #     - SYS_MODULE
+    #   sysctls:
+    #     - net.ipv4.conf.all.rp_filter=2
+    #     - net.ipv4.conf.all.src_valid_mark=1
+    #   volumes:
+    #     - /lib/modules:/lib/modules
+    #     - ./wireguard.conf:/config/wg0.conf:ro
+    
+    # Example: Run PYWB in parallel and auto-import WARCs from ArchiveBox
     # pywb:
     #     image: webrecorder/pywb:latest
     #     entrypoint: /bin/sh 'wb-manager add default /archivebox/archive/*/warc/*.warc.gz; wayback --proxy;'
@@ -36,12 +73,3 @@ services:
     #     volumes:
     #         ./data:/archivebox
     #         ./data/wayback:/webarchive
-
-#    nginx:
-#        image: nginx:alpine
-#        ports:
-#            - 443:443
-#            - 80:80
-#        volumes:
-#            - ./etc/nginx/nginx.conf:/etc/nginx/nginx.conf
-#            - ./data:/var/www

etc/ArchiveBox.conf.default

@@ -54,11 +54,11 @@
 # USE_GIT = True
 
 # CURL_BINARY = curl
-# GIT_BINARY = git"
+# GIT_BINARY = git
 # WGET_BINARY = wget
 # YOUTUBEDL_BINARY = youtube-dl
 # CHROME_BINARY = chromium
 
 # CHROME_USER_DATA_DIR="~/.config/google-chrome/Default"
-# CROME_HEADLESS = True
-# CROME_SANDBOX = True
+# CHROME_HEADLESS = True
+# CHROME_SANDBOX = True

package.json

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

tests/fixtures.py

@@ -7,4 +7,20 @@ import pytest
 def process(tmp_path):
     os.chdir(tmp_path)
     process = subprocess.run(['archivebox', 'init'], capture_output=True)
-    return process
+    return process
+
+@pytest.fixture
+def disable_extractors_dict():
+    env = os.environ.copy()
+    env.update({
+        "USE_WGET": "false",
+        "USE_SINGLEFILE": "false",
+        "USE_READABILITY": "false",
+        "SAVE_PDF": "false",
+        "SAVE_SCREENSHOT": "false",
+        "SAVE_DOM": "false",
+        "USE_GIT": "false",
+        "SAVE_MEDIA": "false",
+        "SAVE_ARCHIVE_DOT_ORG": "false"
+    })
+    return env

tests/test_args.py

@@ -3,25 +3,30 @@ import json
 
 from .fixtures import *
 
-def test_depth_flag_is_accepted(process):
-    arg_process = subprocess.run(["archivebox", "add", "http://127.0.0.1:8080/static/example.com.html", "--depth=0"], capture_output=True)
+def test_depth_flag_is_accepted(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)
     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):
-    arg_process = subprocess.run(["archivebox", "add", "http://127.0.0.1:8080/static/example.com.html", "--depth=5"], capture_output=True)
+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)
     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)
+    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)
     assert 'invalid choice' in arg_process.stderr.decode("utf-8")
 
-def test_depth_flag_0_crawls_only_the_arg_page(tmp_path, process):
-    arg_process = subprocess.run(["archivebox", "add", "http://127.0.0.1:8080/static/example.com.html", "--depth=0"], capture_output=True)
+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)
     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):
-    arg_process = subprocess.run(["archivebox", "add", "http://127.0.0.1:8080/static/example.com.html", "--depth=1"], capture_output=True)
+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)
     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

tests/test_extractors.py

@@ -1,5 +1,55 @@
 from .fixtures import *
+from archivebox.extractors import ignore_methods, get_default_archive_methods, should_save_title
 
-def test_wget_broken_pipe(tmp_path, process):
-    add_process = subprocess.run(['archivebox', 'add', 'http://127.0.0.1:8080/static/example.com.html'], capture_output=True)
-    assert "TypeError chmod_file(..., path: str) got unexpected NoneType argument path=None" not in add_process.stdout.decode("utf-8")
+def test_wget_broken_pipe(tmp_path, process, disable_extractors_dict):
+    disable_extractors_dict.update({"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)
+    assert "TypeError chmod_file(..., path: str) got unexpected NoneType argument path=None" not in add_process.stdout.decode("utf-8")
+
+def test_ignore_methods():
+    """
+    Takes the passed method out of the default methods list and returns that value
+    """
+    ignored = ignore_methods(['title'])
+    assert should_save_title not in ignored
+
+def test_singlefile_works(tmp_path, process, disable_extractors_dict):
+    disable_extractors_dict.update({"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 / "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

@@ -18,9 +18,11 @@ def test_update(tmp_path, process):
     update_process = subprocess.run(['archivebox', 'init'], capture_output=True)
     assert "Updating existing ArchiveBox collection in this folder" in update_process.stdout.decode("utf-8")
 
-def test_add_link(tmp_path, process):
+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)
+    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]
 
     assert "index.json" in [x.name for x in archived_item_path.iterdir()]
@@ -33,9 +35,11 @@ def test_add_link(tmp_path, process):
         output_html = f.read()
     assert "Example Domain" in output_html
 
-def test_add_link_support_stdin(tmp_path, process):
+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)
+    stdin_process = subprocess.Popen(["archivebox", "add"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
+                                      env=disable_extractors_dict)
     stdin_process.communicate(input="http://127.0.0.1:8080/static/example.com.html".encode())
     archived_item_path = list(tmp_path.glob('archive/**/*'))[0]
 
@@ -51,9 +55,10 @@ def test_correct_permissions_output_folder(tmp_path, process):
         file_path = tmp_path / file
         assert oct(file_path.stat().st_mode)[-3:] == OUTPUT_PERMISSIONS
 
-def test_correct_permissions_add_command_results(tmp_path, process):
+def test_correct_permissions_add_command_results(tmp_path, process, disable_extractors_dict):
     os.chdir(tmp_path)
-    add_process = subprocess.run(['archivebox', 'add', 'http://127.0.0.1:8080/static/example.com.html'], capture_output=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]
     for path in archived_item_path.iterdir():
         assert oct(path.stat().st_mode)[-3:] == OUTPUT_PERMISSIONS

tests/test_oneshot.py

@@ -0,0 +1,17 @@
+from pathlib import Path
+
+from .fixtures import *
+
+def test_oneshot_command_exists(tmp_path, disable_extractors_dict):
+    os.chdir(tmp_path)
+    process = subprocess.run(['archivebox', 'oneshot'], capture_output=True, env=disable_extractors_dict)
+    assert not "invalid choice: 'oneshot'" in process.stderr.decode("utf-8")
+
+def test_oneshot_commad_saves_page_in_right_folder(tmp_path, disable_extractors_dict):
+    process = subprocess.run(["archivebox", "oneshot", f"--out-dir={tmp_path}", "http://127.0.0.1:8080/static/example.com.html"],
+                              capture_output=True, env=disable_extractors_dict)
+    items = ' '.join([str(x) for x in tmp_path.iterdir()])
+    current_path = ' '.join([str(x) for x in Path.cwd().iterdir()])
+    assert "index.json" in items
+    assert not "index.sqlite3" in current_path
+    

tests/test_remove.py

@@ -1,8 +1,8 @@
 from .fixtures import *
 
-def test_remove_leaves_index_in_consistent_state(tmp_path, process):
+def test_remove_leaves_index_in_consistent_state(tmp_path, process, disable_extractors_dict):
     os.chdir(tmp_path)
-    subprocess.run(['archivebox', 'add', 'http://127.0.0.1:8080/static/example.com.html'], capture_output=True)
+    subprocess.run(['archivebox', 'add', 'http://127.0.0.1:8080/static/example.com.html'], capture_output=True, env=disable_extractors_dict)
     remove_process = subprocess.run(['archivebox', 'remove', '127.0.0.1:8080/static/example.com.html', '--yes'], capture_output=True)
     list_process = subprocess.run(['archivebox', 'list'], capture_output=True)
     assert "Warning: SQL index does not match JSON index!" not in list_process.stderr.decode("utf-8")

tests/test_title.py

@@ -1,12 +1,13 @@
 from .fixtures import *
 
-def test_title_is_htmlencoded_in_index_html(tmp_path, process):
+def test_title_is_htmlencoded_in_index_html(tmp_path, process, disable_extractors_dict):
     """
     https://github.com/pirate/ArchiveBox/issues/330
     Unencoded content should not be rendered as it facilitates xss injections
     and breaks the layout.
     """
-    add_process = subprocess.run(['archivebox', 'add', 'http://localhost:8080/static/title_with_html.com.html'], capture_output=True)
+    add_process = subprocess.run(['archivebox', 'add', 'http://localhost:8080/static/title_with_html.com.html'],
+                                 capture_output=True, env=disable_extractors_dict)
 
     with open(tmp_path / "index.html", "r") as f:
         output_html = f.read()