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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for openapi_file_finder-0.1.3.tar.gz
Algorithm Hash digest
SHA256 33170f055a30ccf4965ed561de73261cec3a8de1f39fc63ca91420b530c8514d
MD5 4c835320de126d465e4a00c0fc9c347c
BLAKE2b-256 f69b0c0106105666a2000f2671362d2b3a1f552e1aa1c2b301e21de8fe764967

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_file_finder-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2824f3a30f2cdfe08f87da8e2d564c0b5498e868eeef39f150279bde34196d6d
MD5 4c9f73fecdcd00813d11e22a30e00a8b
BLAKE2b-256 ea17f6ba3023a04266797ec7c0b08b15b233a491dfa8823f5120d18e003d6aef

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