Metadata-Version: 2.1
Name: klipper-backup-manager
Version: 3.0.9
Summary: A set of tools for managing, creating, and restoring backups of configurations, customizations, and gcodes for Klipper-based 3D printing setups.
Project-URL: Documentation, https://github.com/venus-de-lmao/klipper-backup-manager#readme
Project-URL: Issues, https://github.com/venus-de-lmao/klipper-backup-manager/issues
Project-URL: Source, https://github.com/venus-de-lmao/klipper-backup-manager
Author-email: Laurel Ash <laurel.ash@proton.me>
License-Expression: GPL-3.0-or-later
License-File: LICENSE.txt
Keywords: 3d printing,backup,klipper
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: click
Requires-Dist: cloup
Requires-Dist: pyyaml
Requires-Dist: tqdm
Description-Content-Type: text/markdown

# Klipper Backup Manager

[![PyPI - Version](https://img.shields.io/pypi/v/klipper-backup-manager.svg)](https://pypi.org/project/klipper-backup-manager)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/klipper-backup-manager.svg)](https://pypi.org/project/klipper-backup-manager)

-----

**Table of Contents**

- [Installation](#installation)
- [License](#license)
- [Use](#Use)
- [Issues](#Issues)

## Installation

```console
pip install klipper-backup-manager 
```

## License

`klipper-backup-manager` is distributed under the terms of the [GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html) license.

## Use

The interface is simple. Settings are controlled by the **kbm.yaml** file in ~/.kbmlocal, which will be automatically created if it doesn't exist.

```console
Usage: kbm-tool [OPTIONS]

Archive options: [exactly 1 required]
  Specify whether to back up or restore files.
  -b, --backup   Backs up your selected target.
  -r, --restore  Restores your selected target.

Target options: [exactly 1 required]
  Specify which files to back up or restore.
  -c, --config   Backs up Klipper configuration files.
  -g, --gcode    Backs up gcode files.

Other options:
  --help         Show this message and exit.
  ```

## Issues

 Please open an issue on GitHub if you have any problems.
