semvec/pypi-packages huggingface dataset:
dkp 0.2.0
DocKer compose Packer
License: MIT
Requires Python: >=3.8

# DKP - DocKer compose Packer

[![PyPI - Version](https://img.shields.io/pypi/v/dkp)](https://pypi.org/project/dkp/)

Packs existent docker-compose project in executable single encrypted (GPG
AES256) archive (tar + gz). It means, that you don't need to install DKP or
remember procedure details during restore which dramatically reduces stress and
make your life simpler. In the end - it's hard to remember how to restore backup
made by N generations of administrators years ago before you...

The pipeline is:

```mermaid
flowchart TD
    A[tar volumes] -->B(tar images)
    B --> C[add env files and manifests]
    C --> D[add restore scripts]
    D --> E[compress and encrypt]
    E --> F[wrap to self-extracting file]
```

For backup you need:

- gpg
- python 3.8+ (see tests in workflow)
- sh
- tar
- gzip
- docker with compose plugin

For restore you need:

- gpg
- sed
- tar
- gzip

## Installation

**Recomended**

    pip install dkp

Alternative - just download [dkp/dkp.py](dkp/dkp.py) and make it executable.

## Backward compatibility

Once backup created, the version of DKP doesn't matter anymore since archive is
self-complete independent file.

New DKP versions may introduce more features as well as different layout of
final archive, but it will not affect previous backups.

## Usage

### Create backup

```
usage: dkp [-h] [--output OUTPUT] [--skip-images] [--passphrase PASSPHRASE] [project]

DocKer compose Packer - backup compose project with all batteries included

positional arguments:
  project               Compose project name. Default is docker-compose-pack

options:
  -h, --help            show this help message and exit
  --output OUTPUT, -o OUTPUT
                        Output file. Default docker-compose-pack.bin
  --skip-images, -S     Do not archive images
  --passphrase PASSPHRASE, -p PASSPHRASE
                        Passphrase to encrypt backup. Can be set via env PASSPHRASE
```

### Restore

```
Usage:

./path/to/backup/file [--restore/-r] [-s/--start] [-h/--help] [passphrase]

   passphrase      Key to decrypt archive. Can be set by env PASSPHRASE

  -h, --help       Show this help
  -r, --restore    Automatically restore project after unpacking
  -s, --start      Automatically start project after unpacking. Implicitly enables --restore
```
slisemap-interactive 0.6.0
Interactive plots for Slisemap using Dash
License: MIT
Keywords: Slisemap,XAI,visualization,interactive

<!-- [![PyPI](https://img.shields.io/pypi/v/slisemap_interactive)](https://pypi.org/project/slisemap_interactive/) -->
[![Tests](https://github.com/edahelsinki/slisemap_interactive/actions/workflows/python-pytest.yml/badge.svg)](https://github.com/edahelsinki/slisemap_interactive/actions/workflows/python-pytest.yml)
[![Licence: MIT](https://img.shields.io/github/license/edahelsinki/slisemap_interactive)](https://github.com/edahelsinki/slisemap_interactive/blob/master/LICENSE)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
# [Slisemap](https://github.com/edahelsinki/slisemap)-interactive

Interactive plots for [Slisemap](https://github.com/edahelsinki/slisemap) using [Dash](https://dash.plotly.com/). This package can be used in four different ways:

1. __CLI:__ To start a standalone dash app just run `slisemap_interactive path/to/slisemap/object.sm` (if the package has been installed) or `python -m slisemap_interactive path/to/slisemap/object.sm` (in the root of this repository).

2. __REPL:__ To use it as (interactive) replacement plots for Slisemap from a Python terminal, import the *plot* function `from slisemap_interactive import plot` and use it `plot(slisemap_object)`.

3. __jupyter:__ To create plots in a jupyter notebook, import the *plot* function `from slisemap_interactive import plot` and use it `plot(slisemap_object)`.


4. __[χiplot](https://github.com/edahelsinki/xiplot):__ As a plugin that adds loading and plotting of Slisemap objects.
To use the plugin, just install the package in the same Python environment as [χiplot](https://github.com/edahelsinki/xiplot).

## Screenshots

![Screenshot showing focus on a single data item](screenshot01.webp)
![Screenshot showing comparison between clusters](screenshot02.webp)

## Installation

To install __slisemap_interactive__ run one of the following commands:

```bash
pip install slisemap_interactive
pip install slisemap_interactive[xiplot]
pip install git+https://github.com/edahelsinki/slisemap_interactive
```

## Help

To see the syntax and arguments for the command line interface run:

```bash
slisemap_interactive --help
```

To see the arguments for the plot function use the `?` in IPython or Jupyter:

```python
from slisemap_interactive import plot
plot?
```

## Development

When developing __slisemap_interactive__ it is a good idea to do an “[editable](https://setuptools.pypa.io/en/latest/userguide/development_mode.html)” install.
An editable install just links “installed” Python files to the Python files in this directory (so that any changes are immediately available).
This takes care of the namespace resolution and also activates the "[entry_points](https://setuptools.pypa.io/en/latest/userguide/entry_point.html)" for the *standalone CLI* and *χiplot-plugin*.
To do an editable installation run:

```bash
pip install --editable ".[dev]"
```