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
- Documentation: https://github.com/Emasoft/apias/docs
- Issues: https://github.com/Emasoft/apias/issues
Project details
Release history Release notifications | RSS feed
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.4.tar.gz
(37.2 kB
view details)
Built Distribution
apias-0.1.4-py3-none-any.whl
(24.8 kB
view details)
File details
Details for the file apias-0.1.4.tar.gz
.
File metadata
- Download URL: apias-0.1.4.tar.gz
- Upload date:
- Size: 37.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd0d8f2387794d1dee3520d91d443070074c212eace0a8490146230bf16adf7c |
|
MD5 | 941886c64dbbb97af32ee9a28bd93418 |
|
BLAKE2b-256 | fada66c911201d3fcf77e1fc1fa56c8eb06a2444d1d8580d5ba8b6539213e590 |
File details
Details for the file apias-0.1.4-py3-none-any.whl
.
File metadata
- Download URL: apias-0.1.4-py3-none-any.whl
- Upload date:
- Size: 24.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40253270743d902e17208f84ce3a639b88f9fee464ffc2537c2e1ec1dc24af91 |
|
MD5 | ac03adda0cdac02f4f06eb9a24073c59 |
|
BLAKE2b-256 | 38844a18697cb9e9fbe29034b12a622d0f70f86332fd57fb9af15b3bfab51915 |