Metadata-Version: 2.4
Name: statshed-cli
Version: 1.0.2
Summary: Command-line interface for StatShed status dashboard
Project-URL: Homepage, https://github.com/statshed/statshed-pycli
Project-URL: Documentation, https://github.com/statshed/statshed-pycli#readme
Project-URL: Repository, https://github.com/statshed/statshed-pycli.git
Project-URL: Bug Tracker, https://github.com/statshed/statshed-pycli/issues
Project-URL: Changelog, https://github.com/statshed/statshed-pycli/blob/main/CHANGELOG.md
Author: Sean
License: Creative Commons Legal Code
        
        CC0 1.0 Universal
        
            CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
            LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
            ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
            INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
            REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
            PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
            THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
            HEREUNDER.
        
        Statement of Purpose
        
        The laws of most jurisdictions throughout the world automatically confer
        exclusive Copyright and Related Rights (defined below) upon the creator
        and subsequent owner(s) (each and all, an "owner") of an original work of
        authorship and/or a database (each, a "Work").
        
        Certain owners wish to permanently relinquish those rights to a Work for
        the purpose of contributing to a commons of creative, cultural and
        scientific works ("Commons") that the public can reliably and without fear
        of later claims of infringement build upon, modify, incorporate in other
        works, reuse and redistribute as freely as possible in any form whatsoever
        and for any purposes, including without limitation commercial purposes.
        These owners may contribute to the Commons to promote the ideal of a free
        culture and the further production of creative, cultural and scientific
        works, or to gain reputation or greater distribution for their Work in
        part through the use and efforts of others.
        
        For these and/or other purposes and motivations, and without any
        expectation of additional consideration or compensation, the person
        associating CC0 with a Work (the "Affirmer"), to the extent that he or she
        is an owner of Copyright and Related Rights in the Work, voluntarily
        elects to apply CC0 to the Work and publicly distribute the Work under its
        terms, with knowledge of his or her Copyright and Related Rights in the
        Work and the meaning and intended legal effect of CC0 on those rights.
        
        1. Copyright and Related Rights. A Work made available under CC0 may be
        protected by copyright and related or neighboring rights ("Copyright and
        Related Rights"). Copyright and Related Rights include, but are not
        limited to, the following:
        
          i. the right to reproduce, adapt, distribute, perform, display,
             communicate, and translate a Work;
         ii. moral rights retained by the original author(s) and/or performer(s);
        iii. publicity and privacy rights pertaining to a person's image or
             likeness depicted in a Work;
         iv. rights protecting against unfair competition in regards to a Work,
             subject to the limitations in paragraph 4(a), below;
          v. rights protecting the extraction, dissemination, use and reuse of data
             in a Work;
         vi. database rights (such as those arising under Directive 96/9/EC of the
             European Parliament and of the Council of 11 March 1996 on the legal
             protection of databases, and under any national implementation
             thereof, including any amended or successor version of such
             directive); and
        vii. other similar, equivalent or corresponding rights throughout the
             world based on applicable law or treaty, and any national
             implementations thereof.
        
        2. Waiver. To the greatest extent permitted by, but not in contravention
        of, applicable law, Affirmer hereby overtly, fully, permanently,
        irrevocably and unconditionally waives, abandons, and surrenders all of
        Affirmer's Copyright and Related Rights and associated claims and causes
        of action, whether now known or unknown (including existing as well as
        future claims and causes of action), in the Work (i) in all territories
        worldwide, (ii) for the maximum duration provided by applicable law or
        treaty (including future time extensions), (iii) in any current or future
        medium and for any number of copies, and (iv) for any purpose whatsoever,
        including without limitation commercial, advertising or promotional
        purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
        member of the public at large and to the detriment of Affirmer's heirs and
        successors, fully intending that such Waiver shall not be subject to
        revocation, rescission, cancellation, termination, or any other legal or
        equitable action to disrupt the quiet enjoyment of the Work by the public
        as contemplated by Affirmer's express Statement of Purpose.
        
        3. Public License Fallback. Should any part of the Waiver for any reason
        be judged legally invalid or ineffective under applicable law, then the
        Waiver shall be preserved to the maximum extent permitted taking into
        account Affirmer's express Statement of Purpose. In addition, to the
        extent the Waiver is so judged Affirmer hereby grants to each affected
        person a royalty-free, non transferable, non sublicensable, non exclusive,
        irrevocable and unconditional license to exercise Affirmer's Copyright and
        Related Rights in the Work (i) in all territories worldwide, (ii) for the
        maximum duration provided by applicable law or treaty (including future
        time extensions), (iii) in any current or future medium and for any number
        of copies, and (iv) for any purpose whatsoever, including without
        limitation commercial, advertising or promotional purposes (the
        "License"). The License shall be deemed effective as of the date CC0 was
        applied by Affirmer to the Work. Should any part of the License for any
        reason be judged legally invalid or ineffective under applicable law, such
        partial invalidity or ineffectiveness shall not invalidate the remainder
        of the License, and in such case Affirmer hereby affirms that he or she
        will not (i) exercise any of his or her remaining Copyright and Related
        Rights in the Work or (ii) assert any associated claims and causes of
        action with respect to the Work, in either case contrary to Affirmer's
        express Statement of Purpose.
        
        4. Limitations and Disclaimers.
        
         a. No trademark or patent rights held by Affirmer are waived, abandoned,
            surrendered, licensed or otherwise affected by this document.
         b. Affirmer offers the Work as-is and makes no representations or
            warranties of any kind concerning the Work, express, implied,
            statutory or otherwise, including without limitation warranties of
            title, merchantability, fitness for a particular purpose, non
            infringement, or the absence of latent or other defects, accuracy, or
            the present or absence of errors, whether or not discoverable, all to
            the greatest extent permissible under applicable law.
         c. Affirmer disclaims responsibility for clearing rights of other persons
            that may apply to the Work or any use thereof, including without
            limitation any person's Copyright and Related Rights in the Work.
            Further, Affirmer disclaims responsibility for obtaining any necessary
            consents, permissions or other rights required for any use of the
            Work.
         d. Affirmer understands and acknowledges that Creative Commons is not a
            party to this document and has no duty or obligation with respect to
            this CC0 or use of the Work.
License-File: LICENSE
Keywords: cli,dashboard,monitoring,statshed,status
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Topic :: System :: Monitoring
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: click>=8.1.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: requests>=2.28.0
Provides-Extra: dev
Requires-Dist: mypy>=1.0.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Requires-Dist: responses>=0.23.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Requires-Dist: types-pyyaml>=6.0.0; extra == 'dev'
Requires-Dist: types-requests>=2.28.0; extra == 'dev'
Provides-Extra: rich
Requires-Dist: rich>=13.0.0; extra == 'rich'
Description-Content-Type: text/markdown

# StatShed CLI

[![Tests](https://github.com/statshed/statshed-pycli/actions/workflows/test.yml/badge.svg)](https://github.com/statshed/statshed-pycli/actions/workflows/test.yml)

Command-line interface for the StatShed status dashboard.

## Installation

```bash
pip install statshed-cli
```

For rich terminal output:
```bash
pip install statshed-cli[rich]
```

## Usage

### Submit Job Status

```bash
# Submit a success status
statshed submit -g nightly-builds -j backend-tests -s success -m "All tests passed"

# Submit an error status
statshed submit -g nightly-builds -j backend-tests -s error -m "3 tests failed"

# Submit a progress status
statshed submit -g nightly-builds -j backend-tests -s progress -m "Running tests..."
```

### Check System Health

```bash
statshed health
```

### List Groups

```bash
statshed groups
```

### List Jobs in a Group

```bash
statshed jobs nightly-builds
```

### View/Update Configuration

```bash
# View global config
statshed config

# Update global config
statshed config --progress-timeout 10 --staleness-timeout 48

# View group config
statshed group-config nightly-builds

# Update group config
statshed group-config nightly-builds --progress-timeout 15
```

## Configuration File

The CLI reads configuration from these locations (in order of precedence):

1. Path specified via `--config` or `STATSHED_CONFIG` environment variable
2. `./statshed.yaml` (current directory)
3. `~/.config/statshed/statshed.yaml`
4. `/etc/statshed/statshed.yaml`

Example configuration:

```yaml
url: http://localhost:7828
output_format: table
color: auto
timeout: 10

submit:
  syslog: false
  strict: false
```

## Environment Variables

- `STATSHED_URL`: API server URL
- `STATSHED_CONFIG`: Path to configuration file
- `NO_COLOR`: Disable colored output

## Exit Codes

| Code | Description |
|------|-------------|
| 0 | Success |
| 1 | Health check returned unhealthy status |
| 2 | API error |
| 3 | Connection error |
| 4 | Timeout error |
| 5 | Configuration error |
| 10 | Invalid arguments |
| 11 | Resource not found |

## Shell Completion

StatShed CLI provides shell completion for Bash, Zsh, and Fish. The completion includes:

- Command and option names
- Dynamic group name completion (queries the API)
- Dynamic job name completion (when group is specified)
- Status value completion (`success`, `error`, `progress`)

### Installation

**Bash:**
```bash
# Create the completions directory if it doesn't exist
mkdir -p ~/.local/share/bash-completion/completions

# Generate and install the completion script
statshed completion bash > ~/.local/share/bash-completion/completions/statshed

# Reload your shell or source the file
source ~/.local/share/bash-completion/completions/statshed
```

**Zsh:**
```bash
# Create the completions directory if it doesn't exist
mkdir -p ~/.zfunc

# Add to .zshrc if not already present:
# fpath+=~/.zfunc
# autoload -Uz compinit && compinit

# Generate and install the completion script
statshed completion zsh > ~/.zfunc/_statshed

# Reload completions
autoload -Uz compinit && compinit
```

**Fish:**
```bash
# Create the completions directory if it doesn't exist
mkdir -p ~/.config/fish/completions

# Generate and install the completion script
statshed completion fish > ~/.config/fish/completions/statshed.fish
```

### Dynamic Completion

The shell completion queries the StatShed API to provide contextual suggestions:

- When completing group names (`--group` or group arguments), available groups are fetched from the server
- When completing job names (`--job`), jobs from the specified group are fetched
- If the server is unavailable, completion falls back to basic suggestions

Set `STATSHED_URL` environment variable if your server is not at the default location:
```bash
export STATSHED_URL=https://statshed.example.com
```

## Common Use Cases

### CI/CD Pipeline (GitHub Actions)

```yaml
jobs:
  build:
    steps:
      - name: Report build start
        run: |
          statshed submit -g ci-builds -j "${{ github.repository }}" \
            -s progress -m "Build started: ${{ github.sha }}"

      - name: Build
        run: make build

      - name: Report build success
        if: success()
        run: |
          statshed submit -g ci-builds -j "${{ github.repository }}" \
            -s success -m "Build passed: ${{ github.sha }}"

      - name: Report build failure
        if: failure()
        run: |
          statshed submit -g ci-builds -j "${{ github.repository }}" \
            -s error -m "Build failed: ${{ github.sha }}"
```

### Cron Job Status Reporting

For safe use with `set -eu` (script exits on error), use the default lenient mode:

```bash
#!/bin/bash
set -eu

# Submit commands won't cause script to exit on API errors
statshed submit -g backups -j database -s progress -m "Starting backup"

# Do the actual backup
pg_dump mydb > /backups/mydb.sql

# Report success
statshed submit -g backups -j database -s success -m "Backup completed"
```

For manual error handling with strict mode:

```bash
#!/bin/bash

if ! statshed submit --strict -g backups -j database -s progress; then
    echo "Warning: Could not report status to dashboard"
fi

pg_dump mydb > /backups/mydb.sql
backup_status=$?

if [ $backup_status -eq 0 ]; then
    statshed submit -g backups -j database -s success
else
    statshed submit -g backups -j database -s error -m "Backup failed with code $backup_status"
fi
```

### Interactive Terminal Usage

```bash
# Check overall health with rich output
$ statshed health

# List groups with status summary
$ statshed groups

# Drill into a specific group
$ statshed jobs nightly-builds

# Check group-specific timeout configuration
$ statshed group-config nightly-builds

# Update group timeout (builds can take longer)
$ statshed group-config nightly-builds --progress-timeout 30
```

### Script Integration with Error Logging to Syslog

Enable syslog logging for daemon/cron scenarios where stderr may not be monitored:

```yaml
# ~/.config/statshed/statshed.yaml
url: https://statshed.example.com
submit:
  syslog: true
  syslog_facility: local0
```

## Troubleshooting

### Connection Refused

```
Error: Could not connect to http://localhost:7828: Connection refused
```

**Cause**: The StatShed backend is not running or is running on a different port.

**Solution**:
- Verify the backend is running: `curl http://localhost:7828/health`
- Check the URL with `--url` or in config file
- Set `STATSHED_URL` environment variable

### Request Timeout

```
Error: Request to http://localhost:7828/health timed out after 10s
```

**Cause**: The server is slow or unresponsive.

**Solution**:
- Increase timeout in config file: `timeout: 30`
- Check server health and load
- Enable retries: `retries: 3`

### Group/Job Not Found

```
Error: Group 'nonexistent' not found
```

**Cause**: The group doesn't exist in the database.

**Solution**:
- Groups are auto-created on first status submission
- Submit a status to create the group: `statshed submit -g newgroup -j newjob -s success`

### Invalid Configuration File

```
Configuration error: Invalid YAML in config file ...
```

**Cause**: The YAML config file has syntax errors.

**Solution**:
- Validate your YAML with a linter
- Check for proper indentation (spaces, not tabs)
- Ensure string values are properly quoted if they contain special characters

### Shell Completion Not Working

**Cause**: Completion script not installed or shell not reloaded.

**Solution**:
1. Regenerate the completion script for your shell
2. Ensure it's in the correct location (see Shell Completion section)
3. Reload your shell or source the script

## Development

```bash
# Install development dependencies
uv sync --extra dev

# Run tests
pytest

# Run tests with coverage
pytest --cov=statshed_cli

# Format code
ruff format .

# Lint code
ruff check .

# Type check
mypy statshed_cli
```

## Building a Debian Package

### Building the Package

From the project root directory:

```bash
# Build the package (binary only, no source package signing)
dpkg-buildpackage -us -uc -b

# Or use debuild for a cleaner build environment
debuild -us -uc -b
```

The built `.deb` file will be placed in the parent directory (`../`).

### Installing the Package

```bash
sudo dpkg -i ../statshed-cli_*.deb

# Install any missing dependencies
sudo apt install -f
```

### Updating the Version

Before building a new release, update `debian/changelog`:

```bash
# Add a new changelog entry (interactive)
dch -i

# Or specify the new version directly
dch -v 1.0.3-1 "Description of changes"
```
```

## License

CC0-1.0 (Public Domain Dedication)
