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
5ec6478b12
ArchiveBox/docs/apidocs/archivebox/archivebox.core.permissions.md
Nick Sweeting f4932430db
Some checks are pending
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Details
Build Debian package / build (amd64) (push) Waiting to run
Details
Build Debian package / build (arm64) (push) Waiting to run
Details
Build Debian package / test (amd64, ubuntu-24.04) (push) Blocked by required conditions
Details
Build Debian package / test (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
Details
Build Debian package / release (push) Blocked by required conditions
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Waiting to run
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Waiting to run
Details
Build Docker image / publish multiarch tags (push) Blocked by required conditions
Details
Run linters / lint (push) Waiting to run
Details
Build Pip package / build (push) Waiting to run
Details
Release State / release-state (push) Waiting to run
Details
Parallel Tests / Discover test files (push) Waiting to run
Details
Parallel Tests / ${{ matrix.test.name }} (push) Blocked by required conditions
Details
Parallel Tests / ${{ matrix.plugin.name }} (push) Blocked by required conditions
Details
Run tests / python_tests (ubuntu-22.04, 3.13) (push) Waiting to run
Details
Run tests / docker_tests (push) Waiting to run
Details
docs: regenerate sphinx apidocs to reflect current source tree 
Clean rebuild of docs/apidocs/archivebox/ via autodoc2:
- Removes 19 stale module pages whose source files no longer exist
  (cli_utils, host_utils, schedule_utils — renamed to *_util; actors,
  ideas, debugging, folders, legacy, progress_layout, tests_piping,
  config_tags, personas.runtime/views, orchestrator*, worker, tasks).
- Adds 29 new module pages for code that was added since the previous
  generation but not yet documented.
- Updates 100 existing pages to reflect API surface changes (e.g.
  ENABLED_PLUGINS Field removed, SNAPSHOTS_PER_PAGE clamp removed,
  default bumped to 50, etc.).

156 source modules <-> 156 apidoc files (zero drift). Build clean
under sphinx-build -W --keep-going.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-31 03:40:25 -07:00

6.6 KiB
Raw Blame History

{py:mod}archivebox.core.permissions

:allowtitles:

Module Contents

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`normalize_permissions <archivebox.core.permissions.normalize_permissions>`
  - ```{autodoc2-docstring} archivebox.core.permissions.normalize_permissions
    :summary:
    ```
* - {py:obj}`is_admin_user <archivebox.core.permissions.is_admin_user>`
  - ```{autodoc2-docstring} archivebox.core.permissions.is_admin_user
    :summary:
    ```
* - {py:obj}`get_snapshot_permissions <archivebox.core.permissions.get_snapshot_permissions>`
  - ```{autodoc2-docstring} archivebox.core.permissions.get_snapshot_permissions
    :summary:
    ```
* - {py:obj}`can_view_snapshot <archivebox.core.permissions.can_view_snapshot>`
  - ```{autodoc2-docstring} archivebox.core.permissions.can_view_snapshot
    :summary:
    ```
* - {py:obj}`_persona_ids_for_permissions <archivebox.core.permissions._persona_ids_for_permissions>`
  - ```{autodoc2-docstring} archivebox.core.permissions._persona_ids_for_permissions
    :summary:
    ```
* - {py:obj}`filter_personas_by_permissions <archivebox.core.permissions.filter_personas_by_permissions>`
  - ```{autodoc2-docstring} archivebox.core.permissions.filter_personas_by_permissions
    :summary:
    ```
* - {py:obj}`filter_snapshots_by_permissions <archivebox.core.permissions.filter_snapshots_by_permissions>`
  - ```{autodoc2-docstring} archivebox.core.permissions.filter_snapshots_by_permissions
    :summary:
    ```
* - {py:obj}`public_snapshots_queryset <archivebox.core.permissions.public_snapshots_queryset>`
  - ```{autodoc2-docstring} archivebox.core.permissions.public_snapshots_queryset
    :summary:
    ```
* - {py:obj}`direct_snapshots_queryset <archivebox.core.permissions.direct_snapshots_queryset>`
  - ```{autodoc2-docstring} archivebox.core.permissions.direct_snapshots_queryset
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`PERMISSIONS_PUBLIC <archivebox.core.permissions.PERMISSIONS_PUBLIC>`
  - ```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_PUBLIC
    :summary:
    ```
* - {py:obj}`PERMISSIONS_UNLISTED <archivebox.core.permissions.PERMISSIONS_UNLISTED>`
  - ```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_UNLISTED
    :summary:
    ```
* - {py:obj}`PERMISSIONS_PRIVATE <archivebox.core.permissions.PERMISSIONS_PRIVATE>`
  - ```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_PRIVATE
    :summary:
    ```
* - {py:obj}`PERMISSIONS_CHOICES <archivebox.core.permissions.PERMISSIONS_CHOICES>`
  - ```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_CHOICES
    :summary:
    ```
* - {py:obj}`PERMISSIONS_VALUES <archivebox.core.permissions.PERMISSIONS_VALUES>`
  - ```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_VALUES
    :summary:
    ```
* - {py:obj}`PERMISSIONS_META <archivebox.core.permissions.PERMISSIONS_META>`
  - ```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_META
    :summary:
    ```

API

:canonical: archivebox.core.permissions.PERMISSIONS_PUBLIC
:value: >
   'public'

```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_PUBLIC
```


:canonical: archivebox.core.permissions.PERMISSIONS_UNLISTED
:value: >
   'unlisted'

```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_UNLISTED
```


:canonical: archivebox.core.permissions.PERMISSIONS_PRIVATE
:value: >
   'private'

```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_PRIVATE
```


:canonical: archivebox.core.permissions.PERMISSIONS_CHOICES
:value: >
   ((), (), ())

```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_CHOICES
```


:canonical: archivebox.core.permissions.PERMISSIONS_VALUES
:value: >
   None

```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_VALUES
```


:canonical: archivebox.core.permissions.PERMISSIONS_META
:value: >
   None

```{autodoc2-docstring} archivebox.core.permissions.PERMISSIONS_META
```


:canonical: archivebox.core.permissions.normalize_permissions

```{autodoc2-docstring} archivebox.core.permissions.normalize_permissions
```

:canonical: archivebox.core.permissions.is_admin_user

```{autodoc2-docstring} archivebox.core.permissions.is_admin_user
```

:canonical: archivebox.core.permissions.get_snapshot_permissions

```{autodoc2-docstring} archivebox.core.permissions.get_snapshot_permissions
```

:canonical: archivebox.core.permissions.can_view_snapshot

```{autodoc2-docstring} archivebox.core.permissions.can_view_snapshot
```

:canonical: archivebox.core.permissions._persona_ids_for_permissions

```{autodoc2-docstring} archivebox.core.permissions._persona_ids_for_permissions
```

:canonical: archivebox.core.permissions.filter_personas_by_permissions

```{autodoc2-docstring} archivebox.core.permissions.filter_personas_by_permissions
```

:canonical: archivebox.core.permissions.filter_snapshots_by_permissions

```{autodoc2-docstring} archivebox.core.permissions.filter_snapshots_by_permissions
```

:canonical: archivebox.core.permissions.public_snapshots_queryset

```{autodoc2-docstring} archivebox.core.permissions.public_snapshots_queryset
```

:canonical: archivebox.core.permissions.direct_snapshots_queryset

```{autodoc2-docstring} archivebox.core.permissions.direct_snapshots_queryset
```