Metadata-Version: 2.4
Name: epicsarchiver-mgmt-client
Version: 1.0.0
Summary: Tool for doing archiver mgmt operations
Project-URL: Documentation, https://epicsarchiver-mgmt-client.readthedocs.io/en/latest/
Project-URL: Issues, https://github.com/archiver-appliance/epicsarchiver-mgmt-client/issues
Project-URL: Source, https://github.com/archiver-appliance/epicsarchiver-mgmt-client
Author-email: skybrewer <sky.brewer@ess.eu>
License-Expression: MIT
License-File: LICENSE
Keywords: archiver,epics,management,mgmt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.12
Requires-Dist: click>=8
Requires-Dist: python-dateutil
Requires-Dist: pytz
Requires-Dist: requests>=2
Requires-Dist: rich>=13
Description-Content-Type: text/markdown

# Epics Archiver Appliance Management Python Client

Project for tracking changes to the archiver via the mgmt operations interface. For example, change types, complicated renames, adding aliases.

- [Documentation](https://epicsarchiver-mgmt-client.readthedocs.io/en/latest/)
- [Repository](https://github.com/archiver-appliance/epicsarchiver-mgmt-client)

## Installation

```console
pip install epicsarchiver-mgmt-client
```

## Usage

```console
Usage: arch-mgmt [OPTIONS] COMMAND [ARGS]...

  Command line tool for doing mgmt operations with the archiver.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  alias             Alias PVs in the archiver.
  archive           Archive PVs in the archiver.
  change-parameter  Change the archiving parameters of PVs...
  change-protocol   Change the protocol of PVs in the...
  change-type       Change the type of PVs in the archiver.
  clear-queue       Clear Queue of already archiving PVs...
  delete            Delete PVs in the archiver.
  pause             Pause PVs in the archiver.
  rename            Rename PVs in the archiver.
  repolicy          Re choose the policy of PVs in the...
  resume            Resume Archiving PVs in the archiver.
  statuses          Get the status of PVs in the archiver.
```

The tool creates a log file for every operation, please upload this with the ticket or into logbook after finishing a task.

## Development

The package is built and packaged with [Hatch](https://hatch.pypa.io/latest/).

```console
pip install hatch
```

Run all checks and code coverage:

```console
hatch run all
```

Run tests:

```console
hatch test
```

Run formatting and check:

```console
hatch fmt
```

## License

Distributed under the terms of the [MIT license][license]

<!-- sphinx-include-end -->

[license]: LICENSE
