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.4.tar.gz (7.5 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.4-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for openapi_file_finder-0.1.4.tar.gz
Algorithm Hash digest
SHA256 5304f5fd5ce1034664c4b4a6b2809cdcdd101401dd8e3dc30d4502408d3594f4
MD5 30ff0adf472e0e1e875191fb7cec8245
BLAKE2b-256 014f08dbfeac6899fb57a4546d1e6caa843ae6516382a78dd59ecf8105f4ebf6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_file_finder-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ac23c8b48c37a4d925148d4143921fd8583932eea1c05facd0ee6d4958b4d239
MD5 14a7ec9dc2ee95e2dcd9d030f72e9fef
BLAKE2b-256 2040ec80e04f07eda091d11f33a2e7c8250b114526f80abcb09630ad07e8eada

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