Metadata-Version: 2.4
Name: openapi-file-finder
Version: 0.1.4
Summary: Add your description here
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: aiofiles>=24.1.0
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: typer>=0.12.3
Requires-Dist: rich>=13.7.1
Requires-Dist: structlog>=24.1.0

# openapi-file-finder

A CLI tool and Python package to detect and locate OpenAPI/Swagger and API Blueprint specification files or annotations in PHP repositories.

## Features
- Scan repositories for OpenAPI/Swagger YAML/JSON files
- Detect swagger-php and API Blueprint annotations in PHP code
- Synchronous and asynchronous scanning
- Rich CLI output with logging

## Installation

This project uses [uv](https://github.com/astral-sh/uv) for dependency management. To install dependencies:

```bash
uv pip install -e .
```

## CLI Usage

```bash
python -m openapi_file_finder find /path/to/php/repository
python -m openapi_file_finder check-swagger-php /path/to/php/repository
python -m openapi_file_finder check-apiblueprint /path/to/php/repository
```

## As a Python Package

You can also use the core functions in your own Python scripts. See `example_usage.py` below.

## Logging

All scripts use `structlog` for structured logging.

## License

MIT
