Reference#

rfc_lookup.command#

Command-line interface.

rfc_lookup.command.main()#

Main entry point for the CLI.

Return type:

None

rfc_lookup.constants#

Constants for the rfc_lookup package.

rfc_lookup.errors#

Exceptions for the rfc_lookup package.

exception rfc_lookup.errors.InvalidRfcIdError#

Raised when an invalid RFC ID is provided.

rfc_lookup.utilities#

Module for package utility functions.

rfc_lookup.utilities.clean_chars(text)#

Clean up special characters.

Parameters:

text (str) –

Return type:

str

rfc_lookup.utilities.extract_authors(line)#

Splits a line of author data into individual authors.

Keeps ‘Ed.’ attached to the corresponding name.

Parameters:

line (str) – A single line of author data.

Returns:

A list of individual authors.

Return type:

list

rfc_lookup.utilities.get_latest_report_ids()#

Get and parse the IETF latest reports.

Return type:

List[int]

rfc_lookup.utilities.get_request(url, params=None)#

Get the content of a web page.

Parameters:

  • url (str) –

  • params (Optional[Dict[str, str]]) –

Return type:

Any

rfc_lookup.utilities.get_rfc_report(report_id)#

Get the RFC report for a given RFC ID.

Parameters:

report_id (int) –

Return type:

str

rfc_lookup.utilities.search_rfc_editor(value)#

Search the RFC editor for RFCs by title.

Parameters:

value (str) –

Return type:

List[Dict[str, Any]]