starred/ArchiveBox

Fork 0

mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-04-25 09:06:02 +03:00

[PR #207] [MERGED] v0.4 (first Django release) #2608

New issue

Closed

opened 2026-03-01 18:00:07 +03:00 by kerem · 0 comments

kerem commented

2026-03-01 18:00:07 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/ArchiveBox/ArchiveBox/pull/207
Author: @pirate
Created: 4/2/2019
Status: ✅ Merged
Merged: 7/28/2020
Merged by: @pirate

Base: master ← Head: django

📝 Commits (10+)

158f145 move docstrings to main.py out of cli files
0ba821b better return status from list cmd
daf5951 allow passing debug flag to archivebox server
95007d9 split up utils into separate files
d26f87e make archivebox server work for urls, hashes, and timestamps
fc05567 bump docs version
c82651a bump docs version
cb2dd1e rename model Page to Snapshot
ad3898a allow forcing init in dirty directory
f60b5ed better stdin handling

📊 Changes

159 files changed (+12374 additions, -3732 deletions)

View changed files

📝 .dockerignore (+9 -13)
➕ .flake8 (+6 -0)
➕ .github/workflows/test.yml (+145 -0)
📝 .gitignore (+9 -14)
📝 Dockerfile (+56 -62)
➕ MANIFEST.in (+4 -0)
➕ Pipfile (+12 -0)
📝 README.md (+141 -110)
➖ archive (+0 -1)
➕ archivebox/.flake8 (+6 -0)
➕ archivebox/VERSION (+1 -0)
📝 archivebox/__init__.py (+1 -1)
➕ archivebox/__main__.py (+11 -0)
➖ archivebox/archive.py (+0 -137)
➖ archivebox/archive_methods.py (+0 -623)
➕ archivebox/cli/__init__.py (+135 -0)
➕ archivebox/cli/archivebox_add.py (+92 -0)
➕ archivebox/cli/archivebox_config.py (+61 -0)
➕ archivebox/cli/archivebox_help.py (+32 -0)
➕ archivebox/cli/archivebox_init.py (+40 -0)

...and 80 more files

📄 Description

The v0.4 Release

A bunch of big changes:

pip install archivebox is now available
beginnings of transition to Django while maintaining a mostly backwards-compatible CLI
using argparse instead of hand-written CLI system: see archivebox/cli/archivebox.py
new subcommands-based CLI for archivebox (see below)

For more info, see: https://github.com/pirate/ArchiveBox/wiki/Roadmap

Released in this version:

Install Methods:

✅ pip/pipenv install archivebox [--dev]
✅ docker run nikisweeting/archivebox / docker-compose up
❌ apt/brew/pkg/yum/nix/etc install archivebox (maybe later)

Note: apt, brew are now available as of v0.5

Command Line Interface:

✅ archivebox
✅ archivebox version
✅ archivebox help
✅ archivebox init
✅ archivebox status
✅ archivebox add
✅ archivebox remove
✅ archivebox update
✅ archivebox list
✅ archivebox schedule
✅ archivebox config
✅ archivebox server
✅ archivebox shell
✅ archivebox manage
❌ archivebox oneshot (released later in v0.5)
❌ archivebox export (use archivebox list --json > index.json)
❌ archivebox proxy (too complex)

Web UI:

✅ / Main index
✅ /add Page to add new links to the archive (but needs improvement)
✅ /archive/<timestamp>/ Snapshot details page
✅ /archive/<timestamp>/<url> live wget archive of page
✅ /archive/<timestamp>/<extractor> get a specific extractor output for a given snapshot
✅ /archive/<url> shortcut to view most recent snapshot of given url
✅ /archive/<url_hash> shortcut to view most recent snapshot of given url
✅ /admin Admin interface to view and edit archive data

Python API:

(Red ❌ features are still unfinished and will be released in later versions)

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/ArchiveBox/ArchiveBox/pull/207 **Author:** [@pirate](https://github.com/pirate) **Created:** 4/2/2019 **Status:** ✅ Merged **Merged:** 7/28/2020 **Merged by:** [@pirate](https://github.com/pirate) **Base:** `master` ← **Head:** `django` --- ### 📝 Commits (10+) - [`158f145`](https://github.com/ArchiveBox/ArchiveBox/commit/158f145d9a9a53bae982bbdadce06e96d56da7d5) move docstrings to main.py out of cli files - [`0ba821b`](https://github.com/ArchiveBox/ArchiveBox/commit/0ba821b3512c41d8c709a98daafd7015f983ebf3) better return status from list cmd - [`daf5951`](https://github.com/ArchiveBox/ArchiveBox/commit/daf595189737bd87e7dd43fe43b3d1d64fac264a) allow passing debug flag to archivebox server - [`95007d9`](https://github.com/ArchiveBox/ArchiveBox/commit/95007d9137382d5c5f56096f43778262891f59ac) split up utils into separate files - [`d26f87e`](https://github.com/ArchiveBox/ArchiveBox/commit/d26f87efefc43abf60625e0f34051c6929515584) make archivebox server work for urls, hashes, and timestamps - [`fc05567`](https://github.com/ArchiveBox/ArchiveBox/commit/fc05567babec2674c3803b9055aabd350406f49e) bump docs version - [`c82651a`](https://github.com/ArchiveBox/ArchiveBox/commit/c82651a0b02817496f43de10ca90ce4052d41a07) bump docs version - [`cb2dd1e`](https://github.com/ArchiveBox/ArchiveBox/commit/cb2dd1ee2849ef7437d6a93992013474faf6d29b) rename model Page to Snapshot - [`ad3898a`](https://github.com/ArchiveBox/ArchiveBox/commit/ad3898add6e6458d1b1c2f38c7f2365fb85d2604) allow forcing init in dirty directory - [`f60b5ed`](https://github.com/ArchiveBox/ArchiveBox/commit/f60b5ed867ee62f2730dcc949392b7cb8bd4b6a6) better stdin handling ### 📊 Changes **159 files changed** (+12374 additions, -3732 deletions) <details> <summary>View changed files</summary> 📝 `.dockerignore` (+9 -13) ➕ `.flake8` (+6 -0) ➕ `.github/workflows/test.yml` (+145 -0) 📝 `.gitignore` (+9 -14) 📝 `Dockerfile` (+56 -62) ➕ `MANIFEST.in` (+4 -0) ➕ `Pipfile` (+12 -0) 📝 `README.md` (+141 -110) ➖ `archive` (+0 -1) ➕ `archivebox/.flake8` (+6 -0) ➕ `archivebox/VERSION` (+1 -0) 📝 `archivebox/__init__.py` (+1 -1) ➕ `archivebox/__main__.py` (+11 -0) ➖ `archivebox/archive.py` (+0 -137) ➖ `archivebox/archive_methods.py` (+0 -623) ➕ `archivebox/cli/__init__.py` (+135 -0) ➕ `archivebox/cli/archivebox_add.py` (+92 -0) ➕ `archivebox/cli/archivebox_config.py` (+61 -0) ➕ `archivebox/cli/archivebox_help.py` (+32 -0) ➕ `archivebox/cli/archivebox_init.py` (+40 -0) _...and 80 more files_ </details> ### 📄 Description # The v0.4 Release A bunch of big changes: - `pip install archivebox` is now available - beginnings of transition to Django while maintaining a mostly backwards-compatible CLI - using argparse instead of hand-written CLI system: see `archivebox/cli/archivebox.py` - new subcommands-based CLI for `archivebox` (see below) For more info, see: https://github.com/pirate/ArchiveBox/wiki/Roadmap #### Released in this version: Install Methods: - ✅ [`pip/pipenv install archivebox [--dev]`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-pip-install-archivebox) - ✅ [`docker run nikisweeting/archivebox` / `docker-compose up`](https://github.com/pirate/ArchiveBox/wiki/Docker) - ❌ [`apt/brew/pkg/yum/nix/etc install archivebox`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-pip-install-archivebox) (maybe later) *Note: apt, brew are now available as of v0.5* Command Line Interface: - ✅ [`archivebox`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-help-h--help) - ✅ [`archivebox version`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-version--version) - ✅ [`archivebox help`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-help-h--help) - ✅ [`archivebox init`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-init) - ✅ [`archivebox status`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-status) - ✅ [`archivebox add`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-add) - ✅ [`archivebox remove`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-remove) - ✅ [`archivebox update`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-update) - ✅ [`archivebox list`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-list) - ✅ [`archivebox schedule`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-schedule) - ✅ [`archivebox config`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-config) - ✅ [`archivebox server`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-server) - ✅ [`archivebox shell`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-shell) - ✅ [`archivebox manage`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-manage) - ❌ [`archivebox oneshot`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-oneshot) (released later in v0.5) - ❌ [`archivebox export`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-export) (use `archivebox list --json > index.json`) - ❌ [`archivebox proxy`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#-archivebox-proxy) (too complex) Web UI: - ✅ `/` Main index - ✅ `/add` Page to add new links to the archive (but needs improvement) - ✅ `/archive/<timestamp>/` Snapshot details page - ✅ `/archive/<timestamp>/<url>` live wget archive of page - ✅ `/archive/<timestamp>/<extractor>` get a specific extractor output for a given snapshot - ✅ `/archive/<url>` shortcut to view most recent snapshot of given url - ✅ `/archive/<url_hash>` shortcut to view most recent snapshot of given url - ✅ `/admin` Admin interface to view and edit archive data Python API: - ✅ [`from archivebox import add, remove, info, config, etc...`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#api-for-normal-archivebox-usage) - ✅ [`from archivebox.core.models import Snapshot, User, etc...`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#api-for-all-useful-subcomponents) - ✅ [`from archivebox.extractors import media, wget, screenshot, etc...`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#api-for-all-useful-subcomponents) - ✅ [`from archivebox.index import json, sql, html, etc...`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#api-for-all-useful-subcomponents) - ✅ [`from archivebox.parsers import pinboard_rss, pocket_html, generic_json, etc...`](https://github.com/pirate/ArchiveBox/wiki/Roadmap#api-for-all-useful-subcomponents) (Red ❌ features are still unfinished and will be released in later versions) <img width="600" src="https://user-images.githubusercontent.com/511499/56994998-944a9080-6b6e-11e9-81a6-e3438d3c36f9.png"><img width="600" src="https://user-images.githubusercontent.com/511499/56400577-a5b4a400-6222-11e9-9cb6-c10e19a82089.png"/> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

kerem

2026-03-01 18:00:07 +03:00

closed this issue
added the
pull-request
label

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/ArchiveBox#2608

No description provided.

Rows
Columns