The_Great_Archive/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-09-14 11:06:13 +05:00
Code Issues Actions Packages Projects Releases Wiki Activity
dev
ArchiveBox/docs/apidocs/archivebox/archivebox.md

3.3 KiB
Raw Permalink Blame History

{py:mod}archivebox

:allowtitles:

Subpackages

:titlesonly:
:maxdepth: 3

archivebox.misc
archivebox.core
archivebox.config
archivebox.plugins
archivebox.ldap
archivebox.mcp
archivebox.crawls
archivebox.cli
archivebox.search
archivebox.personas
archivebox.progressmonitor
archivebox.machine
archivebox.api
archivebox.workers
archivebox.base_models
archivebox.services

Submodules

:titlesonly:
:maxdepth: 1

archivebox.uuid_compat
archivebox.manage
archivebox.__main__

Package Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`_ReconfigurableStream <archivebox._ReconfigurableStream>`
  -

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`__getattr__ <archivebox.__getattr__>`
  - ```{autodoc2-docstring} archivebox.__getattr__
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`ASCII_LOGO <archivebox.ASCII_LOGO>`
  - ```{autodoc2-docstring} archivebox.ASCII_LOGO
    :summary:
    ```
* - {py:obj}`PACKAGE_DIR <archivebox.PACKAGE_DIR>`
  - ```{autodoc2-docstring} archivebox.PACKAGE_DIR
    :summary:
    ```
* - {py:obj}`__version__ <archivebox.__version__>`
  - ```{autodoc2-docstring} archivebox.__version__
    :summary:
    ```
* - {py:obj}`__author__ <archivebox.__author__>`
  - ```{autodoc2-docstring} archivebox.__author__
    :summary:
    ```
* - {py:obj}`__license__ <archivebox.__license__>`
  - ```{autodoc2-docstring} archivebox.__license__
    :summary:
    ```
* - {py:obj}`__all__ <archivebox.__all__>`
  - ```{autodoc2-docstring} archivebox.__all__
    :summary:
    ```
* - {py:obj}`ASCII_ICON <archivebox.ASCII_ICON>`
  - ```{autodoc2-docstring} archivebox.ASCII_ICON
    :summary:
    ```

API

:canonical: archivebox._ReconfigurableStream

Bases: {py:obj}`typing.Protocol`

````{py:method} reconfigure(*, line_buffering: bool) -> object
:canonical: archivebox._ReconfigurableStream.reconfigure

```{autodoc2-docstring} archivebox._ReconfigurableStream.reconfigure
```

````


:canonical: archivebox.ASCII_LOGO
:value: <Multiline-String>

```{autodoc2-docstring} archivebox.ASCII_LOGO
```


:canonical: archivebox.PACKAGE_DIR
:value: >
   None

```{autodoc2-docstring} archivebox.PACKAGE_DIR
```


:canonical: archivebox.__version__
:value: >
   None

```{autodoc2-docstring} archivebox.__version__
```


:canonical: archivebox.__author__
:value: >
   'ArchiveBox'

```{autodoc2-docstring} archivebox.__author__
```


:canonical: archivebox.__license__
:value: >
   'MIT'

```{autodoc2-docstring} archivebox.__license__
```


:canonical: archivebox.__getattr__

```{autodoc2-docstring} archivebox.__getattr__
```

:canonical: archivebox.__all__
:value: >
   ('ASCII_LOGO', 'ASCII_ICON', 'PACKAGE_DIR', 'DATA_DIR', 'CONSTANTS', 'VERSION', 'BUILTIN_PLUGINS_DIR...

```{autodoc2-docstring} archivebox.__all__
```


:canonical: archivebox.ASCII_ICON
:value: <Multiline-String>

```{autodoc2-docstring} archivebox.ASCII_ICON
```