python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-13 01:20:24 +02:00
Code Issues Releases Activity

formatting

Browse Source
This commit is contained in:
Kelly Brazil
2022-03-02 15:24:18 -08:00
parent 4a1ee151b3
commit 4758e28a36
2 changed files with 20 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/readme.md
View File

@ -59,41 +59,43 @@ modules directly:
Use `help(jc.lib)` for details. Use `help(jc.lib)` for details.
### parse() ### parse
parse(parser_module_name: str, data: str | Iterable) parse(
-> dict | list[dict] | Iterable[dict] parser_module_name: str,
data: str | Iterable
) -> dict | list[dict] | Iterable[dict]
High-level API to easily access the parser. This API will find both High-level API to easily access the parser. This API will find both
built-in parsers and local plugin parsers. built-in parsers and local plugin parsers.
### parser_info() ### parser_info
parser_info(parser_module_name: str) -> dict parser_info(parser_module_name: str) -> dict
Get the metadata for a particular parser. Get the metadata for a particular parser.
### all_parser_info() ### all_parser_info
all_parser_info() -> list[dict] all_parser_info() -> list[dict]
Get the metadata for all parsers. Get the metadata for all parsers.
### get_help() ### get_help
get_help(parser_module_name: str) -> None get_help(parser_module_name: str) -> None
Convenience function to display the help screen for a parser using Convenience function to display the help screen for a parser using
its module name. its module name.
### parser_mod_list() ### parser_mod_list
parser_mod_list() -> list parser_mod_list() -> list
Get a list of all available parser module names to be used in Get a list of all available parser module names to be used in
`parse()`, `parser_info()`, and `get_help()`. `parse()`, `parser_info()`, and `get_help()`.
### plugin_parser_mod_list() ### plugin_parser_mod_list
plugin_parser_mod_list() -> list plugin_parser_mod_list() -> list

18
jc/__init__.py
View File

@ -55,41 +55,43 @@ modules directly:
Use `help(jc.lib)` for details. Use `help(jc.lib)` for details.
### parse() ### parse
parse(parser_module_name: str, data: str | Iterable) parse(
-> dict | list[dict] | Iterable[dict] parser_module_name: str,
data: str | Iterable
) -> dict | list[dict] | Iterable[dict]
High-level API to easily access the parser. This API will find both High-level API to easily access the parser. This API will find both
built-in parsers and local plugin parsers. built-in parsers and local plugin parsers.
### parser_info() ### parser_info
parser_info(parser_module_name: str) -> dict parser_info(parser_module_name: str) -> dict
Get the metadata for a particular parser. Get the metadata for a particular parser.
### all_parser_info() ### all_parser_info
all_parser_info() -> list[dict] all_parser_info() -> list[dict]
Get the metadata for all parsers. Get the metadata for all parsers.
### get_help() ### get_help
get_help(parser_module_name: str) -> None get_help(parser_module_name: str) -> None
Convenience function to display the help screen for a parser using Convenience function to display the help screen for a parser using
its module name. its module name.
### parser_mod_list() ### parser_mod_list
parser_mod_list() -> list parser_mod_list() -> list
Get a list of all available parser module names to be used in Get a list of all available parser module names to be used in
`parse()`, `parser_info()`, and `get_help()`. `parse()`, `parser_info()`, and `get_help()`.
### plugin_parser_mod_list() ### plugin_parser_mod_list
plugin_parser_mod_list() -> list plugin_parser_mod_list() -> list