Skip to main content

AI powered API documentation scraper and converter

Project description

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)

Installation

pip install apias

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

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

apias-0.1.15.tar.gz (224.9 kB view details)

Uploaded Source

Built Distribution

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

apias-0.1.15-py3-none-any.whl (132.2 kB view details)

Uploaded Python 3

File details

Details for the file apias-0.1.15.tar.gz.

File metadata

  • Download URL: apias-0.1.15.tar.gz
  • Upload date:
  • Size: 224.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for apias-0.1.15.tar.gz
Algorithm Hash digest
SHA256 5d502464ed1ceea9c0226be2a260c3c790d1c4a117f03cbd57bf8bc746b8e919
MD5 1e49f5dc4166b4d0a067374924688b18
BLAKE2b-256 a7c85b7b6a33306f33c3bd42b4e39145664fba4fd86167b79e06022e948f9bdb

See more details on using hashes here.

File details

Details for the file apias-0.1.15-py3-none-any.whl.

File metadata

  • Download URL: apias-0.1.15-py3-none-any.whl
  • Upload date:
  • Size: 132.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for apias-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 133b958b56c7a6713706f5813a8bdb34fa813cdc53e5a2c88cd40c152e9ca95f
MD5 0ccfa86c3c9a5fb9725fc19f78a50dd8
BLAKE2b-256 14bc7f726d1cbdfae88ee9d9753097945a8e81a17d866f127c1fb846dac7bab6

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