apias 0.1.17

AI powered API documentation scraper and converter

APIAS - AI Powered API Documentation Scraper

APIAS (AI Powered API Documentation Scraper) is a powerful tool that helps you extract and convert API documentation from various sources into structured formats.

Features

• Scrape API documentation from web pages
• Support for multiple documentation formats
• AI-powered content extraction and structuring
• Command-line interface for easy use
• Multiple output formats (Markdown, JSON, YAML)
• Batch processing mode with interactive TUI

Requirements

• Python 3.10 or higher (Python 3.9 is not supported)
• OpenAI API key (for AI-powered extraction)

Installation

Using uv (Recommended)

The fastest way to install APIAS is using uv:

# Install as a tool (recommended for CLI usage)
uv tool install apias --python=3.10

# Or install in a project
uv add apias

Using pip

pip install apias

Verify Python Version

python --version  # Should be 3.10 or higher

Quick Start

from apias import apias

# Basic usage
doc = apias.scrape_url("https://api.example.com/docs")
print(doc.to_markdown())

# With custom configuration
config = {
    "format": "markdown",
    "output": "api_docs.md"
}
apias.scrape_and_save("https://api.example.com/docs", config)

Command Line Usage

# Scrape documentation from a URL
apias scrape https://api.example.com/docs

# Convert to specific format
apias convert input.html --format markdown --output api_docs.md

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Security

For security issues, please see our Security Policy.

Changelog

See CHANGELOG.md for a list of changes.

Support

• Documentation: https://github.com/Emasoft/apias/docs
• Issues: https://github.com/Emasoft/apias/issues