python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Code Issues Releases Activity

add new functions

Browse Source
This commit is contained in:
Kelly Brazil
2022-01-26 18:05:00 -08:00
parent 74d5f60d14
commit 254c4fc507
2 changed files with 20 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/readme.md
View File

@ -58,18 +58,25 @@ modules directly:
Use `help(jc.lib)` for details: Use `help(jc.lib)` for details:
parse(parser_module_name: str, data: str | iterable) parse(parser_module_name: str, data: str | iterable)
-> dict | list[dict] | Interable[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.
get_help(parser_module_name: str) parser_info(parser_module_name: str) -> dict
Get the metadata for a particular parser.
all_parser_info() -> list[dict]
Get the metadata for all parsers.
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() -> 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() and get_help(). parse() and get_help().
plugin_parser_mod_list() plugin_parser_mod_list() -> list
Get a list of plugin parser module names. This list is a subset of Get a list of plugin parser module names. This list is a subset of
parser_mod_list(). parser_mod_list().

13
jc/__init__.py
View File

@ -54,18 +54,25 @@ modules directly:
Use `help(jc.lib)` for details: Use `help(jc.lib)` for details:
parse(parser_module_name: str, data: str | iterable) parse(parser_module_name: str, data: str | iterable)
-> dict | list[dict] | Interable[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.
get_help(parser_module_name: str) parser_info(parser_module_name: str) -> dict
Get the metadata for a particular parser.
all_parser_info() -> list[dict]
Get the metadata for all parsers.
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() -> 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() and get_help(). parse() and get_help().
plugin_parser_mod_list() plugin_parser_mod_list() -> list
Get a list of plugin parser module names. This list is a subset of Get a list of plugin parser module names. This list is a subset of
parser_mod_list(). parser_mod_list().
""" """