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.2.tar.gz (36.2 kB view details)

Uploaded Source

Built Distribution

apias-0.1.2-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apias-0.1.2.tar.gz
  • Upload date:
  • Size: 36.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for apias-0.1.2.tar.gz
Algorithm Hash digest
SHA256 29855652fc77abb3ec6704fb3cf21182779bbfa0cfae768319618ca2f05653e9
MD5 d3a3e5ce4dcf0be4b6765acffd5ab34a
BLAKE2b-256 277fd35281e6b1bae932777fe8a48ac73f890d9a80826efa68b189c113d06d1c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: apias-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 24.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for apias-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0bf1a2028ace40482d102bc2abb405af72275ad8e4b13cc2c93f8d3ee4d033db
MD5 6ec23c21973dde87ab09236c6ac21461
BLAKE2b-256 77406ab95e4098dbbbee2a84574745550548f5c66534e08d5a2d36ec7745026d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page