# Python API

Generated from the installed package. Functions and classes without a leading underscore are listed. The command-line behaviour is {doc}`cli`.

## Package

```{eval-rst}
.. automodule:: eb_staged_rebuild
   :members:
   :undoc-members:
```

## Command line

```{eval-rst}
.. automodule:: eb_staged_rebuild.cli
   :members:
   :undoc-members:
```

## Engine

```{eval-rst}
.. automodule:: eb_staged_rebuild.engine
   :members:
   :undoc-members:
```

## Builders

```{eval-rst}
.. automodule:: eb_staged_rebuild.builders
   :members:
   :undoc-members:
```

## Probe

```{eval-rst}
.. automodule:: eb_staged_rebuild.probe
   :members:
   :undoc-members:
```

## Swap

```{eval-rst}
.. automodule:: eb_staged_rebuild.swap
   :members:
   :undoc-members:
```

## Journal

```{eval-rst}
.. automodule:: eb_staged_rebuild.journal
   :members:
   :undoc-members:
```

## Module files

```{eval-rst}
.. automodule:: eb_staged_rebuild.modulefile
   :members:
   :undoc-members:
```

## Discovery

```{eval-rst}
.. automodule:: eb_staged_rebuild.discover
   :members:
   :undoc-members:
```

## Garbage collection

```{eval-rst}
.. automodule:: eb_staged_rebuild.gc
   :members:
   :undoc-members:
```

## Retire

```{eval-rst}
.. automodule:: eb_staged_rebuild.retire
   :members:
   :undoc-members:
```

## Lock

```{eval-rst}
.. automodule:: eb_staged_rebuild.lockfile
   :members:
   :undoc-members:
```

## Errors

```{eval-rst}
.. automodule:: eb_staged_rebuild.errors
   :members:
   :undoc-members:
```

## Atomic writes

```{eval-rst}
.. automodule:: eb_staged_rebuild.atomicio
   :members:
   :undoc-members:
```

## Paths

```{eval-rst}
.. automodule:: eb_staged_rebuild.paths
   :members:
   :undoc-members:
```

## Build events

```{eval-rst}
.. automodule:: eb_staged_rebuild.build_events
   :members:
   :undoc-members:
```

## Ledger adapter

```{eval-rst}
.. automodule:: eb_staged_rebuild.ledger_adapter
   :members:
   :undoc-members:
```

## Ledger maintenance

```{eval-rst}
.. automodule:: eb_staged_rebuild.ledger_maintenance
   :members:
   :undoc-members:
```

## Outbox

```{eval-rst}
.. automodule:: eb_staged_rebuild.outbox
   :members:
   :undoc-members:
```

## User-namespace helper

```{eval-rst}
.. automodule:: eb_staged_rebuild.userns_sandbox
   :members:
   :undoc-members:
```

## Cleanup, live check, faults, constants

```{eval-rst}
.. automodule:: eb_staged_rebuild.cleanup
   :members:
   :undoc-members:

.. automodule:: eb_staged_rebuild.livecheck
   :members:
   :undoc-members:

.. automodule:: eb_staged_rebuild.faults
   :members:
   :undoc-members:

.. automodule:: eb_staged_rebuild.constants
   :members:
   :undoc-members:
```