Metadata-Version: 2.1
Name: pirogue-admin-api
Version: 2.0.3
Summary: API definition of the communication protocol between the administration client and daemon for PiRogue.
Author-email: Christophe Andral <christophe@andral.fr>
Maintainer-email: U+039b <hello@pts-project.org>
License: GPL-3.0-or-later
Project-URL: repository, https://github.com/PiRogueToolSuite/pirogue-admin
Project-URL: issues, https://github.com/PiRogueToolSuite/pirogue-admin/issues
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: grpcio
Requires-Dist: pyyaml

# pirogue-admin-api

## Description
Common interface to PiRogue administration bricks.

## Motivation
PiRogue is now proudly supporting cloud deployment.
This project is the base local AND remote management system definition.
Both `pirogue-admin` and `pirogue-admin-client` are supposed to depreciate `pirogue-cli` package.
The `pirogue-admin-api` package is the common definition between `pirogue-admin` daemon and the `pirogue-admin-client` client (which also provides cli tools).

## Scope
Here are high-level features covered by PiRogue administration:
```yaml
System:
  - Query
  - Configuration
Networking:
  - External remote administration management
  - External network management
  - Isolated network management
  - Public access management
  - WiFi configuration
  - VPN administration
Services:
  - Grafana administration
  - Suricata detection rules management
```
