readthedocs lookup

rtfm.py

import requests
from dataclasses import dataclass
import furl
from sys import argv

@dataclass
class RTDIOsearch:
    slug: str
    query: str
    def __repr__(self):
        base = "https://readthedocs.org/api/v3/search/?format=json&q="
        params = []
        params.append(f"project:{self.slug}")
        params.append(self.query)
        return base + " ".join(params)
def applyHash(url, hash):
    url.fragment.path = hash
    return url.url

def processBlocks(blocks, domain, path):
    url = furl.furl(domain)
    url.path = path
    for block in blocks:

        # if block["type"] == "section": # add if you only want the tutorial like sections and not just the api docs
           # yield {"name": block["title"], "url": applyHash(url, block["id"])}
        if block["type"] == "domain":
            yield {"name": block["name"], "url": applyHash(url, block["id"])}
        

def extract(data):
    data = data["results"] # limit to english: data = [item for item in data["results"] if item["path"].startswith("/en")]
    output = []
    for item in data:
        output.append(
            list(
                processBlocks(item["blocks"], item["domain"], item["path"])
            )
        )
    
    return output

    
def search(slug, query):
    url = RTDIOsearch(slug, query)
    print(str(url))
    data = requests.get(str(url)).json()
    return extract(data)