pingera-cli 0.1.16__tar.gz → 0.2.0__tar.gz

{pingera_cli-0.1.16/pingera_cli.egg-info → pingera_cli-0.2.0}/PKG-INFO

@@ -1,12 +1,10 @@
 Metadata-Version: 2.4
 Name: pingera-cli
-Version: 0.1.16
+Version: 0.2.0
 Summary: A beautiful Python CLI tool built with typer and rich, distributed via pip and based on Pingera SDK
-Home-page: https://github.com/pingera/pingera-cli
-Author: PingeraCLI Team
 Author-email: Pingera Team <privet@pingera.ru>
 Maintainer-email: Pingera Team <privet@pingera.ru>
-License: MIT
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/pingera/pingera-cli
 Project-URL: Documentation, https://docs.pingera.com/cli
 Project-URL: Repository, https://github.com/pingera/pingera-cli
@@ -15,34 +13,31 @@ Keywords: cli,pingera,network,monitoring,typer,rich,terminal
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-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 :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: System :: Networking
 Classifier: Topic :: Utilities
 Classifier: Environment :: Console
-Requires-Python: >=3.7
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer[all]>=0.9.0
 Requires-Dist: rich>=13.0.0
-Requires-Dist: pingera-sdk>=1.0.15
+Requires-Dist: pingera-sdk<2,>=1.2.0
 Requires-Dist: click>=8.0.0
+Requires-Dist: pyyaml>=6.0
 Provides-Extra: dev
 Requires-Dist: pytest>=6.0; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: flake8; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
-Dynamic: author
-Dynamic: home-page
 Dynamic: license-file
-Dynamic: requires-python
 
 # Pingera Platform CLI 🚀
 
@@ -56,7 +51,7 @@ A beautiful Python CLI tool for the [Pingera Platform](https://pingera.ru) - bui
 
 - **Beautiful Terminal Output**: Powered by Rich library for colorful, formatted output
 - **Modern CLI Interface**: Built with Typer for intuitive command-line interactions  
-- **Pingera Platform Integration**: Seamlessly integrates with Pingera SDK for managing and running checks (statuspages and other coming soon)
+- **Pingera Platform Integration**: Manage checks, uptime and performance analytics, alert rules and channels, and status pages (components, incidents, maintenance, postmortems) through the Pingera SDK
 - **Cross-Platform**: Works on Windows, macOS, and Linux
 - **Easy Installation**: Simple pip install with all dependencies managed
 - **Configuration Management**: Flexible configuration with environment variables and config files
@@ -64,12 +59,14 @@ A beautiful Python CLI tool for the [Pingera Platform](https://pingera.ru) - bui
 
 ## 🚀 Installation
 
-Install Pingera Platform CLI using pip:
+Install Pingera Platform CLI using pip (requires Python 3.10+):
 
 ```bash
 pip install pingera-cli
 ```
 
+The CLI is built on [pingera-sdk](https://pypi.org/project/pingera-sdk/) 1.2+, which is installed automatically.
+
 ## 🔐 Authentication
 
 Before using the CLI, you need to authenticate with the Pingera Platform:
@@ -110,11 +107,33 @@ pngr checks create \
   --interval 300
 ```
 
+### Schedule a check with cron
+```bash
+# Run on weekdays at 09:00 instead of a fixed interval
+pngr checks create --name "Morning check" --type web --url https://example.com --cron "0 9 * * 1-5"
+
+# Switch an existing check between cron and interval scheduling
+pngr checks update <check-id> --cron "*/15 * * * *"
+pngr checks update <check-id> --interval 300
+```
+
 ### Get check results
 ```bash
 pngr checks results <check-id>
 ```
 
+### Uptime and performance
+```bash
+# Uptime over the last 7 days, with hour-by-hour detail
+pngr checks uptime <check-id> --from 7d --hourly
+
+# p95/p99 response times per region
+pngr checks response-times <check-id> --from 24h
+
+# Success rate per region across all checks
+pngr checks stats --from 7d
+```
+
 ### Run an on-demand check
 ```bash
 pngr checks run custom \
@@ -141,6 +160,32 @@ pngr checks assign-group check_123 --group-id group_456
 pngr checks assign-group check_123 --group-id null
 ```
 
+### Alerts
+```bash
+# Create a notification channel and a rule that alerts after 3 consecutive failures
+pngr alerts channels create --name "On-call" --email oncall@example.com
+pngr alerts rules create --name "API down" --check <check-id> --count 3 --channel <channel-id>
+
+# See what is firing and acknowledge it
+pngr alerts list --status firing
+pngr alerts ack <alert-id>
+```
+
+### Status pages
+```bash
+# Post an incident and follow-up updates
+pngr pages incidents create --page-id <page-id> --name "API errors" --status investigating --impact major
+pngr pages incidents updates add <incident-id> --page-id <page-id> --status resolved --body "Fixed"
+
+# Schedule maintenance
+pngr pages incidents schedule-maintenance --page-id <page-id> --name "DB upgrade" --start +24h --end +26h
+
+# Component uptime for the whole page
+pngr pages components uptime-report --page-id <page-id> --from 2026-01-01
+```
+
+See [docs/cli-commands.md](docs/cli-commands.md) for the full command reference.
+
 ### Secrets Management
 
 ```bash
@@ -169,14 +214,17 @@ pngr checks list-regions --check-type web
 
 ## 🔧 Configuration
 
-The CLI stores configuration in `~/.config/pingera-cli/config.json`. You can manage settings with:
+The CLI stores configuration in `~/.config/pingera-cli/config.json` (or `$XDG_CONFIG_HOME/pingera-cli/config.json`). You can manage settings with:
 
 ```bash
 # Show current configuration
-pngr config show
+pngr config --show
+
+# Set the default output format
+pngr config --output-format json
 
-# Set default output format
-pngr config set output_format json
+# Point the CLI at a different API endpoint
+pngr config --base-url https://api.pingera.ru
 ```
 
 ## 📊 Output Formats
@@ -187,14 +235,18 @@ The CLI supports multiple output formats:
 - **json**: JSON format for scripting
 - **yaml**: YAML format
 
+`--output`/`-o` is a global option, so it goes before the command. It applies to that invocation only; use `pngr config --output-format` to change the default.
+
 ```bash
 # JSON output
-pngr checks list --output json
+pngr -o json checks list
 
-# YAML output  
-pngr checks list --output yaml
+# YAML output
+pngr -o yaml checks list
 ```
 
+In `json`/`yaml` mode, stdout contains only the data, and status messages go to stderr, so output can be piped safely (for example, `pngr -o json checks list | jq '.checks[].id'`).
+
 ## 🌐 Platform Links
 
 - **Pingera Platform**: [https://pingera.ru](https://pingera.ru)
@@ -218,6 +270,16 @@ pngr --help
 python -m pytest tests/
 ```
 
+### Releasing
+
+Bump `__version__` in `pingera_cli/__init__.py`, merge to `main`, then push a matching tag:
+
+```bash
+git tag v0.2.0 && git push origin v0.2.0
+```
+
+The [release workflow](.github/workflows/release.yml) runs the tests, builds the package, publishes it to PyPI (Trusted Publishing) and creates a GitHub release.
+
 ## 📝 License
 
 This project is licensed under the MIT License - see the LICENSE file for details.

{pingera_cli-0.1.16 → pingera_cli-0.2.0}/README.md

@@ -10,7 +10,7 @@ A beautiful Python CLI tool for the [Pingera Platform](https://pingera.ru) - bui
 
 - **Beautiful Terminal Output**: Powered by Rich library for colorful, formatted output
 - **Modern CLI Interface**: Built with Typer for intuitive command-line interactions  
-- **Pingera Platform Integration**: Seamlessly integrates with Pingera SDK for managing and running checks (statuspages and other coming soon)
+- **Pingera Platform Integration**: Manage checks, uptime and performance analytics, alert rules and channels, and status pages (components, incidents, maintenance, postmortems) through the Pingera SDK
 - **Cross-Platform**: Works on Windows, macOS, and Linux
 - **Easy Installation**: Simple pip install with all dependencies managed
 - **Configuration Management**: Flexible configuration with environment variables and config files
@@ -18,12 +18,14 @@ A beautiful Python CLI tool for the [Pingera Platform](https://pingera.ru) - bui
 
 ## 🚀 Installation
 
-Install Pingera Platform CLI using pip:
+Install Pingera Platform CLI using pip (requires Python 3.10+):
 
 ```bash
 pip install pingera-cli
 ```
 
+The CLI is built on [pingera-sdk](https://pypi.org/project/pingera-sdk/) 1.2+, which is installed automatically.
+
 ## 🔐 Authentication
 
 Before using the CLI, you need to authenticate with the Pingera Platform:
@@ -64,11 +66,33 @@ pngr checks create \
   --interval 300
 ```
 
+### Schedule a check with cron
+```bash
+# Run on weekdays at 09:00 instead of a fixed interval
+pngr checks create --name "Morning check" --type web --url https://example.com --cron "0 9 * * 1-5"
+
+# Switch an existing check between cron and interval scheduling
+pngr checks update <check-id> --cron "*/15 * * * *"
+pngr checks update <check-id> --interval 300
+```
+
 ### Get check results
 ```bash
 pngr checks results <check-id>
 ```
 
+### Uptime and performance
+```bash
+# Uptime over the last 7 days, with hour-by-hour detail
+pngr checks uptime <check-id> --from 7d --hourly
+
+# p95/p99 response times per region
+pngr checks response-times <check-id> --from 24h
+
+# Success rate per region across all checks
+pngr checks stats --from 7d
+```
+
 ### Run an on-demand check
 ```bash
 pngr checks run custom \
@@ -95,6 +119,32 @@ pngr checks assign-group check_123 --group-id group_456
 pngr checks assign-group check_123 --group-id null
 ```
 
+### Alerts
+```bash
+# Create a notification channel and a rule that alerts after 3 consecutive failures
+pngr alerts channels create --name "On-call" --email oncall@example.com
+pngr alerts rules create --name "API down" --check <check-id> --count 3 --channel <channel-id>
+
+# See what is firing and acknowledge it
+pngr alerts list --status firing
+pngr alerts ack <alert-id>
+```
+
+### Status pages
+```bash
+# Post an incident and follow-up updates
+pngr pages incidents create --page-id <page-id> --name "API errors" --status investigating --impact major
+pngr pages incidents updates add <incident-id> --page-id <page-id> --status resolved --body "Fixed"
+
+# Schedule maintenance
+pngr pages incidents schedule-maintenance --page-id <page-id> --name "DB upgrade" --start +24h --end +26h
+
+# Component uptime for the whole page
+pngr pages components uptime-report --page-id <page-id> --from 2026-01-01
+```
+
+See [docs/cli-commands.md](docs/cli-commands.md) for the full command reference.
+
 ### Secrets Management
 
 ```bash
@@ -123,14 +173,17 @@ pngr checks list-regions --check-type web
 
 ## 🔧 Configuration
 
-The CLI stores configuration in `~/.config/pingera-cli/config.json`. You can manage settings with:
+The CLI stores configuration in `~/.config/pingera-cli/config.json` (or `$XDG_CONFIG_HOME/pingera-cli/config.json`). You can manage settings with:
 
 ```bash
 # Show current configuration
-pngr config show
+pngr config --show
+
+# Set the default output format
+pngr config --output-format json
 
-# Set default output format
-pngr config set output_format json
+# Point the CLI at a different API endpoint
+pngr config --base-url https://api.pingera.ru
 ```
 
 ## 📊 Output Formats
@@ -141,14 +194,18 @@ The CLI supports multiple output formats:
 - **json**: JSON format for scripting
 - **yaml**: YAML format
 
+`--output`/`-o` is a global option, so it goes before the command. It applies to that invocation only; use `pngr config --output-format` to change the default.
+
 ```bash
 # JSON output
-pngr checks list --output json
+pngr -o json checks list
 
-# YAML output  
-pngr checks list --output yaml
+# YAML output
+pngr -o yaml checks list
 ```
 
+In `json`/`yaml` mode, stdout contains only the data, and status messages go to stderr, so output can be piped safely (for example, `pngr -o json checks list | jq '.checks[].id'`).
+
 ## 🌐 Platform Links
 
 - **Pingera Platform**: [https://pingera.ru](https://pingera.ru)
@@ -172,6 +229,16 @@ pngr --help
 python -m pytest tests/
 ```
 
+### Releasing
+
+Bump `__version__` in `pingera_cli/__init__.py`, merge to `main`, then push a matching tag:
+
+```bash
+git tag v0.2.0 && git push origin v0.2.0
+```
+
+The [release workflow](.github/workflows/release.yml) runs the tests, builds the package, publishes it to PyPI (Trusted Publishing) and creates a GitHub release.
+
 ## 📝 License
 
 This project is licensed under the MIT License - see the LICENSE file for details.

{pingera_cli-0.1.16 → pingera_cli-0.2.0}/pingera_cli/__init__.py

@@ -2,7 +2,7 @@
 Pingera CLI - A beautiful CLI tool for Pingera Platform
 """
 
-__version__ = "0.1.16"
+__version__ = "0.2.0"
 __author__ = "Pingera Team"
 __description__ = "A beautiful Python CLI tool built with typer and rich, distributed via pip and based on Pingera SDK"