Skip to main content

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 for dependency management. To install dependencies:

uv pip install -e .

CLI Usage

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

Release files for openapi-file-finder 0.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openapi-file-finder 0.1.7
File Size Uploaded
openapi_file_finder-0.1.7.tar.gz 6.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for openapi-file-finder 0.1.7
File Interpreter ABI Platform
openapi_file_finder-0.1.7-py3-none-any.whl Python 3 none any Details

Total release size: 15.2 kB

Release files / openapi_file_finder-0.1.7.tar.gz

Download URL openapi_file_finder-0.1.7.tar.gz
Size 6.3 kB
Tags Source
SHA-256 checksum
How to use checksums
91101cedbdcaef3d60be0f0dd11fefb22a3286e9f1d2b0499472d1feabcd2c0f
BLAKE2b-256 checksum
How to use checksums
f3f85180ce5263042303d813da47786ba4694b0b40b8888a9486f200ecf97c8e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.8.14

Release files / openapi_file_finder-0.1.7-py3-none-any.whl

Download URL openapi_file_finder-0.1.7-py3-none-any.whl
Size 8.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
db81c35e38dbdd98e57cc7050a6a43ab488afbbc33721c81bd0ebd3bb534380f
BLAKE2b-256 checksum
How to use checksums
2b42912a97810db555334e356395ffd12ca8c2b202a9ee414f91161ca964c646
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.8.14

Release history Release notifications | RSS feed

This release

0.1.7 This release

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page