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

formatting

Browse Source
This commit is contained in:
Kelly Brazil
2022-03-02 10:15:01 -08:00
parent ed205f7720
commit 8c8afc1a92
2 changed files with 60 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/readme.md
View File

@ -57,29 +57,47 @@ modules directly:
## Available Functions
Use `help(jc.lib)` for details:
Use `help(jc.lib)` for details.
### parse()
parse(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
built-in parsers and local plugin parsers.
### parser_info()
parser_info(parser_module_name: str) -> dict
Get the metadata for a particular parser.
### all_parser_info()
all_parser_info() -> list[dict]
Get the metadata for all parsers.
### get_help()
get_help(parser_module_name: str) -> None
Convenience function to display the help screen for a parser using
its module name.
### parser_mod_list()
parser_mod_list() -> list
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() -> list
Get a list of plugin parser module names to be used in
parse(), parser_info(), and get_help(). This list is a subset of
parser_mod_list().
Get a list of plugin parser module names to be used in
`parse()`, `parser_info()`, and `get_help()`. This list is a subset of
`parser_mod_list()`.

26
jc/__init__.py
View File

@ -53,31 +53,49 @@ modules directly:
## Available Functions
Use `help(jc.lib)` for details:
Use `help(jc.lib)` for details.
### parse()
parse(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
built-in parsers and local plugin parsers.
### parser_info()
parser_info(parser_module_name: str) -> dict
Get the metadata for a particular parser.
### all_parser_info()
all_parser_info() -> list[dict]
Get the metadata for all parsers.
### get_help()
get_help(parser_module_name: str) -> None
Convenience function to display the help screen for a parser using
its module name.
### parser_mod_list()
parser_mod_list() -> list
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() -> list
Get a list of plugin parser module names to be used in
parse(), parser_info(), and get_help(). This list is a subset of
parser_mod_list().
`parse()`, `parser_info()`, and `get_help()`. This list is a subset of
`parser_mod_list()`.
"""
from .lib import (__version__, parse, parser_mod_list, plugin_parser_mod_list,
parser_info, all_parser_info, get_help)