"""
References:
- https://setuptools.pypa.io/en/latest/userguide/entry_point.html
- https://pip.pypa.io/en/stable/reference/pip_install
"""
import argparse
import logging
import sys
from typing import List
from docite import __version__, convert
__author__ = "danibene"
__copyright__ = "danibene"
__license__ = "MIT"
_logger = logging.getLogger(__name__)
# ---- CLI ----
# The functions defined in this section are wrappers around the main Python
# API allowing them to be called directly from the terminal as a CLI
# executable/script.
[docs]
def parse_args(args: List[str]) -> argparse.Namespace:
"""Parse command line parameters
Args:
args (List[str]): command line parameters as list of strings
(for example ``["--help"]``).
Returns:
:obj:`argparse.Namespace`: command line parameters namespace
"""
parser = argparse.ArgumentParser(description="")
parser.add_argument(
"--version",
action="version",
version=f"docite {__version__}",
)
parser.add_argument(
"--inputfile",
type=str,
required=True,
help="Input markdown file",
)
parser.add_argument(
"--outputfile",
type=str,
required=True,
help="Output markdown file",
)
parser.add_argument(
"--bibfile",
type=str,
required=True,
help="BibTeX file",
)
parser.add_argument(
"--stylefile",
type=str,
required=False,
default=None,
help="CSL style file. If not provided, the default style (IEEE) is used.",
)
parser.add_argument(
"-v",
"--verbose",
dest="loglevel",
help="set loglevel to INFO",
action="store_const",
const=logging.INFO,
)
parser.add_argument(
"-vv",
"--very-verbose",
dest="loglevel",
help="set loglevel to DEBUG",
action="store_const",
const=logging.DEBUG,
)
return parser.parse_args(args)
[docs]
def setup_logging(loglevel: int) -> None:
"""Setup basic logging
Args:
loglevel (int): minimum loglevel for emitting messages
"""
logformat = "[%(asctime)s] %(levelname)s:%(name)s:%(message)s"
logging.basicConfig(
level=loglevel, stream=sys.stdout, format=logformat, datefmt="%Y-%m-%d %H:%M:%S"
)
[docs]
def main(args: List[str]) -> None:
"""
Wrapper allowing :func:`convert_with_refs` to be called with string arguments in
a CLI fashion.
Args:
args (List[str]): command line parameters as list of strings
(for example ``["--inputfile", "input.md"]``).
"""
parsed_args = parse_args(args)
setup_logging(parsed_args.loglevel)
_logger.debug("Converting...")
print("Input file: ", parsed_args.inputfile)
print("Output file: ", parsed_args.outputfile)
print("Bib file: ", parsed_args.bibfile)
print("Style file: ", parsed_args.stylefile)
convert.convert_with_refs(
parsed_args.inputfile,
parsed_args.outputfile,
parsed_args.bibfile,
parsed_args.stylefile,
)
_logger.info("Script ends here")
[docs]
def run() -> None:
"""Calls :func:`main` passing the CLI arguments extracted from :obj:`sys.argv`
This function can be used as entry point to create console scripts with setuptools.
"""
main(sys.argv[1:])
if __name__ == "__main__":
# ^ This is a guard statement that will prevent the following code from
# being executed in the case someone imports this file instead of
# executing it as a script.
# https://docs.python.org/3/library/__main__.html
# After installing your project with pip, users can also run your Python
# modules as scripts via the ``-m`` flag, as defined in PEP 338::
#
# python -m docite.cli --help
#
run()