Functions
	init (engine_settings)
	request (query, params)
	response (resp)

Variables
dict	about
bool	paging = True
list	categories = ['social media']
str	base_url = ""
str	matrix_url = "https://matrix.to"
int	page_size = 20

Detailed Description

Matrix Rooms Search - a fully-featured, standalone, matrix rooms search service.

Configuration
=============

The engine has the following mandatory settings:

- :py:obj:`base_url`

.. code:: yaml

  - name: MRS
    engine: mrs
    base_url: https://mrs-host
    ...

Implementation
==============

Function Documentation

◆ init()

searx.engines.mrs.init ( engine_settings )

The ``base_url`` must be set in the configuration, if ``base_url`` is not
set, a :py:obj:`ValueError` is raised during initialization.

Definition at line 40 of file mrs.py.

def init(engine_settings):  # pylint: disable=unused-argument
    """The ``base_url`` must be set in the configuration, if ``base_url`` is not
    set, a :py:obj:`ValueError` is raised during initialization.
 
    """
    if not base_url:
        raise ValueError('engine MRS, base_url is unset')
 
 

◆ request()

searx.engines.mrs.request	(		query,
			params )

Definition at line 49 of file mrs.py.

def request(query, params):
    params['url'] = f"{base_url}/search/{quote_plus(query)}/{page_size}/{(params['pageno']-1)*page_size}"
    return params
 
 

◆ response()

searx.engines.mrs.response ( resp )

Definition at line 54 of file mrs.py.

def response(resp):
    results = []
 
    for result in resp.json():
        results.append(
            {
                'url': matrix_url + '/#/' + result['alias'],
                'title': result['name'],
                'content': result['topic']
                + f" // {result['members']} members"
                + f" // {result['alias']}"
                + f" // {result['server']}",
                'thumbnail': result['avatar_url'],
            }
        )
 
    return results

Variable Documentation

◆ about

dict searx.engines.mrs.about

Initial value:

=  {
    "website": 'https://matrixrooms.info',
    "wikidata_id": None,
    "official_api_documentation": 'https://gitlab.com/etke.cc/mrs/api/-/blob/main/openapi.yml?ref_type=heads',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 24 of file mrs.py.

◆ base_url

str searx.engines.mrs.base_url = ""

Definition at line 35 of file mrs.py.

◆ categories

list searx.engines.mrs.categories = ['social media']

Definition at line 33 of file mrs.py.

◆ matrix_url

str searx.engines.mrs.matrix_url = "https://matrix.to"

Definition at line 36 of file mrs.py.

◆ page_size

int searx.engines.mrs.page_size = 20

Definition at line 37 of file mrs.py.

◆ paging

bool searx.engines.mrs.paging = True

Definition at line 32 of file mrs.py.

Functions

Variables