Skip to main content

AI-Powered API Management CLI

Project description

Devkool: AI-Powered API Management CLI

Devkool is a command-line interface (CLI) tool designed to help developers efficiently manage, test, and interact with APIs. It leverages AI for enhanced test case generation and provides features for tracking untracked APIs in your codebase. Devkool aims to streamline the API development workflow and improve developer productivity.

Features

  • Secure API Storage: API keys and endpoints are securely stored using encryption.
  • AI-Powered Test Case Generation: Generates test case descriptions from API specifications (OpenAPI/Swagger).
  • Untracked API Detection: Scans your codebase to identify API endpoints that are being used but are not yet tracked by Devkool.
  • CLI Interface: Easy-to-use command-line interface for all functionalities.

Installation

  1. Clone the Repository:

    git clone [https://github.com/](https://github.com/)<your_username>/devkool.git  # Replace with your repo URL
    cd devkool
    
  2. Create a Virtual Environment (Recommended):

    python3 -m venv venv  # Create a virtual environment
    source venv/bin/activate  # Activate the environment (Linux/macOS)
    venv\Scripts\activate  # Activate the environment (Windows)
    
  3. Install Devkool:

    pip install -e .
    

Configuration

Encryption Key

Devkool uses encryption to secure stored API keys and endpoints. It's crucial to set a strong encryption key.

  1. Generate a Key:

    • Linux/macOS:

      export DEVKOOL_KEY=$(python3 -c "import base64; import os; print(base64.b64encode(os.urandom(32)).decode('utf-8'))")
      
    • Windows (PowerShell):

      $env:DEVKOOL_KEY = [Convert]::ToBase64String((New-Object System.Security.Cryptography.RNGCryptoServiceProvider).GetBytes(32))
      
  2. Set the Environment Variable:

    • Linux/macOS: Add the export DEVKOOL_KEY=... command (the one from step 1) to your shell's configuration file (e.g., ~/.bashrc, ~/.zshrc, ~/.profile). This will make the environment variable persistent across terminal sessions. Then source the configuration file using source ~/.zshrc or restart your terminal.
    • Windows:
      • Search for "Environment Variables" in the Windows search bar.
      • Click "Edit the system environment variables."
      • In the System Properties window, click "Environment Variables..."
      • Create a new system or user variable named DEVKOOL_KEY and paste the generated key as the value.

Usage

Adding an API

devkool add <api_key> <endpoint>

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

devkool-0.1.1.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

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

devkool-0.1.1-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file devkool-0.1.1.tar.gz.

File metadata

  • Download URL: devkool-0.1.1.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for devkool-0.1.1.tar.gz
Algorithm Hash digest
SHA256 16472e83874ba2fbaba60cd29347c6279fb4796dc7bbdcb6d51301a5bca968f3
MD5 e2fc46eae7079a2877b3d4bf20c3f936
BLAKE2b-256 8929edf4bd79de24ab138f307ae7c030e4ded35e35fc258f48c44a2f68704fa4

See more details on using hashes here.

File details

Details for the file devkool-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: devkool-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for devkool-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5e7f316fd783bd2eb7672f003420314dee58e1186754d02bcc29bf97c10c43b8
MD5 847c376e5931c16cad6ae462c7275688
BLAKE2b-256 fdbc4138209aca34f8e352d0271db1ded036ba5ec6e9262ac2ab4a68b1d6b392

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