Functions
	request (str query, params)

	response (resp)

Variables
dict	about

list	categories = ["it", "packages"]

bool	paging = True

str	search_url = "https://hex.pm/api/packages/"

str	sort_criteria = "recent_downloads"

int	page_size = 10

dict	linked_terms

Detailed Description

hex.pm

Function Documentation

◆ request()

searx.engines.hex.request	(	str	query,
			params )

Definition at line 52 of file hex.py.

def request(query: str, params):
    args = urlencode({"page": params["pageno"], "per_page": page_size, "sort": sort_criteria, "search": query})
    params["url"] = f"{search_url}?{args}"
    return params
 
 

◆ response()

searx.engines.hex.response ( resp )

Definition at line 58 of file hex.py.

def response(resp):
    results = []
    for package in resp.json():
        meta = package["meta"]
        published_date = package.get("updated_at")
        published_date = parser.parse(published_date)
        links = {linked_terms.get(k.lower(), k): v for k, v in meta.get("links").items()}
        results.append(
            {
                "template": "packages.html",
                "url": package["html_url"],
                "title": package["name"],
                "package_name": package["name"],
                "content": meta.get("description", ""),
                "version": meta.get("latest_version"),
                "maintainer": ", ".join(meta.get("maintainers", [])),
                "publishedDate": published_date,
                "license_name": ", ".join(meta.get("licenses", [])),
                "homepage": package["docs_html_url"],
                "links": links,
            }
        )
 
    return results

Variable Documentation

◆ about

dict searx.engines.hex.about

Initial value:

=  {
    # pylint: disable=line-too-long
    "website": "https://hex.pm/",
    "wikidata_id": None,
    "official_api_documentation": "https://github.com/hexpm/hexpm/blob/main/lib/hexpm_web/controllers/api/package_controller.ex",
    "use_official_api": True,
    "require_api_key": False,
    "results": "JSON",
}

Definition at line 8 of file hex.py.

◆ categories

list searx.engines.hex.categories = ["it", "packages"]

Definition at line 18 of file hex.py.

◆ linked_terms

dict searx.engines.hex.linked_terms

Initial value:

=  {
    # lower-case : replacement
    "author": "Author",
    "bitbucket": "Bitbucket",
    "bug tracker": "Issue tracker",
    "changelog": "Changelog",
    "doc": "Documentation",
    "docs": "Documentation",
    "documentation": "Documentation",
    "github repository": "GitHub",
    "github": "GitHub",
    "gitlab": "GitLab",
    "issues": "Issue tracker",
    "project source code": "Source code",
    "repository": "Source code",
    "scm": "Source code",
    "sourcehut": "SourceHut",
    "sources": "Source code",
    "sponsor": "Sponsors",
    "sponsors": "Sponsors",
    "website": "Homepage",
}

Definition at line 28 of file hex.py.

◆ page_size

int searx.engines.hex.page_size = 10

Definition at line 26 of file hex.py.

◆ paging

bool searx.engines.hex.paging = True

Definition at line 22 of file hex.py.

◆ search_url

str searx.engines.hex.search_url = "https://hex.pm/api/packages/"

Definition at line 23 of file hex.py.

◆ sort_criteria

str searx.engines.hex.sort_criteria = "recent_downloads"

Definition at line 25 of file hex.py.

Functions

Variables