1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
#!/usr/bin/env python3
# coding=utf-8
"""MILC - A CLI Framework
PYTHON_ARGCOMPLETE_OK
MILC is an opinionated framework for writing CLI apps. It optimizes for the
most common unix tool pattern- small tools that are run from the command
line and generally do not feature any user interaction while they run.
For more details see the MILC documentation:
<https://github.com/clueboard/milc/tree/master/docs>
"""
__VERSION__ = '1.9.1'
import logging
import os
import sys
import warnings
from typing import Any, Optional
from .emoji import EMOJI_LOGLEVELS
from .milc import MILC
from .milc_interface import MILCInterface
if 'MILC_IGNORE_DEPRECATED' not in os.environ:
for name in ('MILC_APP_NAME', 'MILC_APP_VERSION', 'MILC_APP_AUTHOR'):
if name in os.environ:
warnings.warn(f'Using environment variable {name} is deprecated and will not be supported in the future, please use cli.milc_options() instead.', stacklevel=2)
cli = MILCInterface()
def set_metadata(
*,
name: Optional[str] = None,
author: Optional[str] = None,
version: Optional[str] = None,
logger: Optional[logging.Logger] = None,
) -> MILCInterface:
"""Set metadata about your program.
Deprecated: Use `cli.milc_options()` instead.
This allows you to set the application's name, version, and/or author
before executing your entrypoint. You can also pass your own logger here
if you like.
It's best to run this only once, and it must be run before you call `cli()`.
"""
warnings.warn("milc.set_metadata has been deprecated, please use cli.milc_options() instead.", stacklevel=2)
cli.milc_options(name=name, author=author, version=version, logger=logger)
return cli
# Extra stuff people can import
from ._sparkline import sparkline # noqa
|
