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.2.tar.gz (6.2 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.2-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for openapi_file_finder-0.1.2.tar.gz
Algorithm Hash digest
SHA256 e76c1f99ef4efc0bbaeb35bc836078abddff267e6323bfc512f7b22bb9f621c4
MD5 e72359a9da57c6f834f98faa2dcf89c1
BLAKE2b-256 8ea016a215560a387dde2f09ec203de77c86056acdd54e1e82a7a0290e7ebd17

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_file_finder-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c55c37553f9c789f06116ea54b45430187a5364654df01807e95a8ce623a721c
MD5 e50eabadd8f6e65996fde7b067a5bacd
BLAKE2b-256 9d1153c9e7182b5268e1496ec5bb1a4c177a77e8bc44a1a3073c9822df3071eb

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