Metadata-Version: 2.4
Name: ossguard
Version: 0.1.3a1
Summary: One-command CLI to guard any OSS project with OpenSSF security best practices — bootstrap, scan, and monitor.
Author: OSSGuard Contributors
License: Apache-2.0
Project-URL: Homepage, https://github.com/kirankotari/ossguard
Project-URL: Repository, https://github.com/kirankotari/ossguard-python
Project-URL: Issues, https://github.com/kirankotari/ossguard-python/issues
Keywords: openssf,security,supply-chain,scorecard,slsa,sbom,ossguard
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer[all]>=0.9.0
Requires-Dist: rich>=13.0.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: jinja2>=3.1.0
Requires-Dist: questionary>=2.0.0
Requires-Dist: httpx>=0.27.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Dynamic: license-file

# OSSGuard — Python Implementation

**The reference Python implementation of [OSSGuard](https://github.com/kirankotari/ossguard).**

[![CI](https://github.com/kirankotari/ossguard-python/actions/workflows/ci.yml/badge.svg)](https://github.com/kirankotari/ossguard-python/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/ossguard)](https://pypi.org/project/ossguard/)
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
[![Python 3.9+](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/)

> For full documentation, all install methods, and command examples, see the main [ossguard](https://github.com/kirankotari/ossguard) repo.

## Install

```bash
pip install ossguard

# Or with pipx (isolated install)
pipx install ossguard
```

## Quick Start

```bash
ossguard scan .       # Quick security posture check
ossguard audit .      # Full security audit
ossguard init .       # Bootstrap all OpenSSF configs
ossguard baseline .   # OSPS Baseline compliance
```

## Features

This is the **reference implementation** with the richest UI (Rich tables, colored panels, interactive prompts).

- **27 commands** covering the full OpenSSF security lifecycle
- **Rich terminal UI** with tables, panels, and progress indicators
- **Auto-detection** of languages, package managers, and frameworks
- **Python 3.9+** with dependencies: typer, rich, pyyaml, jinja2, questionary, httpx

For the complete command reference and real-world output examples, see the main [ossguard](https://github.com/kirankotari/ossguard) README.

## Other Implementations

| Implementation | Install | Best for |
|---------------|---------|----------|
| **[ossguard-go](https://github.com/kirankotari/ossguard-go)** | `brew install kirankotari/tap/ossguard` | CI pipelines, single binary |
| **[ossguard-npm](https://github.com/kirankotari/ossguard-npm)** | `npx ossguard` | Node.js projects |

## Development

```bash
# Clone and install
git clone https://github.com/kirankotari/ossguard-python.git
cd ossguard-python
pip install -e ".[dev]"

# Run tests (147 tests)
pytest

# Lint
ruff check src/ tests/
```

## Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

## License

Apache-2.0 — see [LICENSE](LICENSE) for details.
