-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
abx_plugin_readwise
Nick Sweeting edited this page Nov 18, 2024
·
3 revisions
:allowtitles:
:class: autosummary longtable
:align: left
* - {py:obj}`ReadwiseConfig <abx_plugin_readwise.ReadwiseConfig>`
-
:class: autosummary longtable
:align: left
* - {py:obj}`get_CONFIG <abx_plugin_readwise.get_CONFIG>`
- ```{autodoc2-docstring} abx_plugin_readwise.get_CONFIG
:summary:
```
* - {py:obj}`ready <abx_plugin_readwise.ready>`
- ```{autodoc2-docstring} abx_plugin_readwise.ready
:summary:
```
:class: autosummary longtable
:align: left
* - {py:obj}`__id__ <abx_plugin_readwise.__id__>`
- ```{autodoc2-docstring} abx_plugin_readwise.__id__
:summary:
```
* - {py:obj}`__label__ <abx_plugin_readwise.__label__>`
- ```{autodoc2-docstring} abx_plugin_readwise.__label__
:summary:
```
* - {py:obj}`__version__ <abx_plugin_readwise.__version__>`
- ```{autodoc2-docstring} abx_plugin_readwise.__version__
:summary:
```
* - {py:obj}`__author__ <abx_plugin_readwise.__author__>`
- ```{autodoc2-docstring} abx_plugin_readwise.__author__
:summary:
```
* - {py:obj}`__homepage__ <abx_plugin_readwise.__homepage__>`
- ```{autodoc2-docstring} abx_plugin_readwise.__homepage__
:summary:
```
* - {py:obj}`__dependencies__ <abx_plugin_readwise.__dependencies__>`
- ```{autodoc2-docstring} abx_plugin_readwise.__dependencies__
:summary:
```
* - {py:obj}`SOURCES_DIR <abx_plugin_readwise.SOURCES_DIR>`
- ```{autodoc2-docstring} abx_plugin_readwise.SOURCES_DIR
:summary:
```
:canonical: abx_plugin_readwise.__id__
:value: >
'abx_plugin_readwise_extractor'
```{autodoc2-docstring} abx_plugin_readwise.__id__
```
:canonical: abx_plugin_readwise.__label__
:value: >
'Readwise API'
```{autodoc2-docstring} abx_plugin_readwise.__label__
```
:canonical: abx_plugin_readwise.__version__
:value: >
'2024.10.27'
```{autodoc2-docstring} abx_plugin_readwise.__version__
```
:canonical: abx_plugin_readwise.__author__
:value: >
'ArchiveBox'
```{autodoc2-docstring} abx_plugin_readwise.__author__
```
:canonical: abx_plugin_readwise.__homepage__
:value: >
'https://github.com/ArchiveBox/ArchiveBox/tree/dev/archivebox/pkgs/abx-plugin-readwise-extractor'
```{autodoc2-docstring} abx_plugin_readwise.__homepage__
```
:canonical: abx_plugin_readwise.__dependencies__
:value: >
[]
```{autodoc2-docstring} abx_plugin_readwise.__dependencies__
```
:canonical: abx_plugin_readwise.SOURCES_DIR
:value: >
None
```{autodoc2-docstring} abx_plugin_readwise.SOURCES_DIR
```
:canonical: abx_plugin_readwise.ReadwiseConfig
Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`
````{py:attribute} READWISE_DB_PATH
:canonical: abx_plugin_readwise.ReadwiseConfig.READWISE_DB_PATH
:type: pathlib.Path
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_readwise.ReadwiseConfig.READWISE_DB_PATH
```
````
````{py:attribute} READWISE_READER_TOKENS
:canonical: abx_plugin_readwise.ReadwiseConfig.READWISE_READER_TOKENS
:type: typing.Dict[str, str]
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_readwise.ReadwiseConfig.READWISE_READER_TOKENS
```
````
:canonical: abx_plugin_readwise.get_CONFIG
```{autodoc2-docstring} abx_plugin_readwise.get_CONFIG
```
:canonical: abx_plugin_readwise.ready
```{autodoc2-docstring} abx_plugin_readwise.ready
```
- π’ Quickstart
- π₯οΈ Install
- π³ Docker
- β‘οΈ Supported Sources
- β¬ οΈ Supported Outputs
- οΉ©Command Line
- π Web UI
- π§© Browser Extension
- πΎ REST API / Webhooks
- π Python API / REPL / SQL API
- βοΈ Configuration
- π¦ Dependencies
- πΏ Disk Layout
- π Security Overview
- π Developer Documentation
- Upgrading
- Setting up Storage (NFS/SMB/S3/etc)
- Setting up Authentication (SSO/LDAP/etc)
- Setting up Search (rg/sonic/etc)
- Scheduled Archiving
- Publishing Your Archive
- Chromium Install
- Cookies & Sessions Setup
- Merging Collections
- Troubleshooting
- βοΈ Web Archiving Community
- Background & Motivation
- Comparison to Other Tools
- Architecture Diagram
- Changelog & Roadmap