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.0.tar.gz
(34.5 kB
view details)
Built Distribution
apias-0.1.0-py3-none-any.whl
(23.7 kB
view details)
File details
Details for the file apias-0.1.0.tar.gz
.
File metadata
- Download URL: apias-0.1.0.tar.gz
- Upload date:
- Size: 34.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c71ce590e2fd0e6467fdaf5ce3c05f4852e6ade78580366b22b103c2f661057e |
|
MD5 | 76f258a7e97eaa47a5ade4302818538a |
|
BLAKE2b-256 | aec8c29f163569d59b4fa6d7dde53c338e0c2f37e74ec240c84b9046d9ab4bc4 |
File details
Details for the file apias-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: apias-0.1.0-py3-none-any.whl
- Upload date:
- Size: 23.7 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 | af16a60b37b565f5111f7cc8d1acef2ab49bf832d60019c354264df82cff877e |
|
MD5 | 0fb576fce591500700fe9491fa868c7c |
|
BLAKE2b-256 | 931c786e1ff81a054a4a2eed4e3dc81cd6de6a9f81dacd646c2ae780622a5bfa |