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.5.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.5-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for openapi_file_finder-0.1.5.tar.gz
Algorithm Hash digest
SHA256 1061e908f1d79bce85243764a49b20ff8a1b9f4c5821d58136b271bf3e7ed0f8
MD5 119e48aacf5976023355a8b29cf8bab1
BLAKE2b-256 16ecf5e8804ab64db6a250f2a9be6ec54cb0673149c4f18cc6ba85927c1de4d2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_file_finder-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5d265310ad1e79f8d71e58b10eccdd826c5f0db877e1d5a0f924ab3c1f7aff33
MD5 7784f4263ebfb622dbb67bc253066a09
BLAKE2b-256 3b3b89f4142c4440f4636cb78a4f94b7d7bdb588e31b3d2a956099f823cef206

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