spec-pilot 0.1.1

A tool to generate OpenAPI specifications using natural language

Spec-Pilot

Spec-Pilot is a command-line tool that simplifies the creation and management of OpenAPI specifications using natural language processing (NLP). With Spec-Pilot, you can easily generate, modify, and validate OpenAPI specifications without the need for complex manual editing.

• Spec-Pilot
  • Features
  • Requirements
  • Installation
  • Usage
    • Initialize a new OpenAPI project
    • Generate OpenAPI specifications
    • Run a demo
    • Modify OpenAPI specifications using natural language input
    • Validate OpenAPI specification files
  • License
  • Contributing
  • Support

Features

• Initialize a new OpenAPI project with a given project name.
• Generate OpenAPI specifications for a specified project.
• Modify OpenAPI specifications using natural language input.
• Validate OpenAPI specifications using the integrated validator.
• Simple command-line interface.

Requirements

• Python 3.6 or higher

Installation

Clone the repository to your local machine:

git clone https://github.com/jmfwolf/spec-pilot.git
cd spec-pilot

(Optional) Create a virtual environment and activate it:

python3 -m venv venv
source venv/bin/activate

Install the required Python packages:

pip install -r requirements.txt

Usage

To see the available options, run:

python spec_pilot.py --help

Initialize a new OpenAPI project

python spec_pilot.py --init project_name

Generate OpenAPI specifications

python spec_pilot.py --generate project_name

Run a demo

python spec_pilot.py --demo

Modify OpenAPI specifications using natural language input

python spec_pilot.py --nlp "Add a new endpoint /users that supports GET method"

Validate OpenAPI specification files

python spec_pilot.py --validate openapi_spec.yaml

License

Spec-Pilot is released under the GNU General Public License v3.0.

Contributing

Contributions are welcome! Please read the contributing guidelines for more information.

Support

If you have any questions, issues, or feature requests, please submit an issue.