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.16.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.16-py3-none-any.whl (132.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apias-0.1.16.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.16.tar.gz
Algorithm Hash digest
SHA256 d543af6119438196297187d2ce7fac4a30ba2534a7c2a99c33ae36fe7e134601
MD5 d3af2d18c0b0ed5f2747b3aecbaa7ee9
BLAKE2b-256 f43d0760f238ad65cd617fad2799474f077f24b5f143cd08107298af534d401e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: apias-0.1.16-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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 5223573fabc5f043c3272c23e246c682c2a79a1f64ec72d9449c62e30eae519c
MD5 e647e86990f9ba55d444d02e83509401
BLAKE2b-256 792824214c6f026634ca4c7e6f430807b752e0b1c8a0032827aaf465283b0775

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