ArchiveBox/docs/apidocs/archivebox/archivebox.cli.archivebox_snapshot.md

{py:mod}archivebox.cli.archivebox_snapshot

:allowtitles:

Module Contents

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`iter_snapshot_json <archivebox.cli.archivebox_snapshot.iter_snapshot_json>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.iter_snapshot_json
    :summary:
    ```
* - {py:obj}`create_snapshots <archivebox.cli.archivebox_snapshot.create_snapshots>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.create_snapshots
    :summary:
    ```
* - {py:obj}`snapshot_filter_options <archivebox.cli.archivebox_snapshot.snapshot_filter_options>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.snapshot_filter_options
    :summary:
    ```
* - {py:obj}`snapshot_output_options <archivebox.cli.archivebox_snapshot.snapshot_output_options>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.snapshot_output_options
    :summary:
    ```
* - {py:obj}`build_snapshot_queryset <archivebox.cli.archivebox_snapshot.build_snapshot_queryset>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.build_snapshot_queryset
    :summary:
    ```
* - {py:obj}`list_snapshots <archivebox.cli.archivebox_snapshot.list_snapshots>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.list_snapshots
    :summary:
    ```
* - {py:obj}`update_snapshots <archivebox.cli.archivebox_snapshot.update_snapshots>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.update_snapshots
    :summary:
    ```
* - {py:obj}`delete_snapshots <archivebox.cli.archivebox_snapshot.delete_snapshots>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.delete_snapshots
    :summary:
    ```
* - {py:obj}`main <archivebox.cli.archivebox_snapshot.main>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.main
    :summary:
    ```
* - {py:obj}`create_cmd <archivebox.cli.archivebox_snapshot.create_cmd>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.create_cmd
    :summary:
    ```
* - {py:obj}`list_cmd <archivebox.cli.archivebox_snapshot.list_cmd>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.list_cmd
    :summary:
    ```
* - {py:obj}`update_cmd <archivebox.cli.archivebox_snapshot.update_cmd>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.update_cmd
    :summary:
    ```
* - {py:obj}`delete_cmd <archivebox.cli.archivebox_snapshot.delete_cmd>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.delete_cmd
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`__command__ <archivebox.cli.archivebox_snapshot.__command__>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.__command__
    :summary:
    ```
* - {py:obj}`SNAPSHOT_FILTER_TYPE_CHOICES <archivebox.cli.archivebox_snapshot.SNAPSHOT_FILTER_TYPE_CHOICES>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.SNAPSHOT_FILTER_TYPE_CHOICES
    :summary:
    ```
* - {py:obj}`SNAPSHOT_LIST_CHUNK_SIZE <archivebox.cli.archivebox_snapshot.SNAPSHOT_LIST_CHUNK_SIZE>`
  - ```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.SNAPSHOT_LIST_CHUNK_SIZE
    :summary:
    ```

API

:canonical: archivebox.cli.archivebox_snapshot.__command__
:value: >
   'archivebox snapshot'

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.__command__
```

:canonical: archivebox.cli.archivebox_snapshot.SNAPSHOT_FILTER_TYPE_CHOICES
:value: >
   ('exact', 'substring', 'regex', 'domain', 'tag', 'timestamp')

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.SNAPSHOT_FILTER_TYPE_CHOICES
```

:canonical: archivebox.cli.archivebox_snapshot.SNAPSHOT_LIST_CHUNK_SIZE
:value: >
   5000

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.SNAPSHOT_LIST_CHUNK_SIZE
```

:canonical: archivebox.cli.archivebox_snapshot.iter_snapshot_json

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.iter_snapshot_json
```

:canonical: archivebox.cli.archivebox_snapshot.create_snapshots

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.create_snapshots
```

:canonical: archivebox.cli.archivebox_snapshot.snapshot_filter_options

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.snapshot_filter_options
```

:canonical: archivebox.cli.archivebox_snapshot.snapshot_output_options

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.snapshot_output_options
```

:canonical: archivebox.cli.archivebox_snapshot.build_snapshot_queryset

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.build_snapshot_queryset
```

:canonical: archivebox.cli.archivebox_snapshot.list_snapshots

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.list_snapshots
```

:canonical: archivebox.cli.archivebox_snapshot.update_snapshots

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.update_snapshots
```

:canonical: archivebox.cli.archivebox_snapshot.delete_snapshots

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.delete_snapshots
```

:canonical: archivebox.cli.archivebox_snapshot.main

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.main
```

:canonical: archivebox.cli.archivebox_snapshot.create_cmd

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.create_cmd
```

:canonical: archivebox.cli.archivebox_snapshot.list_cmd

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.list_cmd
```

:canonical: archivebox.cli.archivebox_snapshot.update_cmd

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.update_cmd
```

:canonical: archivebox.cli.archivebox_snapshot.delete_cmd

```{autodoc2-docstring} archivebox.cli.archivebox_snapshot.delete_cmd
```