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

rebuild docs

Nick Sweeting
2024-11-17 20:15:19 -08:00
parent a7e4c48d63
commit 804526866c
76 changed files with 3312 additions and 428 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
apidocs/abx_plugin_chrome/abx_plugin_chrome.binaries.md

@@ -164,11 +164,11 @@
`````{py:class} ChromeBinary(/, **data: typing.Any)
:canonical: abx_plugin_chrome.binaries.ChromeBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_chrome.binaries.ChromeBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -179,7 +179,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_chrome.binaries.ChromeBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -190,7 +190,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_chrome.binaries.ChromeBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None

178
apidocs/abx_plugin_chrome/abx_plugin_chrome.extractors.md Normal file

@@ -0,0 +1,178 @@
# {py:mod}`abx_plugin_chrome.extractors`
```{py:module} abx_plugin_chrome.extractors
```
```{autodoc2-docstring} abx_plugin_chrome.extractors
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`PDFExtractor <abx_plugin_chrome.extractors.PDFExtractor>`
- ```{autodoc2-docstring} abx_plugin_chrome.extractors.PDFExtractor
:summary:
```
* - {py:obj}`ScreenshotExtractor <abx_plugin_chrome.extractors.ScreenshotExtractor>`
- ```{autodoc2-docstring} abx_plugin_chrome.extractors.ScreenshotExtractor
:summary:
```
* - {py:obj}`DOMExtractor <abx_plugin_chrome.extractors.DOMExtractor>`
- ```{autodoc2-docstring} abx_plugin_chrome.extractors.DOMExtractor
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`PDF_EXTRACTOR <abx_plugin_chrome.extractors.PDF_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_chrome.extractors.PDF_EXTRACTOR
:summary:
```
* - {py:obj}`SCREENSHOT_EXTRACTOR <abx_plugin_chrome.extractors.SCREENSHOT_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_chrome.extractors.SCREENSHOT_EXTRACTOR
:summary:
```
* - {py:obj}`DOM_EXTRACTOR <abx_plugin_chrome.extractors.DOM_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_chrome.extractors.DOM_EXTRACTOR
:summary:
```
````
### API
`````{py:class} PDFExtractor
:canonical: abx_plugin_chrome.extractors.PDFExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_chrome.extractors.PDFExtractor
```
````{py:attribute} name
:canonical: abx_plugin_chrome.extractors.PDFExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'pdf'
```{autodoc2-docstring} abx_plugin_chrome.extractors.PDFExtractor.name
```
````
````{py:attribute} binary
:canonical: abx_plugin_chrome.extractors.PDFExtractor.binary
:type: abx_pkg.BinName
:value: >
None
```{autodoc2-docstring} abx_plugin_chrome.extractors.PDFExtractor.binary
```
````
`````
````{py:data} PDF_EXTRACTOR
:canonical: abx_plugin_chrome.extractors.PDF_EXTRACTOR
:value: >
'PDFExtractor(...)'
```{autodoc2-docstring} abx_plugin_chrome.extractors.PDF_EXTRACTOR
```
````
`````{py:class} ScreenshotExtractor
:canonical: abx_plugin_chrome.extractors.ScreenshotExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_chrome.extractors.ScreenshotExtractor
```
````{py:attribute} name
:canonical: abx_plugin_chrome.extractors.ScreenshotExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'screenshot'
```{autodoc2-docstring} abx_plugin_chrome.extractors.ScreenshotExtractor.name
```
````
````{py:attribute} binary
:canonical: abx_plugin_chrome.extractors.ScreenshotExtractor.binary
:type: abx_pkg.BinName
:value: >
None
```{autodoc2-docstring} abx_plugin_chrome.extractors.ScreenshotExtractor.binary
```
````
`````
````{py:data} SCREENSHOT_EXTRACTOR
:canonical: abx_plugin_chrome.extractors.SCREENSHOT_EXTRACTOR
:value: >
'ScreenshotExtractor(...)'
```{autodoc2-docstring} abx_plugin_chrome.extractors.SCREENSHOT_EXTRACTOR
```
````
`````{py:class} DOMExtractor
:canonical: abx_plugin_chrome.extractors.DOMExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_chrome.extractors.DOMExtractor
```
````{py:attribute} name
:canonical: abx_plugin_chrome.extractors.DOMExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'dom'
```{autodoc2-docstring} abx_plugin_chrome.extractors.DOMExtractor.name
```
````
````{py:attribute} binary
:canonical: abx_plugin_chrome.extractors.DOMExtractor.binary
:type: abx_pkg.BinName
:value: >
None
```{autodoc2-docstring} abx_plugin_chrome.extractors.DOMExtractor.binary
```
````
`````
````{py:data} DOM_EXTRACTOR
:canonical: abx_plugin_chrome.extractors.DOM_EXTRACTOR
:value: >
'DOMExtractor(...)'
```{autodoc2-docstring} abx_plugin_chrome.extractors.DOM_EXTRACTOR
```
````

12
apidocs/abx_plugin_chrome/abx_plugin_chrome.md

@@ -14,6 +14,7 @@
:maxdepth: 1
abx_plugin_chrome.config
abx_plugin_chrome.extractors
abx_plugin_chrome.binaries
abx_plugin_chrome.pdf
abx_plugin_chrome.screenshot
@@ -40,6 +41,10 @@ abx_plugin_chrome.dom
- ```{autodoc2-docstring} abx_plugin_chrome.ready
:summary:
```
* - {py:obj}`get_EXTRACTORS <abx_plugin_chrome.get_EXTRACTORS>`
- ```{autodoc2-docstring} abx_plugin_chrome.get_EXTRACTORS
:summary:
```
````
### Data
@@ -100,3 +105,10 @@ abx_plugin_chrome.dom
```{autodoc2-docstring} abx_plugin_chrome.ready
```
````
````{py:function} get_EXTRACTORS()
:canonical: abx_plugin_chrome.get_EXTRACTORS
```{autodoc2-docstring} abx_plugin_chrome.get_EXTRACTORS
```
````

6
apidocs/abx_plugin_curl/abx_plugin_curl.binaries.md

@@ -36,11 +36,11 @@
`````{py:class} CurlBinary(/, **data: typing.Any)
:canonical: abx_plugin_curl.binaries.CurlBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_curl.binaries.CurlBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -51,7 +51,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_curl.binaries.CurlBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None

2
apidocs/abx_plugin_default_binproviders/abx_plugin_default_binproviders.md

@@ -23,7 +23,7 @@
### API
````{py:function} get_BINPROVIDERS() -> typing.Dict[str, pydantic_pkgr.BinProvider]
````{py:function} get_BINPROVIDERS() -> typing.Dict[str, abx_pkg.BinProvider]
:canonical: abx_plugin_default_binproviders.get_BINPROVIDERS
```{autodoc2-docstring} abx_plugin_default_binproviders.get_BINPROVIDERS

120
apidocs/abx_plugin_favicon/abx_plugin_favicon.actors.md Normal file

@@ -0,0 +1,120 @@
# {py:mod}`abx_plugin_favicon.actors`
```{py:module} abx_plugin_favicon.actors
```
```{autodoc2-docstring} abx_plugin_favicon.actors
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`FaviconResultActor <abx_plugin_favicon.actors.FaviconResultActor>`
- ```{autodoc2-docstring} abx_plugin_favicon.actors.FaviconResultActor
:summary:
```
````
### API
`````{py:class} FaviconResultActor
:canonical: abx_plugin_favicon.actors.FaviconResultActor
Bases: {py:obj}`core.actors.ActorType`\[{py:obj}`abx_plugin_favicon.models.FaviconResult`\]
```{autodoc2-docstring} abx_plugin_favicon.actors.FaviconResultActor
```
````{py:attribute} Model
:canonical: abx_plugin_favicon.actors.FaviconResultActor.Model
:value: >
None
```{autodoc2-docstring} abx_plugin_favicon.actors.FaviconResultActor.Model
```
````
````{py:attribute} StateMachineClass
:canonical: abx_plugin_favicon.actors.FaviconResultActor.StateMachineClass
:value: >
None
```{autodoc2-docstring} abx_plugin_favicon.actors.FaviconResultActor.StateMachineClass
```
````
````{py:attribute} ACTIVE_STATE
:canonical: abx_plugin_favicon.actors.FaviconResultActor.ACTIVE_STATE
:type: typing.ClassVar[statemachine.State]
:value: >
None
```{autodoc2-docstring} abx_plugin_favicon.actors.FaviconResultActor.ACTIVE_STATE
```
````
````{py:attribute} FINAL_STATES
:canonical: abx_plugin_favicon.actors.FaviconResultActor.FINAL_STATES
:type: typing.ClassVar[list[statemachine.State]]
:value: >
None
```{autodoc2-docstring} abx_plugin_favicon.actors.FaviconResultActor.FINAL_STATES
```
````
````{py:attribute} STATE_FIELD_NAME
:canonical: abx_plugin_favicon.actors.FaviconResultActor.STATE_FIELD_NAME
:type: typing.ClassVar[str]
:value: >
None
```{autodoc2-docstring} abx_plugin_favicon.actors.FaviconResultActor.STATE_FIELD_NAME
```
````
````{py:attribute} MAX_CONCURRENT_ACTORS
:canonical: abx_plugin_favicon.actors.FaviconResultActor.MAX_CONCURRENT_ACTORS
:type: typing.ClassVar[int]
:value: >
6
```{autodoc2-docstring} abx_plugin_favicon.actors.FaviconResultActor.MAX_CONCURRENT_ACTORS
```
````
````{py:attribute} MAX_TICK_TIME
:canonical: abx_plugin_favicon.actors.FaviconResultActor.MAX_TICK_TIME
:type: typing.ClassVar[int]
:value: >
60
```{autodoc2-docstring} abx_plugin_favicon.actors.FaviconResultActor.MAX_TICK_TIME
```
````
````{py:attribute} CLAIM_FROM_TOP_N
:canonical: abx_plugin_favicon.actors.FaviconResultActor.CLAIM_FROM_TOP_N
:type: typing.ClassVar[int]
:value: >
None
```{autodoc2-docstring} abx_plugin_favicon.actors.FaviconResultActor.CLAIM_FROM_TOP_N
```
````
`````

86
apidocs/abx_plugin_favicon/abx_plugin_favicon.extractors.md Normal file

@@ -0,0 +1,86 @@
# {py:mod}`abx_plugin_favicon.extractors`
```{py:module} abx_plugin_favicon.extractors
```
```{autodoc2-docstring} abx_plugin_favicon.extractors
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`FaviconExtractor <abx_plugin_favicon.extractors.FaviconExtractor>`
- ```{autodoc2-docstring} abx_plugin_favicon.extractors.FaviconExtractor
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`FAVICON_EXTRACTOR <abx_plugin_favicon.extractors.FAVICON_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_favicon.extractors.FAVICON_EXTRACTOR
:summary:
```
````
### API
`````{py:class} FaviconExtractor
:canonical: abx_plugin_favicon.extractors.FaviconExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_favicon.extractors.FaviconExtractor
```
````{py:attribute} name
:canonical: abx_plugin_favicon.extractors.FaviconExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'favicon'
```{autodoc2-docstring} abx_plugin_favicon.extractors.FaviconExtractor.name
```
````
````{py:attribute} binary
:canonical: abx_plugin_favicon.extractors.FaviconExtractor.binary
:type: abx_pkg.BinName
:value: >
None
```{autodoc2-docstring} abx_plugin_favicon.extractors.FaviconExtractor.binary
```
````
````{py:method} get_output_path(snapshot) -> pathlib.Path | None
:canonical: abx_plugin_favicon.extractors.FaviconExtractor.get_output_path
```{autodoc2-docstring} abx_plugin_favicon.extractors.FaviconExtractor.get_output_path
```
````
`````
````{py:data} FAVICON_EXTRACTOR
:canonical: abx_plugin_favicon.extractors.FAVICON_EXTRACTOR
:value: >
'FaviconExtractor(...)'
```{autodoc2-docstring} abx_plugin_favicon.extractors.FAVICON_EXTRACTOR
```
````

14
apidocs/abx_plugin_favicon/abx_plugin_favicon.md

@@ -14,7 +14,10 @@
:maxdepth: 1
abx_plugin_favicon.config
abx_plugin_favicon.models
abx_plugin_favicon.extractors
abx_plugin_favicon.favicon
abx_plugin_favicon.actors
```
## Package Contents
@@ -29,6 +32,10 @@ abx_plugin_favicon.favicon
- ```{autodoc2-docstring} abx_plugin_favicon.get_CONFIG
:summary:
```
* - {py:obj}`get_EXTRACTORS <abx_plugin_favicon.get_EXTRACTORS>`
- ```{autodoc2-docstring} abx_plugin_favicon.get_EXTRACTORS
:summary:
```
````
### Data
@@ -117,3 +124,10 @@ abx_plugin_favicon.favicon
```{autodoc2-docstring} abx_plugin_favicon.get_CONFIG
```
````
````{py:function} get_EXTRACTORS()
:canonical: abx_plugin_favicon.get_EXTRACTORS
```{autodoc2-docstring} abx_plugin_favicon.get_EXTRACTORS
```
````

8
apidocs/abx_plugin_favicon/abx_plugin_favicon.models.md Normal file

@@ -0,0 +1,8 @@
# {py:mod}`abx_plugin_favicon.models`
```{py:module} abx_plugin_favicon.models
```
```{autodoc2-docstring} abx_plugin_favicon.models
:allowtitles:
```

6
apidocs/abx_plugin_git/abx_plugin_git.binaries.md

@@ -36,11 +36,11 @@
`````{py:class} GitBinary(/, **data: typing.Any)
:canonical: abx_plugin_git.binaries.GitBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_git.binaries.GitBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -51,7 +51,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_git.binaries.GitBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None

78
apidocs/abx_plugin_git/abx_plugin_git.extractors.md

@@ -6,3 +6,81 @@
```{autodoc2-docstring} abx_plugin_git.extractors
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`GitExtractor <abx_plugin_git.extractors.GitExtractor>`
- ```{autodoc2-docstring} abx_plugin_git.extractors.GitExtractor
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`GIT_EXTRACTOR <abx_plugin_git.extractors.GIT_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_git.extractors.GIT_EXTRACTOR
:summary:
```
````
### API
`````{py:class} GitExtractor
:canonical: abx_plugin_git.extractors.GitExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_git.extractors.GitExtractor
```
````{py:attribute} name
:canonical: abx_plugin_git.extractors.GitExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'git'
```{autodoc2-docstring} abx_plugin_git.extractors.GitExtractor.name
```
````
````{py:attribute} binary
:canonical: abx_plugin_git.extractors.GitExtractor.binary
:type: abx_pkg.BinName
:value: >
None
```{autodoc2-docstring} abx_plugin_git.extractors.GitExtractor.binary
```
````
````{py:method} get_output_path(snapshot) -> pathlib.Path | None
:canonical: abx_plugin_git.extractors.GitExtractor.get_output_path
```{autodoc2-docstring} abx_plugin_git.extractors.GitExtractor.get_output_path
```
````
`````
````{py:data} GIT_EXTRACTOR
:canonical: abx_plugin_git.extractors.GIT_EXTRACTOR
:value: >
'GitExtractor(...)'
```{autodoc2-docstring} abx_plugin_git.extractors.GIT_EXTRACTOR
```
````

6
apidocs/abx_plugin_ldap_auth/abx_plugin_ldap_auth.binaries.md

@@ -66,7 +66,7 @@
`````{py:class} LdapBinary(/, **data: typing.Any)
:canonical: abx_plugin_ldap_auth.binaries.LdapBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_ldap_auth.binaries.LdapBinary.name
@@ -92,7 +92,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_ldap_auth.binaries.LdapBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -103,7 +103,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_ldap_auth.binaries.LdapBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None

8
apidocs/abx_plugin_mercury/abx_plugin_mercury.binaries.md

@@ -36,11 +36,11 @@
`````{py:class} MercuryBinary(/, **data: typing.Any)
:canonical: abx_plugin_mercury.binaries.MercuryBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_mercury.binaries.MercuryBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -51,7 +51,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_mercury.binaries.MercuryBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -62,7 +62,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_mercury.binaries.MercuryBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None

78
apidocs/abx_plugin_mercury/abx_plugin_mercury.extractors.md

@@ -6,3 +6,81 @@
```{autodoc2-docstring} abx_plugin_mercury.extractors
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`MercuryExtractor <abx_plugin_mercury.extractors.MercuryExtractor>`
- ```{autodoc2-docstring} abx_plugin_mercury.extractors.MercuryExtractor
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`MERCURY_EXTRACTOR <abx_plugin_mercury.extractors.MERCURY_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_mercury.extractors.MERCURY_EXTRACTOR
:summary:
```
````
### API
`````{py:class} MercuryExtractor
:canonical: abx_plugin_mercury.extractors.MercuryExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_mercury.extractors.MercuryExtractor
```
````{py:attribute} name
:canonical: abx_plugin_mercury.extractors.MercuryExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'mercury'
```{autodoc2-docstring} abx_plugin_mercury.extractors.MercuryExtractor.name
```
````
````{py:attribute} binary
:canonical: abx_plugin_mercury.extractors.MercuryExtractor.binary
:type: abx_pkg.BinName
:value: >
None
```{autodoc2-docstring} abx_plugin_mercury.extractors.MercuryExtractor.binary
```
````
````{py:method} get_output_path(snapshot) -> pathlib.Path | None
:canonical: abx_plugin_mercury.extractors.MercuryExtractor.get_output_path
```{autodoc2-docstring} abx_plugin_mercury.extractors.MercuryExtractor.get_output_path
```
````
`````
````{py:data} MERCURY_EXTRACTOR
:canonical: abx_plugin_mercury.extractors.MERCURY_EXTRACTOR
:value: >
'MercuryExtractor(...)'
```{autodoc2-docstring} abx_plugin_mercury.extractors.MERCURY_EXTRACTOR
```
````

24
apidocs/abx_plugin_npm/abx_plugin_npm.binaries.md

@@ -104,11 +104,11 @@
`````{py:class} NodeBinary(/, **data: typing.Any)
:canonical: abx_plugin_npm.binaries.NodeBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_npm.binaries.NodeBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'node'
@@ -119,7 +119,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_npm.binaries.NodeBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -130,7 +130,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_npm.binaries.NodeBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None
@@ -154,11 +154,11 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
`````{py:class} NpmBinary(/, **data: typing.Any)
:canonical: abx_plugin_npm.binaries.NpmBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_npm.binaries.NpmBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'npm'
@@ -169,7 +169,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_npm.binaries.NpmBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -180,7 +180,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_npm.binaries.NpmBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None
@@ -204,11 +204,11 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
`````{py:class} NpxBinary(/, **data: typing.Any)
:canonical: abx_plugin_npm.binaries.NpxBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_npm.binaries.NpxBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'npx'
@@ -219,7 +219,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_npm.binaries.NpxBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -230,7 +230,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_npm.binaries.NpxBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None

10
apidocs/abx_plugin_npm/abx_plugin_npm.binproviders.md

@@ -88,11 +88,11 @@
`````{py:class} SystemNpmBinProvider(/, **data: typing.Any)
:canonical: abx_plugin_npm.binproviders.SystemNpmBinProvider
Bases: {py:obj}`pydantic_pkgr.NpmProvider`
Bases: {py:obj}`abx_pkg.NpmProvider`
````{py:attribute} name
:canonical: abx_plugin_npm.binproviders.SystemNpmBinProvider.name
:type: pydantic_pkgr.BinProviderName
:type: abx_pkg.BinProviderName
:value: >
'sys_npm'
@@ -117,11 +117,11 @@ Bases: {py:obj}`pydantic_pkgr.NpmProvider`
`````{py:class} LibNpmBinProvider(/, **data: typing.Any)
:canonical: abx_plugin_npm.binproviders.LibNpmBinProvider
Bases: {py:obj}`pydantic_pkgr.NpmProvider`
Bases: {py:obj}`abx_pkg.NpmProvider`
````{py:attribute} name
:canonical: abx_plugin_npm.binproviders.LibNpmBinProvider.name
:type: pydantic_pkgr.BinProviderName
:type: abx_pkg.BinProviderName
:value: >
'lib_npm'
@@ -132,7 +132,7 @@ Bases: {py:obj}`pydantic_pkgr.NpmProvider`
````{py:attribute} PATH
:canonical: abx_plugin_npm.binproviders.LibNpmBinProvider.PATH
:type: pydantic_pkgr.PATHStr
:type: abx_pkg.PATHStr
:value: >
None

44
apidocs/abx_plugin_pip/abx_plugin_pip.binaries.md

@@ -109,11 +109,11 @@
`````{py:class} ArchiveboxBinary(/, **data: typing.Any)
:canonical: abx_plugin_pip.binaries.ArchiveboxBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_pip.binaries.ArchiveboxBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'archivebox'
@@ -124,7 +124,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_pip.binaries.ArchiveboxBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -135,7 +135,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_pip.binaries.ArchiveboxBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None
@@ -175,11 +175,11 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
`````{py:class} PythonBinary(/, **data: typing.Any)
:canonical: abx_plugin_pip.binaries.PythonBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_pip.binaries.PythonBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'python'
@@ -190,7 +190,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_pip.binaries.PythonBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -201,7 +201,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_pip.binaries.PythonBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None
@@ -271,11 +271,11 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
`````{py:class} SqliteBinary(/, **data: typing.Any)
:canonical: abx_plugin_pip.binaries.SqliteBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_pip.binaries.SqliteBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'sqlite'
@@ -286,7 +286,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_pip.binaries.SqliteBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
'Field(...)'
@@ -297,7 +297,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_pip.binaries.SqliteBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None
@@ -375,11 +375,11 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
`````{py:class} DjangoBinary(/, **data: typing.Any)
:canonical: abx_plugin_pip.binaries.DjangoBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_pip.binaries.DjangoBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'django'
@@ -390,7 +390,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_pip.binaries.DjangoBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
'Field(...)'
@@ -401,7 +401,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_pip.binaries.DjangoBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None
@@ -441,11 +441,11 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
`````{py:class} PipBinary(/, **data: typing.Any)
:canonical: abx_plugin_pip.binaries.PipBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_pip.binaries.PipBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'pip'
@@ -456,7 +456,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_pip.binaries.PipBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -496,11 +496,11 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
`````{py:class} PipxBinary(/, **data: typing.Any)
:canonical: abx_plugin_pip.binaries.PipxBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_pip.binaries.PipxBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'pipx'
@@ -511,7 +511,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_pip.binaries.PipxBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None

24
apidocs/abx_plugin_pip/abx_plugin_pip.binproviders.md

@@ -142,11 +142,11 @@
`````{py:class} SystemPipBinProvider(/, **data: typing.Any)
:canonical: abx_plugin_pip.binproviders.SystemPipBinProvider
Bases: {py:obj}`pydantic_pkgr.PipProvider`
Bases: {py:obj}`abx_pkg.PipProvider`
````{py:attribute} name
:canonical: abx_plugin_pip.binproviders.SystemPipBinProvider.name
:type: pydantic_pkgr.BinProviderName
:type: abx_pkg.BinProviderName
:value: >
'sys_pip'
@@ -157,7 +157,7 @@ Bases: {py:obj}`pydantic_pkgr.PipProvider`
````{py:attribute} INSTALLER_BIN
:canonical: abx_plugin_pip.binproviders.SystemPipBinProvider.INSTALLER_BIN
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'pip'
@@ -190,11 +190,11 @@ Bases: {py:obj}`pydantic_pkgr.PipProvider`
`````{py:class} SystemPipxBinProvider(/, **data: typing.Any)
:canonical: abx_plugin_pip.binproviders.SystemPipxBinProvider
Bases: {py:obj}`pydantic_pkgr.PipProvider`
Bases: {py:obj}`abx_pkg.PipProvider`
````{py:attribute} name
:canonical: abx_plugin_pip.binproviders.SystemPipxBinProvider.name
:type: pydantic_pkgr.BinProviderName
:type: abx_pkg.BinProviderName
:value: >
'pipx'
@@ -205,7 +205,7 @@ Bases: {py:obj}`pydantic_pkgr.PipProvider`
````{py:attribute} INSTALLER_BIN
:canonical: abx_plugin_pip.binproviders.SystemPipxBinProvider.INSTALLER_BIN
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'pipx'
@@ -240,11 +240,11 @@ Bases: {py:obj}`pydantic_pkgr.PipProvider`
`````{py:class} VenvPipBinProvider(/, **data: typing.Any)
:canonical: abx_plugin_pip.binproviders.VenvPipBinProvider
Bases: {py:obj}`pydantic_pkgr.PipProvider`
Bases: {py:obj}`abx_pkg.PipProvider`
````{py:attribute} name
:canonical: abx_plugin_pip.binproviders.VenvPipBinProvider.name
:type: pydantic_pkgr.BinProviderName
:type: abx_pkg.BinProviderName
:value: >
'venv_pip'
@@ -255,7 +255,7 @@ Bases: {py:obj}`pydantic_pkgr.PipProvider`
````{py:attribute} INSTALLER_BIN
:canonical: abx_plugin_pip.binproviders.VenvPipBinProvider.INSTALLER_BIN
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'pip'
@@ -288,11 +288,11 @@ Bases: {py:obj}`pydantic_pkgr.PipProvider`
`````{py:class} LibPipBinProvider(/, **data: typing.Any)
:canonical: abx_plugin_pip.binproviders.LibPipBinProvider
Bases: {py:obj}`pydantic_pkgr.PipProvider`
Bases: {py:obj}`abx_pkg.PipProvider`
````{py:attribute} name
:canonical: abx_plugin_pip.binproviders.LibPipBinProvider.name
:type: pydantic_pkgr.BinProviderName
:type: abx_pkg.BinProviderName
:value: >
'lib_pip'
@@ -303,7 +303,7 @@ Bases: {py:obj}`pydantic_pkgr.PipProvider`
````{py:attribute} INSTALLER_BIN
:canonical: abx_plugin_pip.binproviders.LibPipBinProvider.INSTALLER_BIN
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'pip'

14
apidocs/abx_plugin_pip/abx_plugin_pip.md

@@ -50,6 +50,10 @@ abx_plugin_pip.binproviders
- ```{autodoc2-docstring} abx_plugin_pip.__label__
:summary:
```
* - {py:obj}`__order__ <abx_plugin_pip.__order__>`
- ```{autodoc2-docstring} abx_plugin_pip.__order__
:summary:
```
````
### API
@@ -64,6 +68,16 @@ abx_plugin_pip.binproviders
````
````{py:data} __order__
:canonical: abx_plugin_pip.__order__
:value: >
200
```{autodoc2-docstring} abx_plugin_pip.__order__
```
````
````{py:function} get_CONFIG()
:canonical: abx_plugin_pip.get_CONFIG

6
apidocs/abx_plugin_playwright/abx_plugin_playwright.binaries.md

@@ -36,11 +36,11 @@
`````{py:class} PlaywrightBinary(/, **data: typing.Any)
:canonical: abx_plugin_playwright.binaries.PlaywrightBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_playwright.binaries.PlaywrightBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -51,7 +51,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_playwright.binaries.PlaywrightBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None

18
apidocs/abx_plugin_playwright/abx_plugin_playwright.binproviders.md

@@ -96,11 +96,11 @@
`````{py:class} PlaywrightBinProvider(/, **data: typing.Any)
:canonical: abx_plugin_playwright.binproviders.PlaywrightBinProvider
Bases: {py:obj}`pydantic_pkgr.BinProvider`
Bases: {py:obj}`abx_pkg.BinProvider`
````{py:attribute} name
:canonical: abx_plugin_playwright.binproviders.PlaywrightBinProvider.name
:type: pydantic_pkgr.BinProviderName
:type: abx_pkg.BinProviderName
:value: >
'playwright'
@@ -111,7 +111,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````{py:attribute} INSTALLER_BIN
:canonical: abx_plugin_playwright.binproviders.PlaywrightBinProvider.INSTALLER_BIN
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -122,7 +122,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````{py:attribute} PATH
:canonical: abx_plugin_playwright.binproviders.PlaywrightBinProvider.PATH
:type: pydantic_pkgr.PATHStr
:type: abx_pkg.PATHStr
:value: >
None
@@ -155,7 +155,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````{py:attribute} packages_handler
:canonical: abx_plugin_playwright.binproviders.PlaywrightBinProvider.packages_handler
:type: pydantic_pkgr.BinProviderOverrides
:type: abx_pkg.BinProviderOverrides
:value: >
'Field(...)'
@@ -166,7 +166,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````{py:attribute} _browser_abspaths
:canonical: abx_plugin_playwright.binproviders.PlaywrightBinProvider._browser_abspaths
:type: typing.ClassVar[typing.Dict[str, pydantic_pkgr.HostBinPath]]
:type: typing.ClassVar[typing.Dict[str, abx_pkg.HostBinPath]]
:value: >
None
@@ -177,7 +177,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````{py:property} INSTALLER_BIN_ABSPATH
:canonical: abx_plugin_playwright.binproviders.PlaywrightBinProvider.INSTALLER_BIN_ABSPATH
:type: pydantic_pkgr.HostBinPath | None
:type: abx_pkg.HostBinPath | None
````
@@ -194,7 +194,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````
````{py:method} default_abspath_handler(bin_name: pydantic_pkgr.BinName, **context) -> typing.Optional[pydantic_pkgr.HostBinPath]
````{py:method} default_abspath_handler(bin_name: abx_pkg.BinName, **context) -> typing.Optional[abx_pkg.HostBinPath]
:canonical: abx_plugin_playwright.binproviders.PlaywrightBinProvider.default_abspath_handler
```{autodoc2-docstring} abx_plugin_playwright.binproviders.PlaywrightBinProvider.default_abspath_handler
@@ -202,7 +202,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````
````{py:method} default_install_handler(bin_name: str, packages: typing.Optional[pydantic_pkgr.InstallArgs] = None, **context) -> str
````{py:method} default_install_handler(bin_name: str, packages: typing.Optional[abx_pkg.InstallArgs] = None, **context) -> str
:canonical: abx_plugin_playwright.binproviders.PlaywrightBinProvider.default_install_handler
```{autodoc2-docstring} abx_plugin_playwright.binproviders.PlaywrightBinProvider.default_install_handler

6
apidocs/abx_plugin_puppeteer/abx_plugin_puppeteer.binaries.md

@@ -36,11 +36,11 @@
`````{py:class} PuppeteerBinary(/, **data: typing.Any)
:canonical: abx_plugin_puppeteer.binaries.PuppeteerBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_puppeteer.binaries.PuppeteerBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'puppeteer'
@@ -51,7 +51,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_puppeteer.binaries.PuppeteerBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None

16
apidocs/abx_plugin_puppeteer/abx_plugin_puppeteer.binproviders.md

@@ -36,11 +36,11 @@
`````{py:class} PuppeteerBinProvider(/, **data: typing.Any)
:canonical: abx_plugin_puppeteer.binproviders.PuppeteerBinProvider
Bases: {py:obj}`pydantic_pkgr.BinProvider`
Bases: {py:obj}`abx_pkg.BinProvider`
````{py:attribute} name
:canonical: abx_plugin_puppeteer.binproviders.PuppeteerBinProvider.name
:type: pydantic_pkgr.BinProviderName
:type: abx_pkg.BinProviderName
:value: >
'puppeteer'
@@ -51,7 +51,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````{py:attribute} INSTALLER_BIN
:canonical: abx_plugin_puppeteer.binproviders.PuppeteerBinProvider.INSTALLER_BIN
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'npx'
@@ -62,7 +62,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````{py:attribute} PATH
:canonical: abx_plugin_puppeteer.binproviders.PuppeteerBinProvider.PATH
:type: pydantic_pkgr.PATHStr
:type: abx_pkg.PATHStr
:value: >
'str(...)'
@@ -106,7 +106,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````{py:attribute} packages_handler
:canonical: abx_plugin_puppeteer.binproviders.PuppeteerBinProvider.packages_handler
:type: pydantic_pkgr.BinProviderOverrides
:type: abx_pkg.BinProviderOverrides
:value: >
'Field(...)'
@@ -117,7 +117,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````{py:attribute} _browser_abspaths
:canonical: abx_plugin_puppeteer.binproviders.PuppeteerBinProvider._browser_abspaths
:type: typing.ClassVar[typing.Dict[str, pydantic_pkgr.HostBinPath]]
:type: typing.ClassVar[typing.Dict[str, abx_pkg.HostBinPath]]
:value: >
None
@@ -139,7 +139,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````
````{py:method} default_abspath_handler(bin_name: pydantic_pkgr.BinName, **context) -> typing.Optional[pydantic_pkgr.HostBinPath]
````{py:method} default_abspath_handler(bin_name: abx_pkg.BinName, **context) -> typing.Optional[abx_pkg.HostBinPath]
:canonical: abx_plugin_puppeteer.binproviders.PuppeteerBinProvider.default_abspath_handler
```{autodoc2-docstring} abx_plugin_puppeteer.binproviders.PuppeteerBinProvider.default_abspath_handler
@@ -147,7 +147,7 @@ Bases: {py:obj}`pydantic_pkgr.BinProvider`
````
````{py:method} default_install_handler(bin_name: str, packages: typing.Optional[pydantic_pkgr.InstallArgs] = None, **context) -> str
````{py:method} default_install_handler(bin_name: str, packages: typing.Optional[abx_pkg.InstallArgs] = None, **context) -> str
:canonical: abx_plugin_puppeteer.binproviders.PuppeteerBinProvider.default_install_handler
```{autodoc2-docstring} abx_plugin_puppeteer.binproviders.PuppeteerBinProvider.default_install_handler

8
apidocs/abx_plugin_readability/abx_plugin_readability.binaries.md

@@ -50,11 +50,11 @@
`````{py:class} ReadabilityBinary(/, **data: typing.Any)
:canonical: abx_plugin_readability.binaries.ReadabilityBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_readability.binaries.ReadabilityBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -65,7 +65,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_readability.binaries.ReadabilityBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -76,7 +76,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_readability.binaries.ReadabilityBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None

78
apidocs/abx_plugin_readability/abx_plugin_readability.extractors.md

@@ -6,3 +6,81 @@
```{autodoc2-docstring} abx_plugin_readability.extractors
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`ReadabilityExtractor <abx_plugin_readability.extractors.ReadabilityExtractor>`
- ```{autodoc2-docstring} abx_plugin_readability.extractors.ReadabilityExtractor
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`READABILITY_EXTRACTOR <abx_plugin_readability.extractors.READABILITY_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_readability.extractors.READABILITY_EXTRACTOR
:summary:
```
````
### API
`````{py:class} ReadabilityExtractor
:canonical: abx_plugin_readability.extractors.ReadabilityExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_readability.extractors.ReadabilityExtractor
```
````{py:attribute} name
:canonical: abx_plugin_readability.extractors.ReadabilityExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'readability'
```{autodoc2-docstring} abx_plugin_readability.extractors.ReadabilityExtractor.name
```
````
````{py:attribute} binary
:canonical: abx_plugin_readability.extractors.ReadabilityExtractor.binary
:type: abx_pkg.BinName
:value: >
None
```{autodoc2-docstring} abx_plugin_readability.extractors.ReadabilityExtractor.binary
```
````
````{py:method} get_output_path(snapshot) -> pathlib.Path
:canonical: abx_plugin_readability.extractors.ReadabilityExtractor.get_output_path
```{autodoc2-docstring} abx_plugin_readability.extractors.ReadabilityExtractor.get_output_path
```
````
`````
````{py:data} READABILITY_EXTRACTOR
:canonical: abx_plugin_readability.extractors.READABILITY_EXTRACTOR
:value: >
'ReadabilityExtractor(...)'
```{autodoc2-docstring} abx_plugin_readability.extractors.READABILITY_EXTRACTOR
```
````

2
apidocs/abx_plugin_readwise/abx_plugin_readwise.md

@@ -116,7 +116,7 @@
````{py:data} __homepage__
:canonical: abx_plugin_readwise.__homepage__
:value: >
'https://github.com/ArchiveBox/ArchiveBox/tree/dev/archivebox/plugins_extractor/readwise'
'https://github.com/ArchiveBox/ArchiveBox/tree/dev/archivebox/pkgs/abx-plugin-readwise-extractor'
```{autodoc2-docstring} abx_plugin_readwise.__homepage__
```

8
apidocs/abx_plugin_ripgrep_search/abx_plugin_ripgrep_search.binaries.md

@@ -36,11 +36,11 @@
`````{py:class} RipgrepBinary(/, **data: typing.Any)
:canonical: abx_plugin_ripgrep_search.binaries.RipgrepBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_ripgrep_search.binaries.RipgrepBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -51,7 +51,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_ripgrep_search.binaries.RipgrepBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -62,7 +62,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_ripgrep_search.binaries.RipgrepBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None

12
apidocs/abx_plugin_singlefile/abx_plugin_singlefile.actors.md

@@ -16,16 +16,21 @@
:align: left
* - {py:obj}`SinglefileActor <abx_plugin_singlefile.actors.SinglefileActor>`
-
- ```{autodoc2-docstring} abx_plugin_singlefile.actors.SinglefileActor
:summary:
```
````
### API
`````{py:class} SinglefileActor(mode: typing.Literal[thread, process] | None = None, **launch_kwargs: actors.actor.LaunchKwargs)
`````{py:class} SinglefileActor
:canonical: abx_plugin_singlefile.actors.SinglefileActor
Bases: {py:obj}`actors.actor.ActorType`\[{py:obj}`abx_plugin_singlefile.models.SinglefileResult`\]
```{autodoc2-docstring} abx_plugin_singlefile.actors.SinglefileActor
```
````{py:attribute} CLAIM_ORDER
:canonical: abx_plugin_singlefile.actors.SinglefileActor.CLAIM_ORDER
:type: typing.ClassVar[str]
@@ -70,6 +75,9 @@ Bases: {py:obj}`actors.actor.ActorType`\[{py:obj}`abx_plugin_singlefile.models.S
````{py:method} tick(obj: abx_plugin_singlefile.models.SinglefileResult)
:canonical: abx_plugin_singlefile.actors.SinglefileActor.tick
```{autodoc2-docstring} abx_plugin_singlefile.actors.SinglefileActor.tick
```
````
`````

8
apidocs/abx_plugin_singlefile/abx_plugin_singlefile.binaries.md

@@ -64,11 +64,11 @@
`````{py:class} SinglefileBinary(/, **data: typing.Any)
:canonical: abx_plugin_singlefile.binaries.SinglefileBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_singlefile.binaries.SinglefileBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -79,7 +79,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_singlefile.binaries.SinglefileBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -90,7 +90,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_singlefile.binaries.SinglefileBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None

78
apidocs/abx_plugin_singlefile/abx_plugin_singlefile.extractors.md

@@ -6,3 +6,81 @@
```{autodoc2-docstring} abx_plugin_singlefile.extractors
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`SinglefileExtractor <abx_plugin_singlefile.extractors.SinglefileExtractor>`
- ```{autodoc2-docstring} abx_plugin_singlefile.extractors.SinglefileExtractor
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`SINGLEFILE_EXTRACTOR <abx_plugin_singlefile.extractors.SINGLEFILE_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_singlefile.extractors.SINGLEFILE_EXTRACTOR
:summary:
```
````
### API
`````{py:class} SinglefileExtractor
:canonical: abx_plugin_singlefile.extractors.SinglefileExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_singlefile.extractors.SinglefileExtractor
```
````{py:attribute} name
:canonical: abx_plugin_singlefile.extractors.SinglefileExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'singlefile'
```{autodoc2-docstring} abx_plugin_singlefile.extractors.SinglefileExtractor.name
```
````
````{py:attribute} binary
:canonical: abx_plugin_singlefile.extractors.SinglefileExtractor.binary
:type: abx_pkg.BinName
:value: >
None
```{autodoc2-docstring} abx_plugin_singlefile.extractors.SinglefileExtractor.binary
```
````
````{py:method} get_output_path(snapshot) -> pathlib.Path
:canonical: abx_plugin_singlefile.extractors.SinglefileExtractor.get_output_path
```{autodoc2-docstring} abx_plugin_singlefile.extractors.SinglefileExtractor.get_output_path
```
````
`````
````{py:data} SINGLEFILE_EXTRACTOR
:canonical: abx_plugin_singlefile.extractors.SINGLEFILE_EXTRACTOR
:value: >
'SinglefileExtractor(...)'
```{autodoc2-docstring} abx_plugin_singlefile.extractors.SINGLEFILE_EXTRACTOR
```
````

71
apidocs/abx_plugin_singlefile/abx_plugin_singlefile.models.md

@@ -6,74 +6,3 @@
```{autodoc2-docstring} abx_plugin_singlefile.models
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`SinglefileResultManager <abx_plugin_singlefile.models.SinglefileResultManager>`
- ```{autodoc2-docstring} abx_plugin_singlefile.models.SinglefileResultManager
:summary:
```
* - {py:obj}`SinglefileResult <abx_plugin_singlefile.models.SinglefileResult>`
-
````
### API
`````{py:class} SinglefileResultManager
:canonical: abx_plugin_singlefile.models.SinglefileResultManager
Bases: {py:obj}`django.db.models.Manager`
```{autodoc2-docstring} abx_plugin_singlefile.models.SinglefileResultManager
```
````{py:method} get_queryset()
:canonical: abx_plugin_singlefile.models.SinglefileResultManager.get_queryset
```{autodoc2-docstring} abx_plugin_singlefile.models.SinglefileResultManager.get_queryset
```
````
`````
``````{py:class} SinglefileResult(*args: typing.Any, **kwargs: typing.Any)
:canonical: abx_plugin_singlefile.models.SinglefileResult
Bases: {py:obj}`core.models.ArchiveResult`
````{py:attribute} objects
:canonical: abx_plugin_singlefile.models.SinglefileResult.objects
:value: >
'SinglefileResultManager(...)'
```{autodoc2-docstring} abx_plugin_singlefile.models.SinglefileResult.objects
```
````
`````{py:class} Meta
:canonical: abx_plugin_singlefile.models.SinglefileResult.Meta
```{autodoc2-docstring} abx_plugin_singlefile.models.SinglefileResult.Meta
```
````{py:attribute} proxy
:canonical: abx_plugin_singlefile.models.SinglefileResult.Meta.proxy
:value: >
True
```{autodoc2-docstring} abx_plugin_singlefile.models.SinglefileResult.Meta.proxy
```
````
`````
``````

8
apidocs/abx_plugin_sonic_search/abx_plugin_sonic_search.binaries.md

@@ -36,11 +36,11 @@
`````{py:class} SonicBinary(/, **data: typing.Any)
:canonical: abx_plugin_sonic_search.binaries.SonicBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_sonic_search.binaries.SonicBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -51,7 +51,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_sonic_search.binaries.SonicBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -62,7 +62,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_sonic_search.binaries.SonicBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None

67
apidocs/abx_plugin_title/abx_plugin_title.extractors.md Normal file

@@ -0,0 +1,67 @@
# {py:mod}`abx_plugin_title.extractors`
```{py:module} abx_plugin_title.extractors
```
```{autodoc2-docstring} abx_plugin_title.extractors
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`TitleExtractor <abx_plugin_title.extractors.TitleExtractor>`
- ```{autodoc2-docstring} abx_plugin_title.extractors.TitleExtractor
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`TITLE_EXTRACTOR <abx_plugin_title.extractors.TITLE_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_title.extractors.TITLE_EXTRACTOR
:summary:
```
````
### API
`````{py:class} TitleExtractor
:canonical: abx_plugin_title.extractors.TitleExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_title.extractors.TitleExtractor
```
````{py:attribute} name
:canonical: abx_plugin_title.extractors.TitleExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'title'
```{autodoc2-docstring} abx_plugin_title.extractors.TitleExtractor.name
```
````
`````
````{py:data} TITLE_EXTRACTOR
:canonical: abx_plugin_title.extractors.TITLE_EXTRACTOR
:value: >
'TitleExtractor(...)'
```{autodoc2-docstring} abx_plugin_title.extractors.TITLE_EXTRACTOR
```
````

24
apidocs/abx_plugin_title/abx_plugin_title.md

@@ -13,5 +13,29 @@
:titlesonly:
:maxdepth: 1
abx_plugin_title.extractors
abx_plugin_title.extractor
```
## Package Contents
### Functions
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`get_EXTRACTORS <abx_plugin_title.get_EXTRACTORS>`
- ```{autodoc2-docstring} abx_plugin_title.get_EXTRACTORS
:summary:
```
````
### API
````{py:function} get_EXTRACTORS()
:canonical: abx_plugin_title.get_EXTRACTORS
```{autodoc2-docstring} abx_plugin_title.get_EXTRACTORS
```
````

6
apidocs/abx_plugin_wget/abx_plugin_wget.binaries.md

@@ -36,11 +36,11 @@
`````{py:class} WgetBinary(/, **data: typing.Any)
:canonical: abx_plugin_wget.binaries.WgetBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_wget.binaries.WgetBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -51,7 +51,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_wget.binaries.WgetBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None

136
apidocs/abx_plugin_wget/abx_plugin_wget.extractors.md

@@ -6,3 +6,139 @@
```{autodoc2-docstring} abx_plugin_wget.extractors
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`WgetExtractor <abx_plugin_wget.extractors.WgetExtractor>`
- ```{autodoc2-docstring} abx_plugin_wget.extractors.WgetExtractor
:summary:
```
* - {py:obj}`WarcExtractor <abx_plugin_wget.extractors.WarcExtractor>`
- ```{autodoc2-docstring} abx_plugin_wget.extractors.WarcExtractor
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`WGET_EXTRACTOR <abx_plugin_wget.extractors.WGET_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_wget.extractors.WGET_EXTRACTOR
:summary:
```
* - {py:obj}`WARC_EXTRACTOR <abx_plugin_wget.extractors.WARC_EXTRACTOR>`
- ```{autodoc2-docstring} abx_plugin_wget.extractors.WARC_EXTRACTOR
:summary:
```
````
### API
`````{py:class} WgetExtractor
:canonical: abx_plugin_wget.extractors.WgetExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_wget.extractors.WgetExtractor
```
````{py:attribute} name
:canonical: abx_plugin_wget.extractors.WgetExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'wget'
```{autodoc2-docstring} abx_plugin_wget.extractors.WgetExtractor.name
```
````
````{py:attribute} binary
:canonical: abx_plugin_wget.extractors.WgetExtractor.binary
:type: abx_pkg.BinName
:value: >
None
```{autodoc2-docstring} abx_plugin_wget.extractors.WgetExtractor.binary
```
````
````{py:method} get_output_path(snapshot) -> pathlib.Path | None
:canonical: abx_plugin_wget.extractors.WgetExtractor.get_output_path
```{autodoc2-docstring} abx_plugin_wget.extractors.WgetExtractor.get_output_path
```
````
`````
````{py:data} WGET_EXTRACTOR
:canonical: abx_plugin_wget.extractors.WGET_EXTRACTOR
:value: >
'WgetExtractor(...)'
```{autodoc2-docstring} abx_plugin_wget.extractors.WGET_EXTRACTOR
```
````
`````{py:class} WarcExtractor
:canonical: abx_plugin_wget.extractors.WarcExtractor
Bases: {py:obj}`abx_spec_extractor.BaseExtractor`
```{autodoc2-docstring} abx_plugin_wget.extractors.WarcExtractor
```
````{py:attribute} name
:canonical: abx_plugin_wget.extractors.WarcExtractor.name
:type: abx_spec_extractor.ExtractorName
:value: >
'warc'
```{autodoc2-docstring} abx_plugin_wget.extractors.WarcExtractor.name
```
````
````{py:attribute} binary
:canonical: abx_plugin_wget.extractors.WarcExtractor.binary
:type: abx_pkg.BinName
:value: >
None
```{autodoc2-docstring} abx_plugin_wget.extractors.WarcExtractor.binary
```
````
````{py:method} get_output_path(snapshot) -> pathlib.Path | None
:canonical: abx_plugin_wget.extractors.WarcExtractor.get_output_path
```{autodoc2-docstring} abx_plugin_wget.extractors.WarcExtractor.get_output_path
```
````
`````
````{py:data} WARC_EXTRACTOR
:canonical: abx_plugin_wget.extractors.WARC_EXTRACTOR
:value: >
'WarcExtractor(...)'
```{autodoc2-docstring} abx_plugin_wget.extractors.WARC_EXTRACTOR
```
````

14
apidocs/abx_plugin_ytdlp/abx_plugin_ytdlp.binaries.md

@@ -42,11 +42,11 @@
`````{py:class} YtdlpBinary(/, **data: typing.Any)
:canonical: abx_plugin_ytdlp.binaries.YtdlpBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_ytdlp.binaries.YtdlpBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None
@@ -57,7 +57,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_ytdlp.binaries.YtdlpBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -81,11 +81,11 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
`````{py:class} FfmpegBinary(/, **data: typing.Any)
:canonical: abx_plugin_ytdlp.binaries.FfmpegBinary
Bases: {py:obj}`pydantic_pkgr.Binary`
Bases: {py:obj}`abx_pkg.Binary`
````{py:attribute} name
:canonical: abx_plugin_ytdlp.binaries.FfmpegBinary.name
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
'ffmpeg'
@@ -96,7 +96,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} binproviders_supported
:canonical: abx_plugin_ytdlp.binaries.FfmpegBinary.binproviders_supported
:type: typing.List[pydantic.InstanceOf[pydantic_pkgr.BinProvider]]
:type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]]
:value: >
None
@@ -107,7 +107,7 @@ Bases: {py:obj}`pydantic_pkgr.Binary`
````{py:attribute} overrides
:canonical: abx_plugin_ytdlp.binaries.FfmpegBinary.overrides
:type: pydantic_pkgr.BinaryOverrides
:type: abx_pkg.BinaryOverrides
:value: >
None

196
apidocs/abx_spec_abx_pkg/abx_spec_abx_pkg.md Normal file

@@ -0,0 +1,196 @@
# {py:mod}`abx_spec_abx_pkg`
```{py:module} abx_spec_abx_pkg
```
```{autodoc2-docstring} abx_spec_abx_pkg
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`AbxPkgPluginSpec <abx_spec_abx_pkg.AbxPkgPluginSpec>`
- ```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec
:summary:
```
* - {py:obj}`RequiredSpecsAvailable <abx_spec_abx_pkg.RequiredSpecsAvailable>`
- ```{autodoc2-docstring} abx_spec_abx_pkg.RequiredSpecsAvailable
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`PLUGIN_SPEC <abx_spec_abx_pkg.PLUGIN_SPEC>`
- ```{autodoc2-docstring} abx_spec_abx_pkg.PLUGIN_SPEC
:summary:
```
* - {py:obj}`TypedPluginManager <abx_spec_abx_pkg.TypedPluginManager>`
- ```{autodoc2-docstring} abx_spec_abx_pkg.TypedPluginManager
:summary:
```
* - {py:obj}`pm <abx_spec_abx_pkg.pm>`
- ```{autodoc2-docstring} abx_spec_abx_pkg.pm
:summary:
```
````
### API
`````{py:class} AbxPkgPluginSpec
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec
```
````{py:attribute} __order__
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.__order__
:value: >
10
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.__order__
```
````
````{py:method} get_LIB_DIR() -> pathlib.Path
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.get_LIB_DIR
:staticmethod:
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.get_LIB_DIR
```
````
````{py:method} get_BIN_DIR() -> pathlib.Path
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.get_BIN_DIR
:staticmethod:
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.get_BIN_DIR
```
````
````{py:method} get_BINPROVIDERS() -> typing.Dict[str, abx_pkg.BinProvider]
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.get_BINPROVIDERS
:staticmethod:
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.get_BINPROVIDERS
```
````
````{py:method} get_BINARIES() -> typing.Dict[str, abx_pkg.Binary]
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.get_BINARIES
:staticmethod:
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.get_BINARIES
```
````
````{py:method} get_BINPROVIDER(binprovider_name: str) -> abx_pkg.BinProvider
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.get_BINPROVIDER
:staticmethod:
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.get_BINPROVIDER
```
````
````{py:method} get_BINARY(bin_name: str) -> abx_pkg.Binary
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.get_BINARY
:staticmethod:
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.get_BINARY
```
````
````{py:method} binary_load(binary: abx_pkg.Binary, **kwargs) -> abx_pkg.Binary
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.binary_load
:staticmethod:
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.binary_load
```
````
````{py:method} binary_install(binary: abx_pkg.Binary, **kwargs) -> abx_pkg.Binary
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.binary_install
:staticmethod:
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.binary_install
```
````
````{py:method} binary_load_or_install(binary: abx_pkg.Binary, **kwargs) -> abx_pkg.Binary
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.binary_load_or_install
:staticmethod:
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.binary_load_or_install
```
````
````{py:method} binary_symlink_to_bin_dir(binary: abx_pkg.Binary, bin_dir: pathlib.Path | None = None)
:canonical: abx_spec_abx_pkg.AbxPkgPluginSpec.binary_symlink_to_bin_dir
:staticmethod:
```{autodoc2-docstring} abx_spec_abx_pkg.AbxPkgPluginSpec.binary_symlink_to_bin_dir
```
````
`````
````{py:data} PLUGIN_SPEC
:canonical: abx_spec_abx_pkg.PLUGIN_SPEC
:value: >
None
```{autodoc2-docstring} abx_spec_abx_pkg.PLUGIN_SPEC
```
````
````{py:class} RequiredSpecsAvailable
:canonical: abx_spec_abx_pkg.RequiredSpecsAvailable
Bases: {py:obj}`abx_spec_config.ConfigPluginSpec`, {py:obj}`abx_spec_abx_pkg.AbxPkgPluginSpec`
```{autodoc2-docstring} abx_spec_abx_pkg.RequiredSpecsAvailable
```
````
````{py:data} TypedPluginManager
:canonical: abx_spec_abx_pkg.TypedPluginManager
:value: >
None
```{autodoc2-docstring} abx_spec_abx_pkg.TypedPluginManager
```
````
````{py:data} pm
:canonical: abx_spec_abx_pkg.pm
:value: >
'cast(...)'
```{autodoc2-docstring} abx_spec_abx_pkg.pm
```
````

2
apidocs/abx_spec_archivebox/abx_spec_archivebox.md

@@ -73,7 +73,7 @@ abx_spec_archivebox.states
````{py:class} ArchiveBoxPluginSpec
:canonical: abx_spec_archivebox.ArchiveBoxPluginSpec
Bases: {py:obj}`abx_spec_config.ConfigPluginSpec`, {py:obj}`abx_spec_pydantic_pkgr.PydanticPkgrPluginSpec`, {py:obj}`abx_spec_django.DjangoPluginSpec`, {py:obj}`abx_spec_searchbackend.SearchBackendPluginSpec`
Bases: {py:obj}`abx_spec_config.ConfigPluginSpec`, {py:obj}`abx_spec_abx_pkg.AbxPkgPluginSpec`, {py:obj}`abx_spec_django.DjangoPluginSpec`, {py:obj}`abx_spec_searchbackend.SearchBackendPluginSpec`
```{autodoc2-docstring} abx_spec_archivebox.ArchiveBoxPluginSpec
```

35
apidocs/abx_spec_config/abx_spec_config.md

@@ -79,6 +79,7 @@ abx_spec_config.toml_util
````{py:method} get_collection_config_path() -> pathlib.Path
:canonical: abx_spec_config.ConfigPluginSpec.get_collection_config_path
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_collection_config_path
```
@@ -87,94 +88,106 @@ abx_spec_config.toml_util
````{py:method} get_system_config_path() -> pathlib.Path
:canonical: abx_spec_config.ConfigPluginSpec.get_system_config_path
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_system_config_path
```
````
````{py:method} get_CONFIG() -> typing.Dict[abx.PluginId, abx_spec_config.base_configset.BaseConfigSet]
````{py:method} get_CONFIG() -> dict[abx.PluginId, BaseConfigSet | ConstantsDict]
:canonical: abx_spec_config.ConfigPluginSpec.get_CONFIG
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_CONFIG
```
````
````{py:method} get_CONFIGS() -> typing.Dict[abx.PluginId, abx_spec_config.base_configset.BaseConfigSet]
````{py:method} get_CONFIGS() -> dict[abx.PluginId, abx_spec_config.base_configset.BaseConfigSet]
:canonical: abx_spec_config.ConfigPluginSpec.get_CONFIGS
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_CONFIGS
```
````
````{py:method} get_FLAT_CONFIG() -> typing.Dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
````{py:method} get_FLAT_CONFIG() -> dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
:canonical: abx_spec_config.ConfigPluginSpec.get_FLAT_CONFIG
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_FLAT_CONFIG
```
````
````{py:method} get_SCOPE_CONFIG(extra=None, archiveresult=None, snapshot=None, crawl=None, user=None, collection=..., environment=..., machine=..., default=...) -> typing.Dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
````{py:method} get_SCOPE_CONFIG(extra=None, archiveresult=None, snapshot=None, crawl=None, user=None, collection=..., environment=..., machine=..., default=...) -> dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
:canonical: abx_spec_config.ConfigPluginSpec.get_SCOPE_CONFIG
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_SCOPE_CONFIG
```
````
````{py:method} get_archiveresult_config(archiveresult) -> typing.Dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
````{py:method} get_archiveresult_config(archiveresult) -> dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
:canonical: abx_spec_config.ConfigPluginSpec.get_archiveresult_config
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_archiveresult_config
```
````
````{py:method} get_snapshot_config(snapshot) -> typing.Dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
````{py:method} get_snapshot_config(snapshot) -> dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
:canonical: abx_spec_config.ConfigPluginSpec.get_snapshot_config
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_snapshot_config
```
````
````{py:method} get_crawl_config(crawl) -> typing.Dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
````{py:method} get_crawl_config(crawl) -> dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
:canonical: abx_spec_config.ConfigPluginSpec.get_crawl_config
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_crawl_config
```
````
````{py:method} get_user_config(user=None) -> typing.Dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
````{py:method} get_user_config(user=None) -> dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
:canonical: abx_spec_config.ConfigPluginSpec.get_user_config
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_user_config
```
````
````{py:method} get_collection_config(collection=...) -> typing.Dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
````{py:method} get_collection_config(collection=...) -> dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
:canonical: abx_spec_config.ConfigPluginSpec.get_collection_config
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_collection_config
```
````
````{py:method} get_environment_config(environment=...) -> typing.Dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
````{py:method} get_environment_config(environment=...) -> dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
:canonical: abx_spec_config.ConfigPluginSpec.get_environment_config
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_environment_config
```
````
````{py:method} get_default_config(default=...) -> typing.Dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
````{py:method} get_default_config(default=...) -> dict[abx_spec_config.base_configset.ConfigKeyStr, typing.Any]
:canonical: abx_spec_config.ConfigPluginSpec.get_default_config
:staticmethod:
```{autodoc2-docstring} abx_spec_config.ConfigPluginSpec.get_default_config
```

24
apidocs/abx_spec_django/abx_spec_django.md

@@ -31,10 +31,6 @@
:class: autosummary longtable
:align: left
* - {py:obj}`__order__ <abx_spec_django.__order__>`
- ```{autodoc2-docstring} abx_spec_django.__order__
:summary:
```
* - {py:obj}`PLUGIN_SPEC <abx_spec_django.PLUGIN_SPEC>`
- ```{autodoc2-docstring} abx_spec_django.PLUGIN_SPEC
:summary:
@@ -51,22 +47,22 @@
### API
````{py:data} __order__
:canonical: abx_spec_django.__order__
:value: >
300
```{autodoc2-docstring} abx_spec_django.__order__
```
````
`````{py:class} DjangoPluginSpec
:canonical: abx_spec_django.DjangoPluginSpec
```{autodoc2-docstring} abx_spec_django.DjangoPluginSpec
```
````{py:attribute} __order__
:canonical: abx_spec_django.DjangoPluginSpec.__order__
:value: >
10
```{autodoc2-docstring} abx_spec_django.DjangoPluginSpec.__order__
```
````
````{py:method} get_INSTALLED_APPS() -> typing.List[str]
:canonical: abx_spec_django.DjangoPluginSpec.get_INSTALLED_APPS

16
apidocs/abx_spec_extractor/abx_spec_extractor.md

@@ -51,6 +51,10 @@
:class: autosummary longtable
:align: left
* - {py:obj}`__order__ <abx_spec_extractor.__order__>`
- ```{autodoc2-docstring} abx_spec_extractor.__order__
:summary:
```
* - {py:obj}`ExtractorName <abx_spec_extractor.ExtractorName>`
- ```{autodoc2-docstring} abx_spec_extractor.ExtractorName
:summary:
@@ -67,6 +71,16 @@
### API
````{py:data} __order__
:canonical: abx_spec_extractor.__order__
:value: >
10
```{autodoc2-docstring} abx_spec_extractor.__order__
```
````
````{py:function} assert_no_empty_args(args: typing.List[str]) -> typing.List[str]
:canonical: abx_spec_extractor.assert_no_empty_args
@@ -144,7 +158,7 @@
````{py:attribute} binary
:canonical: abx_spec_extractor.BaseExtractor.binary
:type: pydantic_pkgr.BinName
:type: abx_pkg.BinName
:value: >
None

11
apidocs/abx_spec_searchbackend/abx_spec_searchbackend.md

@@ -103,8 +103,19 @@ Bases: {py:obj}`abc.ABC`
```{autodoc2-docstring} abx_spec_searchbackend.SearchBackendPluginSpec
```
````{py:attribute} __order__
:canonical: abx_spec_searchbackend.SearchBackendPluginSpec.__order__
:value: >
10
```{autodoc2-docstring} abx_spec_searchbackend.SearchBackendPluginSpec.__order__
```
````
````{py:method} get_SEARCHBACKENDS() -> typing.Dict[abx.PluginId, abx_spec_searchbackend.BaseSearchBackend]
:canonical: abx_spec_searchbackend.SearchBackendPluginSpec.get_SEARCHBACKENDS
:staticmethod:
```{autodoc2-docstring} abx_spec_searchbackend.SearchBackendPluginSpec.get_SEARCHBACKENDS
```

8
apidocs/archivebox/archivebox.abid_utils.models.md

@@ -221,6 +221,14 @@ Bases: {py:obj}`django_stubs_ext.db.models.TypedModelMeta`
`````
````{py:method} TYPE() -> str
:canonical: archivebox.abid_utils.models.ABIDModel.TYPE
```{autodoc2-docstring} archivebox.abid_utils.models.ABIDModel.TYPE
```
````
````{py:method} __str__() -> str
:canonical: archivebox.abid_utils.models.ABIDModel.__str__

5
apidocs/archivebox/archivebox.actors.actor.md

@@ -231,7 +231,7 @@ Bases: {py:obj}`typing.Generic`\[{py:obj}`archivebox.actors.actor.ModelType`\]
:canonical: archivebox.actors.actor.ActorType.STATE_FIELD_NAME
:type: typing.ClassVar[str]
:value: >
None
'status'
```{autodoc2-docstring} archivebox.actors.actor.ActorType.STATE_FIELD_NAME
```
@@ -242,7 +242,7 @@ Bases: {py:obj}`typing.Generic`\[{py:obj}`archivebox.actors.actor.ModelType`\]
:canonical: archivebox.actors.actor.ActorType.ACTIVE_STATE
:type: typing.ClassVar[archivebox.actors.actor.ObjectState]
:value: >
None
'started'
```{autodoc2-docstring} archivebox.actors.actor.ActorType.ACTIVE_STATE
```
@@ -586,6 +586,7 @@ Bases: {py:obj}`typing.Generic`\[{py:obj}`archivebox.actors.actor.ModelType`\]
````{py:method} get_update_kwargs_to_claim_obj() -> dict[str, typing.Any]
:canonical: archivebox.actors.actor.ActorType.get_update_kwargs_to_claim_obj
:classmethod:
```{autodoc2-docstring} archivebox.actors.actor.ActorType.get_update_kwargs_to_claim_obj
```

26
apidocs/archivebox/archivebox.actors.md

@@ -20,3 +20,29 @@ archivebox.actors.orchestrator
archivebox.actors.actor
archivebox.actors.views
```
## Package Contents
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`__order__ <archivebox.actors.__order__>`
- ```{autodoc2-docstring} archivebox.actors.__order__
:summary:
```
````
### API
````{py:data} __order__
:canonical: archivebox.actors.__order__
:value: >
100
```{autodoc2-docstring} archivebox.actors.__order__
```
````

107
apidocs/archivebox/archivebox.actors.orchestrator.md

@@ -19,17 +19,11 @@
- ```{autodoc2-docstring} archivebox.actors.orchestrator.Orchestrator
:summary:
```
* - {py:obj}`FaviconActor <archivebox.actors.orchestrator.FaviconActor>`
-
* - {py:obj}`ExtractorsOrchestrator <archivebox.actors.orchestrator.ExtractorsOrchestrator>`
- ```{autodoc2-docstring} archivebox.actors.orchestrator.ExtractorsOrchestrator
:summary:
```
````
### API
`````{py:class} Orchestrator(actor_types: typing.Dict[str, typing.Type[archivebox.actors.actor.ActorType]] | None = None, mode: typing.Literal[thread, process] | None = None)
`````{py:class} Orchestrator(actor_types: typing.Dict[str, typing.Type[archivebox.actors.actor.ActorType]] | None = None, mode: typing.Literal[thread, process] | None = None, exit_on_idle: bool = True)
:canonical: archivebox.actors.orchestrator.Orchestrator
```{autodoc2-docstring} archivebox.actors.orchestrator.Orchestrator
@@ -85,6 +79,17 @@
````
````{py:attribute} exit_on_idle
:canonical: archivebox.actors.orchestrator.Orchestrator.exit_on_idle
:type: bool
:value: >
True
```{autodoc2-docstring} archivebox.actors.orchestrator.Orchestrator.exit_on_idle
```
````
````{py:method} __repr__() -> str
:canonical: archivebox.actors.orchestrator.Orchestrator.__repr__
@@ -145,6 +150,15 @@
````
````{py:method} has_future_objects(all_queues) -> bool
:canonical: archivebox.actors.orchestrator.Orchestrator.has_future_objects
:classmethod:
```{autodoc2-docstring} archivebox.actors.orchestrator.Orchestrator.has_future_objects
```
````
````{py:method} on_startup()
:canonical: archivebox.actors.orchestrator.Orchestrator.on_startup
@@ -194,82 +208,3 @@
````
`````
`````{py:class} FaviconActor(mode: typing.Literal[thread, process] | None = None, **launch_kwargs: archivebox.actors.actor.LaunchKwargs)
:canonical: archivebox.actors.orchestrator.FaviconActor
Bases: {py:obj}`archivebox.actors.actor.ActorType`\[{py:obj}`core.models.ArchiveResult`\]
````{py:attribute} CLAIM_ORDER
:canonical: archivebox.actors.orchestrator.FaviconActor.CLAIM_ORDER
:type: typing.ClassVar[str]
:value: >
'created_at DESC'
```{autodoc2-docstring} archivebox.actors.orchestrator.FaviconActor.CLAIM_ORDER
```
````
````{py:attribute} CLAIM_WHERE
:canonical: archivebox.actors.orchestrator.FaviconActor.CLAIM_WHERE
:type: typing.ClassVar[str]
:value: >
'status = "queued" AND extractor = "favicon"'
```{autodoc2-docstring} archivebox.actors.orchestrator.FaviconActor.CLAIM_WHERE
```
````
````{py:attribute} CLAIM_SET
:canonical: archivebox.actors.orchestrator.FaviconActor.CLAIM_SET
:type: typing.ClassVar[str]
:value: >
'status = "started"'
```{autodoc2-docstring} archivebox.actors.orchestrator.FaviconActor.CLAIM_SET
```
````
````{py:method} QUERYSET() -> django.db.models.QuerySet
:canonical: archivebox.actors.orchestrator.FaviconActor.QUERYSET
```{autodoc2-docstring} archivebox.actors.orchestrator.FaviconActor.QUERYSET
```
````
````{py:method} tick(obj: core.models.ArchiveResult)
:canonical: archivebox.actors.orchestrator.FaviconActor.tick
````
`````
`````{py:class} ExtractorsOrchestrator(actor_types: typing.Dict[str, typing.Type[archivebox.actors.actor.ActorType]] | None = None, mode: typing.Literal[thread, process] | None = None)
:canonical: archivebox.actors.orchestrator.ExtractorsOrchestrator
Bases: {py:obj}`archivebox.actors.orchestrator.Orchestrator`
```{autodoc2-docstring} archivebox.actors.orchestrator.ExtractorsOrchestrator
```
```{rubric} Initialization
```
```{autodoc2-docstring} archivebox.actors.orchestrator.ExtractorsOrchestrator.__init__
```
````{py:attribute} actor_types
:canonical: archivebox.actors.orchestrator.ExtractorsOrchestrator.actor_types
:value: >
None
```{autodoc2-docstring} archivebox.actors.orchestrator.ExtractorsOrchestrator.actor_types
```
````
`````

47
apidocs/archivebox/archivebox.actors.views.md

@@ -6,3 +6,50 @@
```{autodoc2-docstring} archivebox.actors.views
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`JobsDashboardView <archivebox.actors.views.JobsDashboardView>`
-
````
### API
`````{py:class} JobsDashboardView(**kwargs)
:canonical: archivebox.actors.views.JobsDashboardView
Bases: {py:obj}`django.contrib.auth.mixins.UserPassesTestMixin`, {py:obj}`django.views.generic.TemplateView`
````{py:attribute} template_name
:canonical: archivebox.actors.views.JobsDashboardView.template_name
:value: >
'jobs_dashboard.html'
```{autodoc2-docstring} archivebox.actors.views.JobsDashboardView.template_name
```
````
````{py:method} test_func()
:canonical: archivebox.actors.views.JobsDashboardView.test_func
```{autodoc2-docstring} archivebox.actors.views.JobsDashboardView.test_func
```
````
````{py:method} get_context_data(**kwargs)
:canonical: archivebox.actors.views.JobsDashboardView.get_context_data
```{autodoc2-docstring} archivebox.actors.views.JobsDashboardView.get_context_data
```
````
`````

1
apidocs/archivebox/archivebox.api.md

@@ -18,6 +18,7 @@ archivebox.api.v1_auth
archivebox.api.v1_api
archivebox.api.models
archivebox.api.v1_cli
archivebox.api.v1_actors
archivebox.api.v1_core
archivebox.api.apps
archivebox.api.admin

468
apidocs/archivebox/archivebox.api.v1_actors.md Normal file

@@ -0,0 +1,468 @@
# {py:mod}`archivebox.api.v1_actors`
```{py:module} archivebox.api.v1_actors
```
```{autodoc2-docstring} archivebox.api.v1_actors
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`TaskSchema <archivebox.api.v1_actors.TaskSchema>`
-
* - {py:obj}`ActorSchema <archivebox.api.v1_actors.ActorSchema>`
-
* - {py:obj}`OrchestratorSchema <archivebox.api.v1_actors.OrchestratorSchema>`
-
````
### Functions
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`get_orchestrators <archivebox.api.v1_actors.get_orchestrators>`
- ```{autodoc2-docstring} archivebox.api.v1_actors.get_orchestrators
:summary:
```
* - {py:obj}`get_actors <archivebox.api.v1_actors.get_actors>`
- ```{autodoc2-docstring} archivebox.api.v1_actors.get_actors
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`router <archivebox.api.v1_actors.router>`
- ```{autodoc2-docstring} archivebox.api.v1_actors.router
:summary:
```
````
### API
````{py:data} router
:canonical: archivebox.api.v1_actors.router
:value: >
'Router(...)'
```{autodoc2-docstring} archivebox.api.v1_actors.router
```
````
`````{py:class} TaskSchema(/, **data: typing.Any)
:canonical: archivebox.api.v1_actors.TaskSchema
Bases: {py:obj}`ninja.Schema`
````{py:attribute} TYPE
:canonical: archivebox.api.v1_actors.TaskSchema.TYPE
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.TaskSchema.TYPE
```
````
````{py:attribute} id
:canonical: archivebox.api.v1_actors.TaskSchema.id
:type: uuid.UUID
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.TaskSchema.id
```
````
````{py:attribute} abid
:canonical: archivebox.api.v1_actors.TaskSchema.abid
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.TaskSchema.abid
```
````
````{py:attribute} description
:canonical: archivebox.api.v1_actors.TaskSchema.description
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.TaskSchema.description
```
````
````{py:attribute} status
:canonical: archivebox.api.v1_actors.TaskSchema.status
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.TaskSchema.status
```
````
````{py:attribute} retry_at
:canonical: archivebox.api.v1_actors.TaskSchema.retry_at
:type: datetime.datetime | None
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.TaskSchema.retry_at
```
````
````{py:attribute} created_at
:canonical: archivebox.api.v1_actors.TaskSchema.created_at
:type: datetime.datetime
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.TaskSchema.created_at
```
````
````{py:attribute} modified_at
:canonical: archivebox.api.v1_actors.TaskSchema.modified_at
:type: datetime.datetime
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.TaskSchema.modified_at
```
````
````{py:attribute} created_by_id
:canonical: archivebox.api.v1_actors.TaskSchema.created_by_id
:type: int
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.TaskSchema.created_by_id
```
````
````{py:method} resolve_description(obj) -> str
:canonical: archivebox.api.v1_actors.TaskSchema.resolve_description
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_actors.TaskSchema.resolve_description
```
````
`````
`````{py:class} ActorSchema(/, **data: typing.Any)
:canonical: archivebox.api.v1_actors.ActorSchema
Bases: {py:obj}`ninja.Schema`
````{py:attribute} idle_count
:canonical: archivebox.api.v1_actors.ActorSchema.idle_count
:type: int
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.idle_count
```
````
````{py:attribute} launch_kwargs
:canonical: archivebox.api.v1_actors.ActorSchema.launch_kwargs
:type: dict[str, typing.Any]
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.launch_kwargs
```
````
````{py:attribute} mode
:canonical: archivebox.api.v1_actors.ActorSchema.mode
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.mode
```
````
````{py:attribute} model
:canonical: archivebox.api.v1_actors.ActorSchema.model
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.model
```
````
````{py:attribute} statemachine
:canonical: archivebox.api.v1_actors.ActorSchema.statemachine
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.statemachine
```
````
````{py:attribute} STATE_FIELD_NAME
:canonical: archivebox.api.v1_actors.ActorSchema.STATE_FIELD_NAME
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.STATE_FIELD_NAME
```
````
````{py:attribute} FINAL_STATES
:canonical: archivebox.api.v1_actors.ActorSchema.FINAL_STATES
:type: list[str]
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.FINAL_STATES
```
````
````{py:attribute} EVENT_NAME
:canonical: archivebox.api.v1_actors.ActorSchema.EVENT_NAME
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.EVENT_NAME
```
````
````{py:attribute} CLAIM_ORDER
:canonical: archivebox.api.v1_actors.ActorSchema.CLAIM_ORDER
:type: list[str]
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.CLAIM_ORDER
```
````
````{py:attribute} CLAIM_FROM_TOP_N
:canonical: archivebox.api.v1_actors.ActorSchema.CLAIM_FROM_TOP_N
:type: int
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.CLAIM_FROM_TOP_N
```
````
````{py:attribute} CLAIM_ATOMIC
:canonical: archivebox.api.v1_actors.ActorSchema.CLAIM_ATOMIC
:type: bool
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.CLAIM_ATOMIC
```
````
````{py:attribute} MAX_TICK_TIME
:canonical: archivebox.api.v1_actors.ActorSchema.MAX_TICK_TIME
:type: int
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.MAX_TICK_TIME
```
````
````{py:attribute} MAX_CONCURRENT_ACTORS
:canonical: archivebox.api.v1_actors.ActorSchema.MAX_CONCURRENT_ACTORS
:type: int
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.MAX_CONCURRENT_ACTORS
```
````
````{py:attribute} queue
:canonical: archivebox.api.v1_actors.ActorSchema.queue
:type: list[archivebox.api.v1_actors.TaskSchema]
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.queue
```
````
````{py:attribute} past
:canonical: archivebox.api.v1_actors.ActorSchema.past
:type: list[archivebox.api.v1_actors.TaskSchema]
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.past
```
````
````{py:method} resolve_model(obj) -> str
:canonical: archivebox.api.v1_actors.ActorSchema.resolve_model
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.resolve_model
```
````
````{py:method} resolve_statemachine(obj) -> str
:canonical: archivebox.api.v1_actors.ActorSchema.resolve_statemachine
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.resolve_statemachine
```
````
````{py:method} resolve_name(obj) -> str
:canonical: archivebox.api.v1_actors.ActorSchema.resolve_name
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.resolve_name
```
````
````{py:method} resolve_FINAL_STATES(obj) -> list[str]
:canonical: archivebox.api.v1_actors.ActorSchema.resolve_FINAL_STATES
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.resolve_FINAL_STATES
```
````
````{py:method} resolve_queue(obj) -> list[archivebox.api.v1_actors.TaskSchema]
:canonical: archivebox.api.v1_actors.ActorSchema.resolve_queue
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.resolve_queue
```
````
````{py:method} resolve_past(obj) -> list[archivebox.api.v1_actors.TaskSchema]
:canonical: archivebox.api.v1_actors.ActorSchema.resolve_past
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_actors.ActorSchema.resolve_past
```
````
`````
`````{py:class} OrchestratorSchema(/, **data: typing.Any)
:canonical: archivebox.api.v1_actors.OrchestratorSchema
Bases: {py:obj}`ninja.Schema`
````{py:attribute} exit_on_idle
:canonical: archivebox.api.v1_actors.OrchestratorSchema.exit_on_idle
:type: bool
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.OrchestratorSchema.exit_on_idle
```
````
````{py:attribute} mode
:canonical: archivebox.api.v1_actors.OrchestratorSchema.mode
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.OrchestratorSchema.mode
```
````
````{py:attribute} actors
:canonical: archivebox.api.v1_actors.OrchestratorSchema.actors
:type: list[archivebox.api.v1_actors.ActorSchema]
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_actors.OrchestratorSchema.actors
```
````
````{py:method} resolve_actors(obj) -> list[archivebox.api.v1_actors.ActorSchema]
:canonical: archivebox.api.v1_actors.OrchestratorSchema.resolve_actors
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_actors.OrchestratorSchema.resolve_actors
```
````
`````
````{py:function} get_orchestrators(request)
:canonical: archivebox.api.v1_actors.get_orchestrators
```{autodoc2-docstring} archivebox.api.v1_actors.get_orchestrators
```
````
````{py:function} get_actors(request)
:canonical: archivebox.api.v1_actors.get_actors
```{autodoc2-docstring} archivebox.api.v1_actors.get_actors
```
````

13
apidocs/archivebox/archivebox.api.v1_cli.md

@@ -137,6 +137,17 @@ Bases: {py:obj}`ninja.Schema`
````
````{py:attribute} result_format
:canonical: archivebox.api.v1_cli.CLICommandResponseSchema.result_format
:type: str
:value: >
'str'
```{autodoc2-docstring} archivebox.api.v1_cli.CLICommandResponseSchema.result_format
```
````
````{py:attribute} stdout
:canonical: archivebox.api.v1_cli.CLICommandResponseSchema.stdout
:type: str
@@ -755,7 +766,7 @@ Bases: {py:obj}`ninja.Schema`
````{py:attribute} as_csv
:canonical: archivebox.api.v1_cli.ListCommandSchema.as_csv
:type: str | bool
:type: str | None
:value: >
'timestamp,url'

440
apidocs/archivebox/archivebox.api.v1_core.md

@@ -29,6 +29,10 @@
-
* - {py:obj}`TagSchema <archivebox.api.v1_core.TagSchema>`
-
* - {py:obj}`SeedSchema <archivebox.api.v1_core.SeedSchema>`
-
* - {py:obj}`CrawlSchema <archivebox.api.v1_core.CrawlSchema>`
-
````
### Functions
@@ -61,6 +65,22 @@
- ```{autodoc2-docstring} archivebox.api.v1_core.get_tag
:summary:
```
* - {py:obj}`get_seeds <archivebox.api.v1_core.get_seeds>`
- ```{autodoc2-docstring} archivebox.api.v1_core.get_seeds
:summary:
```
* - {py:obj}`get_seed <archivebox.api.v1_core.get_seed>`
- ```{autodoc2-docstring} archivebox.api.v1_core.get_seed
:summary:
```
* - {py:obj}`get_crawls <archivebox.api.v1_core.get_crawls>`
- ```{autodoc2-docstring} archivebox.api.v1_core.get_crawls
:summary:
```
* - {py:obj}`get_crawl <archivebox.api.v1_core.get_crawl>`
- ```{autodoc2-docstring} archivebox.api.v1_core.get_crawl
:summary:
```
* - {py:obj}`get_any <archivebox.api.v1_core.get_any>`
- ```{autodoc2-docstring} archivebox.api.v1_core.get_any
:summary:
@@ -268,20 +288,9 @@ Bases: {py:obj}`ninja.Schema`
````
````{py:attribute} modified_at
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.modified_at
:type: datetime.datetime
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.MinimalArchiveResultSchema.modified_at
```
````
````{py:attribute} created_at
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.created_at
:type: datetime.datetime
:type: datetime.datetime | None
:value: >
None
@@ -290,6 +299,17 @@ Bases: {py:obj}`ninja.Schema`
````
````{py:attribute} modified_at
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.modified_at
:type: datetime.datetime | None
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.MinimalArchiveResultSchema.modified_at
```
````
````{py:attribute} created_by_id
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.created_by_id
:type: str
@@ -312,6 +332,28 @@ Bases: {py:obj}`ninja.Schema`
````
````{py:attribute} status
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.status
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.MinimalArchiveResultSchema.status
```
````
````{py:attribute} retry_at
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.retry_at
:type: datetime.datetime | None
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.MinimalArchiveResultSchema.retry_at
```
````
````{py:attribute} extractor
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.extractor
:type: str
@@ -325,7 +367,7 @@ Bases: {py:obj}`ninja.Schema`
````{py:attribute} cmd_version
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.cmd_version
:type: typing.Optional[str]
:type: str | None
:value: >
None
@@ -336,7 +378,7 @@ Bases: {py:obj}`ninja.Schema`
````{py:attribute} cmd
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.cmd
:type: typing.List[str]
:type: list[str] | None
:value: >
None
@@ -347,7 +389,7 @@ Bases: {py:obj}`ninja.Schema`
````{py:attribute} pwd
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.pwd
:type: str
:type: str | None
:value: >
None
@@ -356,20 +398,9 @@ Bases: {py:obj}`ninja.Schema`
````
````{py:attribute} status
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.status
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.MinimalArchiveResultSchema.status
```
````
````{py:attribute} output
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.output
:type: str
:type: str | None
:value: >
None
@@ -380,7 +411,7 @@ Bases: {py:obj}`ninja.Schema`
````{py:attribute} start_ts
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.start_ts
:type: typing.Optional[datetime.datetime]
:type: datetime.datetime | None
:value: >
None
@@ -391,7 +422,7 @@ Bases: {py:obj}`ninja.Schema`
````{py:attribute} end_ts
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.end_ts
:type: typing.Optional[datetime.datetime]
:type: datetime.datetime | None
:value: >
None
@@ -409,7 +440,7 @@ Bases: {py:obj}`ninja.Schema`
````
````{py:method} resolve_created_by_username(obj)
````{py:method} resolve_created_by_username(obj) -> str
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.resolve_created_by_username
:staticmethod:
@@ -427,15 +458,6 @@ Bases: {py:obj}`ninja.Schema`
````
````{py:method} resolve_created_at(obj)
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.resolve_created_at
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_core.MinimalArchiveResultSchema.resolve_created_at
```
````
````{py:method} resolve_snapshot_timestamp(obj)
:canonical: archivebox.api.v1_core.MinimalArchiveResultSchema.resolve_snapshot_timestamp
:staticmethod:
@@ -813,6 +835,28 @@ Bases: {py:obj}`ninja.Schema`
````
````{py:attribute} status
:canonical: archivebox.api.v1_core.SnapshotSchema.status
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SnapshotSchema.status
```
````
````{py:attribute} retry_at
:canonical: archivebox.api.v1_core.SnapshotSchema.retry_at
:type: datetime.datetime | None
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SnapshotSchema.retry_at
```
````
````{py:attribute} bookmarked_at
:canonical: archivebox.api.v1_core.SnapshotSchema.bookmarked_at
:type: datetime.datetime
@@ -1354,6 +1398,324 @@ Bases: {py:obj}`ninja.Schema`
```
````
`````{py:class} SeedSchema(/, **data: typing.Any)
:canonical: archivebox.api.v1_core.SeedSchema
Bases: {py:obj}`ninja.Schema`
````{py:attribute} TYPE
:canonical: archivebox.api.v1_core.SeedSchema.TYPE
:type: str
:value: >
'seeds.models.Seed'
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.TYPE
```
````
````{py:attribute} id
:canonical: archivebox.api.v1_core.SeedSchema.id
:type: uuid.UUID
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.id
```
````
````{py:attribute} abid
:canonical: archivebox.api.v1_core.SeedSchema.abid
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.abid
```
````
````{py:attribute} modified_at
:canonical: archivebox.api.v1_core.SeedSchema.modified_at
:type: datetime.datetime
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.modified_at
```
````
````{py:attribute} created_at
:canonical: archivebox.api.v1_core.SeedSchema.created_at
:type: datetime.datetime
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.created_at
```
````
````{py:attribute} created_by_id
:canonical: archivebox.api.v1_core.SeedSchema.created_by_id
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.created_by_id
```
````
````{py:attribute} created_by_username
:canonical: archivebox.api.v1_core.SeedSchema.created_by_username
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.created_by_username
```
````
````{py:attribute} uri
:canonical: archivebox.api.v1_core.SeedSchema.uri
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.uri
```
````
````{py:attribute} tags_str
:canonical: archivebox.api.v1_core.SeedSchema.tags_str
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.tags_str
```
````
````{py:attribute} config
:canonical: archivebox.api.v1_core.SeedSchema.config
:type: dict
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.config
```
````
````{py:method} resolve_created_by_id(obj)
:canonical: archivebox.api.v1_core.SeedSchema.resolve_created_by_id
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.resolve_created_by_id
```
````
````{py:method} resolve_created_by_username(obj)
:canonical: archivebox.api.v1_core.SeedSchema.resolve_created_by_username
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_core.SeedSchema.resolve_created_by_username
```
````
`````
````{py:function} get_seeds(request)
:canonical: archivebox.api.v1_core.get_seeds
```{autodoc2-docstring} archivebox.api.v1_core.get_seeds
```
````
````{py:function} get_seed(request, seed_id: str)
:canonical: archivebox.api.v1_core.get_seed
```{autodoc2-docstring} archivebox.api.v1_core.get_seed
```
````
`````{py:class} CrawlSchema(/, **data: typing.Any)
:canonical: archivebox.api.v1_core.CrawlSchema
Bases: {py:obj}`ninja.Schema`
````{py:attribute} TYPE
:canonical: archivebox.api.v1_core.CrawlSchema.TYPE
:type: str
:value: >
'core.models.Crawl'
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.TYPE
```
````
````{py:attribute} id
:canonical: archivebox.api.v1_core.CrawlSchema.id
:type: uuid.UUID
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.id
```
````
````{py:attribute} abid
:canonical: archivebox.api.v1_core.CrawlSchema.abid
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.abid
```
````
````{py:attribute} modified_at
:canonical: archivebox.api.v1_core.CrawlSchema.modified_at
:type: datetime.datetime
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.modified_at
```
````
````{py:attribute} created_at
:canonical: archivebox.api.v1_core.CrawlSchema.created_at
:type: datetime.datetime
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.created_at
```
````
````{py:attribute} created_by_id
:canonical: archivebox.api.v1_core.CrawlSchema.created_by_id
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.created_by_id
```
````
````{py:attribute} created_by_username
:canonical: archivebox.api.v1_core.CrawlSchema.created_by_username
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.created_by_username
```
````
````{py:attribute} status
:canonical: archivebox.api.v1_core.CrawlSchema.status
:type: str
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.status
```
````
````{py:attribute} retry_at
:canonical: archivebox.api.v1_core.CrawlSchema.retry_at
:type: datetime.datetime | None
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.retry_at
```
````
````{py:attribute} seed
:canonical: archivebox.api.v1_core.CrawlSchema.seed
:type: archivebox.api.v1_core.SeedSchema
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.seed
```
````
````{py:attribute} max_depth
:canonical: archivebox.api.v1_core.CrawlSchema.max_depth
:type: int
:value: >
None
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.max_depth
```
````
````{py:method} resolve_created_by_id(obj)
:canonical: archivebox.api.v1_core.CrawlSchema.resolve_created_by_id
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.resolve_created_by_id
```
````
````{py:method} resolve_created_by_username(obj)
:canonical: archivebox.api.v1_core.CrawlSchema.resolve_created_by_username
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.resolve_created_by_username
```
````
````{py:method} resolve_snapshots(obj, context)
:canonical: archivebox.api.v1_core.CrawlSchema.resolve_snapshots
:staticmethod:
```{autodoc2-docstring} archivebox.api.v1_core.CrawlSchema.resolve_snapshots
```
````
`````
````{py:function} get_crawls(request)
:canonical: archivebox.api.v1_core.get_crawls
```{autodoc2-docstring} archivebox.api.v1_core.get_crawls
```
````
````{py:function} get_crawl(request, crawl_id: str, with_snapshots: bool = False, with_archiveresults: bool = False)
:canonical: archivebox.api.v1_core.get_crawl
```{autodoc2-docstring} archivebox.api.v1_core.get_crawl
```
````
````{py:function} get_any(request, abid: str)
:canonical: archivebox.api.v1_core.get_any

27
apidocs/archivebox/archivebox.cli.archivebox_add.md

@@ -15,6 +15,10 @@
:class: autosummary longtable
:align: left
* - {py:obj}`add <archivebox.cli.archivebox_add.add>`
- ```{autodoc2-docstring} archivebox.cli.archivebox_add.add
:summary:
```
* - {py:obj}`main <archivebox.cli.archivebox_add.main>`
- ```{autodoc2-docstring} archivebox.cli.archivebox_add.main
:summary:
@@ -31,6 +35,10 @@
- ```{autodoc2-docstring} archivebox.cli.archivebox_add.__command__
:summary:
```
* - {py:obj}`ORCHESTRATOR <archivebox.cli.archivebox_add.ORCHESTRATOR>`
- ```{autodoc2-docstring} archivebox.cli.archivebox_add.ORCHESTRATOR
:summary:
```
````
### API
@@ -45,7 +53,24 @@
````
````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None
````{py:data} ORCHESTRATOR
:canonical: archivebox.cli.archivebox_add.ORCHESTRATOR
:value: >
None
```{autodoc2-docstring} archivebox.cli.archivebox_add.ORCHESTRATOR
```
````
````{py:function} add(urls: str | list[str], tag: str = '', depth: int = 0, update: bool = not ARCHIVING_CONFIG.ONLY_NEW, update_all: bool = False, index_only: bool = False, overwrite: bool = False, extractors: str = '', parser: str = 'auto', persona: str = 'Default', created_by_id: int | None = None) -> django.db.models.QuerySet[core.models.Snapshot]
:canonical: archivebox.cli.archivebox_add.add
```{autodoc2-docstring} archivebox.cli.archivebox_add.add
```
````
````{py:function} main(args: list[str] | None = None, stdin: typing.IO | None = None, pwd: str | None = None) -> None
:canonical: archivebox.cli.archivebox_add.main
```{autodoc2-docstring} archivebox.cli.archivebox_add.main

11
apidocs/archivebox/archivebox.cli.archivebox_update.md

@@ -15,6 +15,10 @@
:class: autosummary longtable
:align: left
* - {py:obj}`update <archivebox.cli.archivebox_update.update>`
- ```{autodoc2-docstring} archivebox.cli.archivebox_update.update
:summary:
```
* - {py:obj}`main <archivebox.cli.archivebox_update.main>`
- ```{autodoc2-docstring} archivebox.cli.archivebox_update.main
:summary:
@@ -45,6 +49,13 @@
````
````{py:function} update()
:canonical: archivebox.cli.archivebox_update.update
```{autodoc2-docstring} archivebox.cli.archivebox_update.update
```
````
````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None
:canonical: archivebox.cli.archivebox_update.main

11
apidocs/archivebox/archivebox.config.common.md

@@ -614,6 +614,17 @@ Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`
````
````{py:attribute} DEFAULT_PERSONA
:canonical: archivebox.config.common.ArchivingConfig.DEFAULT_PERSONA
:type: str
:value: >
'Field(...)'
```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.DEFAULT_PERSONA
```
````
````{py:method} validate()
:canonical: archivebox.config.common.ArchivingConfig.validate

15
apidocs/archivebox/archivebox.config.permissions.md

@@ -71,6 +71,10 @@
- ```{autodoc2-docstring} archivebox.config.permissions.USER
:summary:
```
* - {py:obj}`HOSTNAME <archivebox.config.permissions.HOSTNAME>`
- ```{autodoc2-docstring} archivebox.config.permissions.HOSTNAME
:summary:
```
* - {py:obj}`IS_ROOT <archivebox.config.permissions.IS_ROOT>`
- ```{autodoc2-docstring} archivebox.config.permissions.IS_ROOT
:summary:
@@ -204,6 +208,17 @@
````
````{py:data} HOSTNAME
:canonical: archivebox.config.permissions.HOSTNAME
:type: str
:value: >
'max(...)'
```{autodoc2-docstring} archivebox.config.permissions.HOSTNAME
```
````
````{py:data} IS_ROOT
:canonical: archivebox.config.permissions.IS_ROOT
:value: >

30
apidocs/archivebox/archivebox.core.actors.md

@@ -16,9 +16,13 @@
:align: left
* - {py:obj}`SnapshotActor <archivebox.core.actors.SnapshotActor>`
-
- ```{autodoc2-docstring} archivebox.core.actors.SnapshotActor
:summary:
```
* - {py:obj}`ArchiveResultActor <archivebox.core.actors.ArchiveResultActor>`
-
- ```{autodoc2-docstring} archivebox.core.actors.ArchiveResultActor
:summary:
```
````
### API
@@ -28,6 +32,15 @@
Bases: {py:obj}`actors.actor.ActorType`\[{py:obj}`core.models.Snapshot`\]
```{autodoc2-docstring} archivebox.core.actors.SnapshotActor
```
```{rubric} Initialization
```
```{autodoc2-docstring} archivebox.core.actors.SnapshotActor.__init__
```
````{py:attribute} Model
:canonical: archivebox.core.actors.SnapshotActor.Model
:value: >
@@ -85,7 +98,7 @@ Bases: {py:obj}`actors.actor.ActorType`\[{py:obj}`core.models.Snapshot`\]
:canonical: archivebox.core.actors.SnapshotActor.MAX_CONCURRENT_ACTORS
:type: typing.ClassVar[int]
:value: >
3
1
```{autodoc2-docstring} archivebox.core.actors.SnapshotActor.MAX_CONCURRENT_ACTORS
```
@@ -121,6 +134,15 @@ Bases: {py:obj}`actors.actor.ActorType`\[{py:obj}`core.models.Snapshot`\]
Bases: {py:obj}`actors.actor.ActorType`\[{py:obj}`core.models.ArchiveResult`\]
```{autodoc2-docstring} archivebox.core.actors.ArchiveResultActor
```
```{rubric} Initialization
```
```{autodoc2-docstring} archivebox.core.actors.ArchiveResultActor.__init__
```
````{py:attribute} Model
:canonical: archivebox.core.actors.ArchiveResultActor.Model
:value: >
@@ -178,7 +200,7 @@ Bases: {py:obj}`actors.actor.ActorType`\[{py:obj}`core.models.ArchiveResult`\]
:canonical: archivebox.core.actors.ArchiveResultActor.MAX_CONCURRENT_ACTORS
:type: typing.ClassVar[int]
:value: >
6
1
```{autodoc2-docstring} archivebox.core.actors.ArchiveResultActor.MAX_CONCURRENT_ACTORS
```

6
apidocs/archivebox/archivebox.core.admin_archiveresults.md

@@ -201,7 +201,7 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} list_display
:canonical: archivebox.core.admin_archiveresults.ArchiveResultAdmin.list_display
:value: >
('start_ts', 'snapshot_info', 'tags_str', 'extractor', 'cmd_str', 'status', 'output_str')
('abid', 'created_by', 'created_at', 'snapshot_info', 'tags_str', 'status', 'extractor', 'cmd_str', ...
```{autodoc2-docstring} archivebox.core.admin_archiveresults.ArchiveResultAdmin.list_display
```
@@ -211,7 +211,7 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} sort_fields
:canonical: archivebox.core.admin_archiveresults.ArchiveResultAdmin.sort_fields
:value: >
('start_ts', 'extractor', 'status')
('abid', 'created_by', 'created_at', 'extractor', 'status')
```{autodoc2-docstring} archivebox.core.admin_archiveresults.ArchiveResultAdmin.sort_fields
```
@@ -241,7 +241,7 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} fields
:canonical: archivebox.core.admin_archiveresults.ArchiveResultAdmin.fields
:value: >
('snapshot', 'extractor', 'status', 'output', 'pwd', 'start_ts', 'end_ts', 'created_by', 'cmd_versio...
('snapshot', 'extractor', 'status', 'retry_at', 'start_ts', 'end_ts', 'created_by', 'pwd', 'cmd_vers...
```{autodoc2-docstring} archivebox.core.admin_archiveresults.ArchiveResultAdmin.fields
```

6
apidocs/archivebox/archivebox.core.admin_snapshots.md

@@ -70,7 +70,7 @@ Bases: {py:obj}`archivebox.search.admin.SearchResultsAdminMixin`, {py:obj}`archi
````{py:attribute} list_display
:canonical: archivebox.core.admin_snapshots.SnapshotAdmin.list_display
:value: >
('created_at', 'title_str', 'files', 'size', 'url_str')
('created_at', 'title_str', 'status', 'files', 'size', 'url_str')
```{autodoc2-docstring} archivebox.core.admin_snapshots.SnapshotAdmin.list_display
```
@@ -80,7 +80,7 @@ Bases: {py:obj}`archivebox.search.admin.SearchResultsAdminMixin`, {py:obj}`archi
````{py:attribute} sort_fields
:canonical: archivebox.core.admin_snapshots.SnapshotAdmin.sort_fields
:value: >
('title_str', 'url_str', 'created_at')
('title_str', 'url_str', 'created_at', 'status', 'crawl')
```{autodoc2-docstring} archivebox.core.admin_snapshots.SnapshotAdmin.sort_fields
```
@@ -120,7 +120,7 @@ Bases: {py:obj}`archivebox.search.admin.SearchResultsAdminMixin`, {py:obj}`archi
````{py:attribute} fields
:canonical: archivebox.core.admin_snapshots.SnapshotAdmin.fields
:value: >
('url', 'title', 'created_by', 'bookmarked_at')
('url', 'title', 'created_by', 'bookmarked_at', 'status', 'retry_at', 'crawl')
```{autodoc2-docstring} archivebox.core.admin_snapshots.SnapshotAdmin.fields
```

22
apidocs/archivebox/archivebox.core.md

@@ -60,8 +60,30 @@ archivebox.core.wsgi
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`__order__ <archivebox.core.__order__>`
- ```{autodoc2-docstring} archivebox.core.__order__
:summary:
```
````
### API
````{py:data} __order__
:canonical: archivebox.core.__order__
:value: >
100
```{autodoc2-docstring} archivebox.core.__order__
```
````
````{py:function} register_admin(admin_site)
:canonical: archivebox.core.register_admin

75
apidocs/archivebox/archivebox.core.models.md

@@ -35,6 +35,18 @@
-
````
### Functions
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`validate_timestamp <archivebox.core.models.validate_timestamp>`
- ```{autodoc2-docstring} archivebox.core.models.validate_timestamp
:summary:
```
````
### API
``````{py:class} Tag(*args: typing.Any, **kwargs: typing.Any)
@@ -321,6 +333,13 @@ Bases: {py:obj}`django.db.models.Model`
``````
````{py:function} validate_timestamp(value)
:canonical: archivebox.core.models.validate_timestamp
```{autodoc2-docstring} archivebox.core.models.validate_timestamp
```
````
`````{py:class} SnapshotManager
:canonical: archivebox.core.models.SnapshotManager
@@ -524,6 +543,16 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`actors.models.ModelWithSt
````
````{py:attribute} notes
:canonical: archivebox.core.models.Snapshot.notes
:value: >
'TextField(...)'
```{autodoc2-docstring} archivebox.core.models.Snapshot.notes
```
````
````{py:attribute} bookmarked_at
:canonical: archivebox.core.models.Snapshot.bookmarked_at
:value: >
@@ -598,7 +627,7 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`actors.models.ModelWithSt
````{py:attribute} keys
:canonical: archivebox.core.models.Snapshot.keys
:value: >
('url', 'timestamp', 'title', 'tags', 'downloaded_at')
('url', 'timestamp', 'title', 'tags', 'downloaded_at', 'created_at', 'status', 'retry_at', 'abid', '...
```{autodoc2-docstring} archivebox.core.models.Snapshot.keys
```
@@ -846,10 +875,10 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`actors.models.ModelWithSt
````
````{py:method} has_pending_archiveresults() -> bool
:canonical: archivebox.core.models.Snapshot.has_pending_archiveresults
````{py:method} pending_archiveresults() -> django.db.models.QuerySet[archivebox.core.models.ArchiveResult]
:canonical: archivebox.core.models.Snapshot.pending_archiveresults
```{autodoc2-docstring} archivebox.core.models.Snapshot.has_pending_archiveresults
```{autodoc2-docstring} archivebox.core.models.Snapshot.pending_archiveresults
```
````
@@ -1215,6 +1244,16 @@ Bases: {py:obj}`django.db.models.TextChoices`
````
````{py:attribute} notes
:canonical: archivebox.core.models.ArchiveResult.notes
:value: >
'TextField(...)'
```{autodoc2-docstring} archivebox.core.models.ArchiveResult.notes
```
````
````{py:attribute} objects
:canonical: archivebox.core.models.ArchiveResult.objects
:value: >
@@ -1225,6 +1264,16 @@ Bases: {py:obj}`django.db.models.TextChoices`
````
````{py:attribute} keys
:canonical: archivebox.core.models.ArchiveResult.keys
:value: >
('snapshot_id', 'extractor', 'cmd', 'pwd', 'cmd_version', 'output', 'start_ts', 'end_ts', 'created_a...
```{autodoc2-docstring} archivebox.core.models.ArchiveResult.keys
```
````
`````{py:class} Meta
:canonical: archivebox.core.models.ArchiveResult.Meta
@@ -1262,6 +1311,11 @@ Bases: {py:obj}`django_stubs_ext.db.models.TypedModelMeta`
````
````{py:method} save(*args, **kwargs)
:canonical: archivebox.core.models.ArchiveResult.save
````
````{py:method} snapshot_dir()
:canonical: archivebox.core.models.ArchiveResult.snapshot_dir
@@ -1300,13 +1354,14 @@ Bases: {py:obj}`django_stubs_ext.db.models.TypedModelMeta`
````{py:property} extractor_module
:canonical: archivebox.core.models.ArchiveResult.extractor_module
:type: typing.Any | None
```{autodoc2-docstring} archivebox.core.models.ArchiveResult.extractor_module
```
````
````{py:method} output_path() -> str
````{py:method} output_path() -> str | None
:canonical: archivebox.core.models.ArchiveResult.output_path
```{autodoc2-docstring} archivebox.core.models.ArchiveResult.output_path
@@ -1314,7 +1369,7 @@ Bases: {py:obj}`django_stubs_ext.db.models.TypedModelMeta`
````
````{py:method} embed_path() -> str
````{py:method} embed_path() -> str | None
:canonical: archivebox.core.models.ArchiveResult.embed_path
```{autodoc2-docstring} archivebox.core.models.ArchiveResult.embed_path
@@ -1346,4 +1401,12 @@ Bases: {py:obj}`django_stubs_ext.db.models.TypedModelMeta`
````
````{py:method} as_json(*args) -> dict
:canonical: archivebox.core.models.ArchiveResult.as_json
```{autodoc2-docstring} archivebox.core.models.ArchiveResult.as_json
```
````
``````

14
apidocs/archivebox/archivebox.core.settings.md

@@ -155,6 +155,10 @@
- ```{autodoc2-docstring} archivebox.core.settings.STORAGES
:summary:
```
* - {py:obj}`CHANNEL_LAYERS <archivebox.core.settings.CHANNEL_LAYERS>`
- ```{autodoc2-docstring} archivebox.core.settings.CHANNEL_LAYERS
:summary:
```
* - {py:obj}`SECRET_KEY <archivebox.core.settings.SECRET_KEY>`
- ```{autodoc2-docstring} archivebox.core.settings.SECRET_KEY
:summary:
@@ -661,6 +665,16 @@
````
````{py:data} CHANNEL_LAYERS
:canonical: archivebox.core.settings.CHANNEL_LAYERS
:value: >
None
```{autodoc2-docstring} archivebox.core.settings.CHANNEL_LAYERS
```
````
````{py:data} SECRET_KEY
:canonical: archivebox.core.settings.SECRET_KEY
:value: >

58
apidocs/archivebox/archivebox.core.statemachines.md

@@ -108,18 +108,34 @@ Bases: {py:obj}`statemachine.StateMachine`
````
````{py:method} on_started()
:canonical: archivebox.core.statemachines.SnapshotMachine.on_started
````{py:method} on_transition(event, state)
:canonical: archivebox.core.statemachines.SnapshotMachine.on_transition
```{autodoc2-docstring} archivebox.core.statemachines.SnapshotMachine.on_started
```{autodoc2-docstring} archivebox.core.statemachines.SnapshotMachine.on_transition
```
````
````{py:method} on_sealed()
:canonical: archivebox.core.statemachines.SnapshotMachine.on_sealed
````{py:method} enter_queued()
:canonical: archivebox.core.statemachines.SnapshotMachine.enter_queued
```{autodoc2-docstring} archivebox.core.statemachines.SnapshotMachine.on_sealed
```{autodoc2-docstring} archivebox.core.statemachines.SnapshotMachine.enter_queued
```
````
````{py:method} enter_started()
:canonical: archivebox.core.statemachines.SnapshotMachine.enter_started
```{autodoc2-docstring} archivebox.core.statemachines.SnapshotMachine.enter_started
```
````
````{py:method} enter_sealed()
:canonical: archivebox.core.statemachines.SnapshotMachine.enter_sealed
```{autodoc2-docstring} archivebox.core.statemachines.SnapshotMachine.enter_sealed
```
````
@@ -251,42 +267,42 @@ Bases: {py:obj}`statemachine.StateMachine`
````
````{py:method} on_started()
:canonical: archivebox.core.statemachines.ArchiveResultMachine.on_started
````{py:method} enter_queued()
:canonical: archivebox.core.statemachines.ArchiveResultMachine.enter_queued
```{autodoc2-docstring} archivebox.core.statemachines.ArchiveResultMachine.on_started
```{autodoc2-docstring} archivebox.core.statemachines.ArchiveResultMachine.enter_queued
```
````
````{py:method} on_backoff()
:canonical: archivebox.core.statemachines.ArchiveResultMachine.on_backoff
````{py:method} enter_started()
:canonical: archivebox.core.statemachines.ArchiveResultMachine.enter_started
```{autodoc2-docstring} archivebox.core.statemachines.ArchiveResultMachine.on_backoff
```{autodoc2-docstring} archivebox.core.statemachines.ArchiveResultMachine.enter_started
```
````
````{py:method} on_succeeded()
:canonical: archivebox.core.statemachines.ArchiveResultMachine.on_succeeded
````{py:method} enter_backoff()
:canonical: archivebox.core.statemachines.ArchiveResultMachine.enter_backoff
```{autodoc2-docstring} archivebox.core.statemachines.ArchiveResultMachine.on_succeeded
```{autodoc2-docstring} archivebox.core.statemachines.ArchiveResultMachine.enter_backoff
```
````
````{py:method} on_failed()
:canonical: archivebox.core.statemachines.ArchiveResultMachine.on_failed
````{py:method} enter_succeeded()
:canonical: archivebox.core.statemachines.ArchiveResultMachine.enter_succeeded
```{autodoc2-docstring} archivebox.core.statemachines.ArchiveResultMachine.on_failed
```{autodoc2-docstring} archivebox.core.statemachines.ArchiveResultMachine.enter_succeeded
```
````
````{py:method} after_transition(event: str, source: statemachine.State, target: statemachine.State)
:canonical: archivebox.core.statemachines.ArchiveResultMachine.after_transition
````{py:method} enter_failed()
:canonical: archivebox.core.statemachines.ArchiveResultMachine.enter_failed
```{autodoc2-docstring} archivebox.core.statemachines.ArchiveResultMachine.after_transition
```{autodoc2-docstring} archivebox.core.statemachines.ArchiveResultMachine.enter_failed
```
````

2
apidocs/archivebox/archivebox.crawls.actors.md

@@ -94,7 +94,7 @@ Bases: {py:obj}`actors.actor.ActorType`\[{py:obj}`crawls.models.Crawl`\]
:canonical: archivebox.crawls.actors.CrawlActor.MAX_CONCURRENT_ACTORS
:type: typing.ClassVar[int]
:value: >
3
1
```{autodoc2-docstring} archivebox.crawls.actors.CrawlActor.MAX_CONCURRENT_ACTORS
```

193
apidocs/archivebox/archivebox.crawls.admin.md

@@ -17,6 +17,8 @@
* - {py:obj}`CrawlAdmin <archivebox.crawls.admin.CrawlAdmin>`
-
* - {py:obj}`CrawlScheduleAdmin <archivebox.crawls.admin.CrawlScheduleAdmin>`
-
````
### Functions
@@ -41,7 +43,7 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} list_display
:canonical: archivebox.crawls.admin.CrawlAdmin.list_display
:value: >
('abid', 'created_at', 'created_by', 'depth', 'parser', 'urls')
('abid', 'created_at', 'created_by', 'max_depth', 'label', 'notes', 'seed_str', 'schedule_str', 'sta...
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.list_display
```
@@ -51,7 +53,7 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} sort_fields
:canonical: archivebox.crawls.admin.CrawlAdmin.sort_fields
:value: >
('abid', 'created_at', 'created_by', 'depth', 'parser', 'urls')
('abid', 'created_at', 'created_by', 'max_depth', 'label', 'notes', 'seed_str', 'schedule_str', 'sta...
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.sort_fields
```
@@ -61,7 +63,7 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} search_fields
:canonical: archivebox.crawls.admin.CrawlAdmin.search_fields
:value: >
('abid', 'created_by__username', 'depth', 'parser', 'urls')
('abid', 'created_by__username', 'max_depth', 'label', 'notes', 'seed_id', 'seed__abid', 'schedule_i...
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.search_fields
```
@@ -71,7 +73,7 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} readonly_fields
:canonical: archivebox.crawls.admin.CrawlAdmin.readonly_fields
:value: >
('created_at', 'modified_at', 'abid_info')
('created_at', 'modified_at', 'abid_info', 'snapshots', 'seed_contents')
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.readonly_fields
```
@@ -81,7 +83,7 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} fields
:canonical: archivebox.crawls.admin.CrawlAdmin.fields
:value: >
('urls', 'depth', 'parser', 'created_by')
('label', 'notes', 'status', 'retry_at', 'max_depth', 'seed', 'schedule', 'created_by')
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.fields
```
@@ -91,7 +93,7 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} list_filter
:canonical: archivebox.crawls.admin.CrawlAdmin.list_filter
:value: >
('depth', 'parser', 'created_by')
('max_depth', 'seed', 'schedule', 'created_by', 'status', 'retry_at')
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.list_filter
```
@@ -101,7 +103,7 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} ordering
:canonical: archivebox.crawls.admin.CrawlAdmin.ordering
:value: >
['-created_at']
['-created_at', '-retry_at']
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.ordering
```
@@ -128,6 +130,183 @@ Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````
````{py:method} num_snapshots(obj)
:canonical: archivebox.crawls.admin.CrawlAdmin.num_snapshots
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.num_snapshots
```
````
````{py:method} snapshots(obj)
:canonical: archivebox.crawls.admin.CrawlAdmin.snapshots
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.snapshots
```
````
````{py:method} schedule_str(obj)
:canonical: archivebox.crawls.admin.CrawlAdmin.schedule_str
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.schedule_str
```
````
````{py:method} seed_str(obj)
:canonical: archivebox.crawls.admin.CrawlAdmin.seed_str
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.seed_str
```
````
````{py:method} seed_contents(obj)
:canonical: archivebox.crawls.admin.CrawlAdmin.seed_contents
```{autodoc2-docstring} archivebox.crawls.admin.CrawlAdmin.seed_contents
```
````
`````
`````{py:class} CrawlScheduleAdmin(model, admin_site)
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin
Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} list_display
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.list_display
:value: >
('abid', 'created_at', 'created_by', 'label', 'notes', 'template_str', 'crawls', 'num_crawls', 'num_...
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.list_display
```
````
````{py:attribute} sort_fields
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.sort_fields
:value: >
('abid', 'created_at', 'created_by', 'label', 'notes', 'template_str')
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.sort_fields
```
````
````{py:attribute} search_fields
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.search_fields
:value: >
('abid', 'created_by__username', 'label', 'notes', 'schedule_id', 'schedule__abid', 'template_id', '...
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.search_fields
```
````
````{py:attribute} readonly_fields
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.readonly_fields
:value: >
('created_at', 'modified_at', 'abid_info', 'crawls', 'snapshots')
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.readonly_fields
```
````
````{py:attribute} fields
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.fields
:value: >
('label', 'notes', 'schedule', 'template', 'created_by')
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.fields
```
````
````{py:attribute} list_filter
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.list_filter
:value: >
('created_by',)
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.list_filter
```
````
````{py:attribute} ordering
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.ordering
:value: >
['-created_at']
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.ordering
```
````
````{py:attribute} list_per_page
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.list_per_page
:value: >
100
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.list_per_page
```
````
````{py:attribute} actions
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.actions
:value: >
['delete_selected']
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.actions
```
````
````{py:method} template_str(obj)
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.template_str
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.template_str
```
````
````{py:method} num_crawls(obj)
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.num_crawls
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.num_crawls
```
````
````{py:method} num_snapshots(obj)
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.num_snapshots
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.num_snapshots
```
````
````{py:method} crawls(obj)
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.crawls
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.crawls
```
````
````{py:method} snapshots(obj)
:canonical: archivebox.crawls.admin.CrawlScheduleAdmin.snapshots
```{autodoc2-docstring} archivebox.crawls.admin.CrawlScheduleAdmin.snapshots
```
````
`````
````{py:function} register_admin(admin_site)

45
apidocs/archivebox/archivebox.crawls.md

@@ -20,3 +20,48 @@ archivebox.crawls.statemachines
archivebox.crawls.actors
archivebox.crawls.views
```
## Package Contents
### Functions
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`register_admin <archivebox.crawls.register_admin>`
- ```{autodoc2-docstring} archivebox.crawls.register_admin
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`__order__ <archivebox.crawls.__order__>`
- ```{autodoc2-docstring} archivebox.crawls.__order__
:summary:
```
````
### API
````{py:data} __order__
:canonical: archivebox.crawls.__order__
:value: >
100
```{autodoc2-docstring} archivebox.crawls.__order__
```
````
````{py:function} register_admin(admin_site)
:canonical: archivebox.crawls.register_admin
```{autodoc2-docstring} archivebox.crawls.register_admin
```
````

177
apidocs/archivebox/archivebox.crawls.models.md

@@ -31,7 +31,7 @@
### API
`````{py:class} CrawlSchedule(*args: typing.Any, **kwargs: typing.Any)
``````{py:class} CrawlSchedule(*args: typing.Any, **kwargs: typing.Any)
:canonical: archivebox.crawls.models.CrawlSchedule
Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWithHealthStats`
@@ -48,7 +48,7 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWi
````{py:attribute} abid_prefix
:canonical: archivebox.crawls.models.CrawlSchedule.abid_prefix
:value: >
'sch_'
'cws_'
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.abid_prefix
```
@@ -95,6 +95,26 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWi
````
````{py:attribute} id
:canonical: archivebox.crawls.models.CrawlSchedule.id
:value: >
'UUIDField(...)'
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.id
```
````
````{py:attribute} abid
:canonical: archivebox.crawls.models.CrawlSchedule.abid
:value: >
'ABIDField(...)'
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.abid
```
````
````{py:attribute} schedule
:canonical: archivebox.crawls.models.CrawlSchedule.schedule
:value: >
@@ -105,12 +125,43 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWi
````
````{py:attribute} is_enabled
:canonical: archivebox.crawls.models.CrawlSchedule.is_enabled
````{py:attribute} label
:canonical: archivebox.crawls.models.CrawlSchedule.label
:value: >
'BooleanField(...)'
'CharField(...)'
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.is_enabled
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.label
```
````
````{py:attribute} notes
:canonical: archivebox.crawls.models.CrawlSchedule.notes
:value: >
'TextField(...)'
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.notes
```
````
````{py:attribute} template
:canonical: archivebox.crawls.models.CrawlSchedule.template
:type: Crawl
:value: >
'ForeignKey(...)'
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.template
```
````
````{py:attribute} created_by
:canonical: archivebox.crawls.models.CrawlSchedule.created_by
:value: >
'ForeignKey(...)'
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.created_by
```
````
@@ -135,12 +186,12 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWi
````
````{py:attribute} created_by
:canonical: archivebox.crawls.models.CrawlSchedule.created_by
````{py:attribute} is_enabled
:canonical: archivebox.crawls.models.CrawlSchedule.is_enabled
:value: >
'ForeignKey(...)'
'BooleanField(...)'
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.created_by
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.is_enabled
```
````
@@ -156,16 +207,66 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWi
````
````{py:property} template
:canonical: archivebox.crawls.models.CrawlSchedule.template
`````{py:class} Meta
:canonical: archivebox.crawls.models.CrawlSchedule.Meta
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.template
Bases: {py:obj}`django_stubs_ext.db.models.TypedModelMeta`
````{py:attribute} verbose_name
:canonical: archivebox.crawls.models.CrawlSchedule.Meta.verbose_name
:value: >
'Scheduled Crawl'
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.Meta.verbose_name
```
````
````{py:attribute} verbose_name_plural
:canonical: archivebox.crawls.models.CrawlSchedule.Meta.verbose_name_plural
:value: >
'Scheduled Crawls'
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.Meta.verbose_name_plural
```
````
`````
````{py:method} __str__() -> str
:canonical: archivebox.crawls.models.CrawlSchedule.__str__
````
````{py:property} api_url
:canonical: archivebox.crawls.models.CrawlSchedule.api_url
:type: str
````
````{py:property} api_docs_url
:canonical: archivebox.crawls.models.CrawlSchedule.api_docs_url
:type: str
````
````{py:method} save(*args, **kwargs)
:canonical: archivebox.crawls.models.CrawlSchedule.save
````
````{py:property} snapshot_set
:canonical: archivebox.crawls.models.CrawlSchedule.snapshot_set
:type: django.db.models.QuerySet[core.models.Snapshot]
```{autodoc2-docstring} archivebox.crawls.models.CrawlSchedule.snapshot_set
```
````
``````
``````{py:class} Crawl(*args: typing.Any, **kwargs: typing.Any)
:canonical: archivebox.crawls.models.Crawl
@@ -183,7 +284,7 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWi
````{py:attribute} abid_prefix
:canonical: archivebox.crawls.models.Crawl.abid_prefix
:value: >
'crl_'
'cwl_'
```{autodoc2-docstring} archivebox.crawls.models.Crawl.abid_prefix
```
@@ -370,6 +471,26 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWi
````
````{py:attribute} label
:canonical: archivebox.crawls.models.Crawl.label
:value: >
'CharField(...)'
```{autodoc2-docstring} archivebox.crawls.models.Crawl.label
```
````
````{py:attribute} notes
:canonical: archivebox.crawls.models.Crawl.notes
:value: >
'TextField(...)'
```{autodoc2-docstring} archivebox.crawls.models.Crawl.notes
```
````
````{py:attribute} max_depth
:canonical: archivebox.crawls.models.Crawl.max_depth
:value: >
@@ -458,6 +579,20 @@ Bases: {py:obj}`django_stubs_ext.db.models.TypedModelMeta`
`````
````{py:method} __str__()
:canonical: archivebox.crawls.models.Crawl.__str__
````
````{py:method} from_seed(seed: seeds.models.Seed, max_depth: int = 0, persona: str = 'Default', tags_str: str = '', config: dict | None = None, created_by: int | None = None)
:canonical: archivebox.crawls.models.Crawl.from_seed
:classmethod:
```{autodoc2-docstring} archivebox.crawls.models.Crawl.from_seed
```
````
````{py:property} template
:canonical: archivebox.crawls.models.Crawl.template
@@ -478,10 +613,18 @@ Bases: {py:obj}`django_stubs_ext.db.models.TypedModelMeta`
````
````{py:method} has_pending_archiveresults() -> bool
:canonical: archivebox.crawls.models.Crawl.has_pending_archiveresults
````{py:method} pending_snapshots() -> django.db.models.QuerySet[core.models.Snapshot]
:canonical: archivebox.crawls.models.Crawl.pending_snapshots
```{autodoc2-docstring} archivebox.crawls.models.Crawl.has_pending_archiveresults
```{autodoc2-docstring} archivebox.crawls.models.Crawl.pending_snapshots
```
````
````{py:method} pending_archiveresults() -> django.db.models.QuerySet[core.models.ArchiveResult]
:canonical: archivebox.crawls.models.Crawl.pending_archiveresults
```{autodoc2-docstring} archivebox.crawls.models.Crawl.pending_archiveresults
```
````

12
apidocs/archivebox/archivebox.crawls.statemachines.md

@@ -104,18 +104,18 @@ Bases: {py:obj}`statemachine.StateMachine`
````
````{py:method} on_started()
:canonical: archivebox.crawls.statemachines.CrawlMachine.on_started
````{py:method} enter_started()
:canonical: archivebox.crawls.statemachines.CrawlMachine.enter_started
```{autodoc2-docstring} archivebox.crawls.statemachines.CrawlMachine.on_started
```{autodoc2-docstring} archivebox.crawls.statemachines.CrawlMachine.enter_started
```
````
````{py:method} on_sealed()
:canonical: archivebox.crawls.statemachines.CrawlMachine.on_sealed
````{py:method} enter_sealed()
:canonical: archivebox.crawls.statemachines.CrawlMachine.enter_sealed
```{autodoc2-docstring} archivebox.crawls.statemachines.CrawlMachine.on_sealed
```{autodoc2-docstring} archivebox.crawls.statemachines.CrawlMachine.enter_sealed
```
````

4
apidocs/archivebox/archivebox.index.json.md

@@ -55,7 +55,7 @@
### API
````{py:function} generate_json_index_from_links(links: typing.List[archivebox.index.schema.Link], with_headers: bool)
````{py:function} generate_json_index_from_links(links: typing.List[archivebox.index.schema.Link], with_headers: bool = False)
:canonical: archivebox.index.json.generate_json_index_from_links
```{autodoc2-docstring} archivebox.index.json.generate_json_index_from_links
@@ -111,7 +111,7 @@ Bases: {py:obj}`json.JSONEncoder`
`````
````{py:function} to_json(obj: typing.Any, indent: typing.Optional[int] = 4, sort_keys: bool = True, cls=ExtendedEncoder) -> str
````{py:function} to_json(obj: typing.Any, indent: typing.Optional[int] = 4, sort_keys: bool = True, cls=ExtendedEncoder, default=None) -> str
:canonical: archivebox.index.json.to_json
```{autodoc2-docstring} archivebox.index.json.to_json

10
apidocs/archivebox/archivebox.machine.models.md

@@ -700,7 +700,7 @@ Bases: {py:obj}`django.db.models.Manager`
```{autodoc2-docstring} archivebox.machine.models.InstalledBinaryManager
```
````{py:method} get_from_db_or_cache(binary: pydantic_pkgr.Binary) -> archivebox.machine.models.InstalledBinary
````{py:method} get_from_db_or_cache(binary: abx_pkg.Binary) -> archivebox.machine.models.InstalledBinary
:canonical: archivebox.machine.models.InstalledBinaryManager.get_from_db_or_cache
```{autodoc2-docstring} archivebox.machine.models.InstalledBinaryManager.get_from_db_or_cache
@@ -934,7 +934,7 @@ Bases: {py:obj}`archivebox.abid_utils.models.ABIDModel`, {py:obj}`archivebox.abi
````
````{py:method} BINARY() -> pydantic_pkgr.Binary
````{py:method} BINARY() -> abx_pkg.Binary
:canonical: archivebox.machine.models.InstalledBinary.BINARY
```{autodoc2-docstring} archivebox.machine.models.InstalledBinary.BINARY
@@ -942,7 +942,7 @@ Bases: {py:obj}`archivebox.abid_utils.models.ABIDModel`, {py:obj}`archivebox.abi
````
````{py:method} BINPROVIDER() -> pydantic_pkgr.BinProvider
````{py:method} BINPROVIDER() -> abx_pkg.BinProvider
:canonical: archivebox.machine.models.InstalledBinary.BINPROVIDER
```{autodoc2-docstring} archivebox.machine.models.InstalledBinary.BINPROVIDER
@@ -950,7 +950,7 @@ Bases: {py:obj}`archivebox.abid_utils.models.ABIDModel`, {py:obj}`archivebox.abi
````
````{py:method} load_from_db() -> pydantic_pkgr.Binary
````{py:method} load_from_db() -> abx_pkg.Binary
:canonical: archivebox.machine.models.InstalledBinary.load_from_db
```{autodoc2-docstring} archivebox.machine.models.InstalledBinary.load_from_db
@@ -958,7 +958,7 @@ Bases: {py:obj}`archivebox.abid_utils.models.ABIDModel`, {py:obj}`archivebox.abi
````
````{py:method} load_fresh() -> pydantic_pkgr.Binary
````{py:method} load_fresh() -> abx_pkg.Binary
:canonical: archivebox.machine.models.InstalledBinary.load_fresh
```{autodoc2-docstring} archivebox.machine.models.InstalledBinary.load_fresh

2
apidocs/archivebox/archivebox.main.md

@@ -166,7 +166,7 @@
```
````
````{py:function} list_all(filter_patterns_str: typing.Optional[str] = None, filter_patterns: typing.Optional[typing.List[str]] = None, filter_type: str = 'exact', status: typing.Optional[str] = None, after: typing.Optional[float] = None, before: typing.Optional[float] = None, sort: typing.Optional[str] = None, csv: typing.Optional[str] = None, json: bool = False, html: bool = False, with_headers: bool = False, out_dir: pathlib.Path = DATA_DIR) -> typing.Iterable[archivebox.index.schema.Link]
````{py:function} list_all(filter_patterns_str: typing.Optional[str] = None, filter_patterns: typing.Optional[typing.List[str]] = None, filter_type: str = 'exact', status: typing.Optional[str] = None, after: typing.Optional[float] = None, before: typing.Optional[float] = None, sort: typing.Optional[str] = None, csv: typing.Optional[str] = None, json: bool = False, html: bool = False, with_headers: bool = False, out_dir: pathlib.Path = DATA_DIR)
:canonical: archivebox.main.list_all
```{autodoc2-docstring} archivebox.main.list_all

28
apidocs/archivebox/archivebox.queues.supervisor_util.md

@@ -107,6 +107,14 @@
- ```{autodoc2-docstring} archivebox.queues.supervisor_util.COMMAND_WORKER
:summary:
```
* - {py:obj}`ORCHESTRATOR_WORKER <archivebox.queues.supervisor_util.ORCHESTRATOR_WORKER>`
- ```{autodoc2-docstring} archivebox.queues.supervisor_util.ORCHESTRATOR_WORKER
:summary:
```
* - {py:obj}`SERVER_WORKER <archivebox.queues.supervisor_util.SERVER_WORKER>`
- ```{autodoc2-docstring} archivebox.queues.supervisor_util.SERVER_WORKER
:summary:
```
````
### API
@@ -171,6 +179,26 @@
````
````{py:data} ORCHESTRATOR_WORKER
:canonical: archivebox.queues.supervisor_util.ORCHESTRATOR_WORKER
:value: >
None
```{autodoc2-docstring} archivebox.queues.supervisor_util.ORCHESTRATOR_WORKER
```
````
````{py:data} SERVER_WORKER
:canonical: archivebox.queues.supervisor_util.SERVER_WORKER
:value: >
None
```{autodoc2-docstring} archivebox.queues.supervisor_util.SERVER_WORKER
```
````
````{py:function} get_sock_file()
:canonical: archivebox.queues.supervisor_util.get_sock_file

178
apidocs/archivebox/archivebox.seeds.admin.md

@@ -6,3 +6,181 @@
```{autodoc2-docstring} archivebox.seeds.admin
:allowtitles:
```
## Module Contents
### Classes
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`SeedAdmin <archivebox.seeds.admin.SeedAdmin>`
-
````
### Functions
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`register_admin <archivebox.seeds.admin.register_admin>`
- ```{autodoc2-docstring} archivebox.seeds.admin.register_admin
:summary:
```
````
### API
`````{py:class} SeedAdmin(model, admin_site)
:canonical: archivebox.seeds.admin.SeedAdmin
Bases: {py:obj}`abid_utils.admin.ABIDModelAdmin`
````{py:attribute} list_display
:canonical: archivebox.seeds.admin.SeedAdmin.list_display
:value: >
('abid', 'created_at', 'created_by', 'label', 'notes', 'uri', 'extractor', 'tags_str', 'crawls', 'nu...
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.list_display
```
````
````{py:attribute} sort_fields
:canonical: archivebox.seeds.admin.SeedAdmin.sort_fields
:value: >
('abid', 'created_at', 'created_by', 'label', 'notes', 'uri', 'extractor', 'tags_str')
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.sort_fields
```
````
````{py:attribute} search_fields
:canonical: archivebox.seeds.admin.SeedAdmin.search_fields
:value: >
('abid', 'created_by__username', 'label', 'notes', 'uri', 'extractor', 'tags_str')
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.search_fields
```
````
````{py:attribute} readonly_fields
:canonical: archivebox.seeds.admin.SeedAdmin.readonly_fields
:value: >
('created_at', 'modified_at', 'abid_info', 'scheduled_crawls', 'crawls', 'snapshots', 'contents')
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.readonly_fields
```
````
````{py:attribute} fields
:canonical: archivebox.seeds.admin.SeedAdmin.fields
:value: >
('label', 'notes', 'uri', 'extractor', 'tags_str', 'config', 'created_by')
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.fields
```
````
````{py:attribute} list_filter
:canonical: archivebox.seeds.admin.SeedAdmin.list_filter
:value: >
('extractor', 'created_by')
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.list_filter
```
````
````{py:attribute} ordering
:canonical: archivebox.seeds.admin.SeedAdmin.ordering
:value: >
['-created_at']
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.ordering
```
````
````{py:attribute} list_per_page
:canonical: archivebox.seeds.admin.SeedAdmin.list_per_page
:value: >
100
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.list_per_page
```
````
````{py:attribute} actions
:canonical: archivebox.seeds.admin.SeedAdmin.actions
:value: >
['delete_selected']
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.actions
```
````
````{py:method} num_crawls(obj)
:canonical: archivebox.seeds.admin.SeedAdmin.num_crawls
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.num_crawls
```
````
````{py:method} num_snapshots(obj)
:canonical: archivebox.seeds.admin.SeedAdmin.num_snapshots
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.num_snapshots
```
````
````{py:method} scheduled_crawls(obj)
:canonical: archivebox.seeds.admin.SeedAdmin.scheduled_crawls
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.scheduled_crawls
```
````
````{py:method} crawls(obj)
:canonical: archivebox.seeds.admin.SeedAdmin.crawls
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.crawls
```
````
````{py:method} snapshots(obj)
:canonical: archivebox.seeds.admin.SeedAdmin.snapshots
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.snapshots
```
````
````{py:method} contents(obj)
:canonical: archivebox.seeds.admin.SeedAdmin.contents
```{autodoc2-docstring} archivebox.seeds.admin.SeedAdmin.contents
```
````
`````
````{py:function} register_admin(admin_site)
:canonical: archivebox.seeds.admin.register_admin
```{autodoc2-docstring} archivebox.seeds.admin.register_admin
```
````

45
apidocs/archivebox/archivebox.seeds.md

@@ -18,3 +18,48 @@ archivebox.seeds.apps
archivebox.seeds.admin
archivebox.seeds.views
```
## Package Contents
### Functions
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`register_admin <archivebox.seeds.register_admin>`
- ```{autodoc2-docstring} archivebox.seeds.register_admin
:summary:
```
````
### Data
````{list-table}
:class: autosummary longtable
:align: left
* - {py:obj}`__order__ <archivebox.seeds.__order__>`
- ```{autodoc2-docstring} archivebox.seeds.__order__
:summary:
```
````
### API
````{py:data} __order__
:canonical: archivebox.seeds.__order__
:value: >
100
```{autodoc2-docstring} archivebox.seeds.__order__
```
````
````{py:function} register_admin(admin_site)
:canonical: archivebox.seeds.register_admin
```{autodoc2-docstring} archivebox.seeds.register_admin
```
````

76
apidocs/archivebox/archivebox.seeds.models.md

@@ -127,6 +127,26 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWi
````
````{py:attribute} label
:canonical: archivebox.seeds.models.Seed.label
:value: >
'CharField(...)'
```{autodoc2-docstring} archivebox.seeds.models.Seed.label
```
````
````{py:attribute} notes
:canonical: archivebox.seeds.models.Seed.notes
:value: >
'TextField(...)'
```{autodoc2-docstring} archivebox.seeds.models.Seed.notes
```
````
````{py:attribute} extractor
:canonical: archivebox.seeds.models.Seed.extractor
:value: >
@@ -187,10 +207,13 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWi
````
````{py:property} source_type
:canonical: archivebox.seeds.models.Seed.source_type
````{py:attribute} crawl_set
:canonical: archivebox.seeds.models.Seed.crawl_set
:type: django.db.models.Manager[crawls.models.Crawl]
:value: >
None
```{autodoc2-docstring} archivebox.seeds.models.Seed.source_type
```{autodoc2-docstring} archivebox.seeds.models.Seed.crawl_set
```
````
@@ -233,4 +256,51 @@ Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWi
`````
````{py:method} from_file(source_file: pathlib.Path, label: str = '', parser: str = 'auto', tag: str = '', created_by: int | None = None, config: dict | None = None)
:canonical: archivebox.seeds.models.Seed.from_file
:classmethod:
```{autodoc2-docstring} archivebox.seeds.models.Seed.from_file
```
````
````{py:property} source_type
:canonical: archivebox.seeds.models.Seed.source_type
```{autodoc2-docstring} archivebox.seeds.models.Seed.source_type
```
````
````{py:property} api_url
:canonical: archivebox.seeds.models.Seed.api_url
:type: str
````
````{py:property} api_docs_url
:canonical: archivebox.seeds.models.Seed.api_docs_url
:type: str
````
````{py:property} scheduled_crawl_set
:canonical: archivebox.seeds.models.Seed.scheduled_crawl_set
:type: django.db.models.QuerySet[crawls.models.CrawlSchedule]
```{autodoc2-docstring} archivebox.seeds.models.Seed.scheduled_crawl_set
```
````
````{py:property} snapshot_set
:canonical: archivebox.seeds.models.Seed.snapshot_set
:type: django.db.models.QuerySet[core.models.Snapshot]
```{autodoc2-docstring} archivebox.seeds.models.Seed.snapshot_set
```
````
``````

2
apidocs/index.rst

@@ -14,6 +14,7 @@ This page contains auto-generated API reference documentation [#f1]_.
abx_spec_django/abx_spec_django
abx_plugin_default_binproviders/abx_plugin_default_binproviders
abx_plugin_sonic_search/abx_plugin_sonic_search
abx_spec_abx_pkg/abx_spec_abx_pkg
abx_plugin_chrome/abx_plugin_chrome
abx_spec_searchbackend/abx_spec_searchbackend
abx_plugin_singlefile/abx_plugin_singlefile
@@ -21,7 +22,6 @@ This page contains auto-generated API reference documentation [#f1]_.
abx_plugin_ripgrep_search/abx_plugin_ripgrep_search
abx_plugin_readwise/abx_plugin_readwise
abx_spec_extractor/abx_spec_extractor
abx_spec_pydantic_pkgr/abx_spec_pydantic_pkgr
abx_plugin_pip/abx_plugin_pip
abx_plugin_htmltotext/abx_plugin_htmltotext
abx_plugin_ytdlp/abx_plugin_ytdlp