Skip to main content

AI-powered API test and documentation generator using Gemini

Project description

ai_api_test_docs

AI-powered project tools for API testing, documentation, security auditing, and README generation using Google Gemini.

Installation

pip install ai_api_test_docs

Usage

ai_api_test_docs

Instructions

  1. Open your command-line interface (CLI).

  2. Navigate to your project's parent directory using cd. For example:

    cd path/to/your/projects/
    
  3. Run the tool:

    ai_api_test_docs
    
  4. Follow the on-screen prompts:

    • Select the target project folder.
    • Provide your Google Gemini API key when prompted.
    • Choose between generating:
      • a. API Test Writer
      • b. API Documentation Generator
      • c. CyberBackend Security Advisor
      • d. README Generator
    • Selections are made via lettered options (e.g., a, b, c, d).
  5. Let the tool generate the content for you. Output files will be saved in the selected project folder.

Delete Stored API Key

To remove your stored Gemini API key:

ai_api_test_docs delete_key

Requirements

  • Python 3.9 or higher
  • Google Gemini API key (prompted automatically on first use)

Note: This tool uses AI to generate tests, documentation, security audits, and READMEs. AI-generated content may contain mistakes or inaccuracies. Always review and verify the output before using it in production.

Function/Class/Module Description:
Performs the specified operations as described in the implementation.

Author: Ezeana Micheal
Note: This tool and documentation was created by Ezeana Micheal.

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

ai_api_test_docs-1.0.1.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_api_test_docs-1.0.1-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file ai_api_test_docs-1.0.1.tar.gz.

File metadata

  • Download URL: ai_api_test_docs-1.0.1.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.9

File hashes

Hashes for ai_api_test_docs-1.0.1.tar.gz
Algorithm Hash digest
SHA256 c83a8a47e2d01c9d30120183637dc935a2465c4e9f92e1cc7db07044443bbc6f
MD5 43256c24157b186dc27b69ddcd6d3652
BLAKE2b-256 b1dd95120aa2c80f630ba16b5f91798eb623a3a86aeb6f191f73ae8fa386e0e4

See more details on using hashes here.

File details

Details for the file ai_api_test_docs-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_api_test_docs-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 64f7d9a38a3fe5e11f00e772c92a053d0e34c6421065923fb0e16a969a260be1
MD5 000b07064356aebeb2ee146a03feecb9
BLAKE2b-256 c6e2108d725eec1a1cd1201736d11635ac72044f329e2f1223241636c4b49873

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