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.machine.env_util.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

3.0 KiB
Raw Permalink Blame History

{py:mod}archivebox.machine.env_util

:allowtitles:

Module Contents

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`stringify_env_value <archivebox.machine.env_util.stringify_env_value>`
  - ```{autodoc2-docstring} archivebox.machine.env_util.stringify_env_value
    :summary:
    ```
* - {py:obj}`is_redacted_env_key <archivebox.machine.env_util.is_redacted_env_key>`
  - ```{autodoc2-docstring} archivebox.machine.env_util.is_redacted_env_key
    :summary:
    ```
* - {py:obj}`redact_env <archivebox.machine.env_util.redact_env>`
  - ```{autodoc2-docstring} archivebox.machine.env_util.redact_env
    :summary:
    ```
* - {py:obj}`env_to_dotenv_text <archivebox.machine.env_util.env_to_dotenv_text>`
  - ```{autodoc2-docstring} archivebox.machine.env_util.env_to_dotenv_text
    :summary:
    ```
* - {py:obj}`env_to_shell_exports <archivebox.machine.env_util.env_to_shell_exports>`
  - ```{autodoc2-docstring} archivebox.machine.env_util.env_to_shell_exports
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`SENSITIVE_ENV_KEY_PARTS <archivebox.machine.env_util.SENSITIVE_ENV_KEY_PARTS>`
  - ```{autodoc2-docstring} archivebox.machine.env_util.SENSITIVE_ENV_KEY_PARTS
    :summary:
    ```
* - {py:obj}`SHELL_ENV_KEY_RE <archivebox.machine.env_util.SHELL_ENV_KEY_RE>`
  - ```{autodoc2-docstring} archivebox.machine.env_util.SHELL_ENV_KEY_RE
    :summary:
    ```

API

:canonical: archivebox.machine.env_util.SENSITIVE_ENV_KEY_PARTS
:value: >
   ('KEY', 'TOKEN', 'SECRET')

```{autodoc2-docstring} archivebox.machine.env_util.SENSITIVE_ENV_KEY_PARTS
```


:canonical: archivebox.machine.env_util.SHELL_ENV_KEY_RE
:value: >
   'compile(...)'

```{autodoc2-docstring} archivebox.machine.env_util.SHELL_ENV_KEY_RE
```


:canonical: archivebox.machine.env_util.stringify_env_value

```{autodoc2-docstring} archivebox.machine.env_util.stringify_env_value
```

:canonical: archivebox.machine.env_util.is_redacted_env_key

```{autodoc2-docstring} archivebox.machine.env_util.is_redacted_env_key
```

:canonical: archivebox.machine.env_util.redact_env

```{autodoc2-docstring} archivebox.machine.env_util.redact_env
```

:canonical: archivebox.machine.env_util.env_to_dotenv_text

```{autodoc2-docstring} archivebox.machine.env_util.env_to_dotenv_text
```

:canonical: archivebox.machine.env_util.env_to_shell_exports

```{autodoc2-docstring} archivebox.machine.env_util.env_to_shell_exports
```