Skip to main content

Add your description here

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openapi_file_finder-0.1.7.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openapi_file_finder-0.1.7-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file openapi_file_finder-0.1.7.tar.gz.

File metadata

  • Download URL: openapi_file_finder-0.1.7.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.14

File hashes

Hashes for openapi_file_finder-0.1.7.tar.gz
Algorithm Hash digest
SHA256 91101cedbdcaef3d60be0f0dd11fefb22a3286e9f1d2b0499472d1feabcd2c0f
MD5 3a52eaa169cc4e1ecf386edfa1e9d338
BLAKE2b-256 f3f85180ce5263042303d813da47786ba4694b0b40b8888a9486f200ecf97c8e

See more details on using hashes here.

File details

Details for the file openapi_file_finder-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_file_finder-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 db81c35e38dbdd98e57cc7050a6a43ab488afbbc33721c81bd0ebd3bb534380f
MD5 3ea7df3570f14a7a63b99a03c480a1e4
BLAKE2b-256 2b42912a97810db555334e356395ffd12ca8c2b202a9ee414f91161ca964c646

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page