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

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi_file_finder-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 040bab3e8411501afcd78021c7f222d73ee009d250c8e382472fca83dd474d6d
MD5 89227b7615c6cc688a7376532402a47a
BLAKE2b-256 b787bb053ddaab79ed423a93cf05a2590b62298bab9442bfdcd003a37347fa69

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_file_finder-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8ecf517bcc0ed35c88d07ce833e7083a080e25cd459afaed08f96c858bb9dba0
MD5 6b5d5c0dc7657db2cf0b0714d63a0d0e
BLAKE2b-256 baa1154772d79784031c0f8f9eb7068fad09cee615675a0601064ab97b4beb4c

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