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

Updated Usage (markdown)

Nick Sweeting
2022-04-12 18:38:45 -04:00
parent 986d70ab83
commit f89e26d90e
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Usage.md

@@ -270,15 +270,18 @@ from archivebox import *
add("https://example.com/some/new/url")
```
For an advanced example of using the ArchiveBox Python shell to reset a user's password see:
For more info and example usage:
- https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives#example-adding-a-new-user-with-a-hashed-password
- https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/main.py
- https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/config.py
- https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/core/models.py
## Python API Usage
```python
import os
DATA_DIR = '~/some/path/containing/your/archivebox/data'
DATA_DIR = '~/archivebox/data'
os.chdir(DATA_DIR)
@@ -293,4 +296,7 @@ server(...)
...
```
For more information see the [Python API Reference](https://docs.archivebox.io/en/latest/archivebox.html), [Developer Documentation](https://github.com/ArchiveBox/ArchiveBox#archivebox-development), and [Python source code](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/).
For more information see:
- [ArchiveBox Python API Reference (ReadTheDocs)](https://docs.archivebox.io/en/latest/archivebox.html)
- [ArchiveBox Developer Documentation](https://github.com/ArchiveBox/ArchiveBox#archivebox-development)
- [ArchiveBox Python source code](https://github.com/ArchiveBox/ArchiveBox/blob/dev/archivebox/)