mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-27 08:14:38 +02:00
Code Issues Releases Wiki Activity

Updated Usage (markdown)

Nick Sweeting
2020-09-17 12:55:38 -04:00
parent cf458997c7
commit ed7ac5d5ff
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Usage.md

@@ -191,13 +191,14 @@ which are already in the index.
## Python API Usage
```python
from archivebox.main import add, info, remove, check_data_folder
from archivebox.main import add, remove, server
... # load the archive directory first, see API docs below for more info
out_dir = '~/path/to/my/data/folder'
check_data_folder(out_dir=out_dir)
add('https://example.com', index_only=True, out_dir=out_dir)
info(out_dir=out_dir)
remove('https://example.com', delete=True, yes=True, out_dir=out_dir)
remove(...)
server(...)
...
```
For more information see the [Python API Reference](https://docs.archivebox.io/en/latest/archivebox.html).