sigil-cli 1.5.4__tar.gz → 1.5.6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. {sigil_cli-1.5.4/src/sigil_cli.egg-info → sigil_cli-1.5.6}/PKG-INFO +5 -3
  2. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/README.md +4 -2
  3. sigil_cli-1.5.6/_install/sigil +10 -0
  4. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/pyproject.toml +4 -3
  5. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/__init__.py +1 -1
  6. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/__main__.py +8 -0
  7. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/cli_tools/requirements.py +2 -2
  8. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/cli_tools/util.py +1 -1
  9. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/cli_tools/validate.py +24 -7
  10. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/datasource/__init__.py +2 -2
  11. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/datasource/json_source.py +3 -2
  12. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/datasource/yml_source.py +3 -2
  13. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/entrypoint.py +1 -1
  14. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/models/__init__.py +5 -5
  15. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/models/argument.py +3 -1
  16. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/script_sources/filesystem_script_source.py +1 -1
  17. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/stages/builder.py +2 -2
  18. {sigil_cli-1.5.4 → sigil_cli-1.5.6/src/sigil_cli.egg-info}/PKG-INFO +5 -3
  19. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil_cli.egg-info/SOURCES.txt +1 -1
  20. sigil_cli-1.5.4/src/sigil_cli.egg-info/entry_points.txt +0 -2
  21. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/LICENSE +0 -0
  22. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/setup.cfg +0 -0
  23. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/cli_tools/__init__.py +0 -0
  24. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/cli_tools/init.py +0 -0
  25. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/cli_tools/tree.py +0 -0
  26. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/datasource/datasource.py +0 -0
  27. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/datasource/helper.py +0 -0
  28. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/models/argparser.py +0 -0
  29. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/models/command.py +0 -0
  30. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/models/script.py +0 -0
  31. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/script_sources/__init__.py +0 -0
  32. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/script_sources/script_source.py +0 -0
  33. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/stages/__init__.py +0 -0
  34. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/stages/parser.py +0 -0
  35. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/stages/resolver.py +0 -0
  36. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil/stages/script_loader.py +0 -0
  37. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil_cli.egg-info/dependency_links.txt +0 -0
  38. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil_cli.egg-info/requires.txt +0 -0
  39. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/src/sigil_cli.egg-info/top_level.txt +0 -0
  40. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/tests/test_builder.py +0 -0
  41. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/tests/test_cli_init.py +0 -0
  42. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/tests/test_cli_tree.py +0 -0
  43. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/tests/test_cli_util.py +0 -0
  44. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/tests/test_cli_validate.py +0 -0
  45. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/tests/test_integration.py +0 -0
  46. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/tests/test_reader.py +0 -0
  47. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/tests/test_requirements.py +0 -0
  48. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/tests/test_resolver.py +0 -0
  49. {sigil_cli-1.5.4 → sigil_cli-1.5.6}/tests/test_scriptloader.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sigil-cli
3
- Version: 1.5.4
3
+ Version: 1.5.6
4
4
  Summary: Configuration driven CLI builder with subcommands and script loading
5
5
  Author-email: Kenzo Staelens <kenzostael@gmail.com>
6
6
  License: MIT
@@ -174,7 +174,7 @@ import argparse
174
174
  from typing import Any
175
175
 
176
176
  def run(args: argparse.Namespace, ctx: dict[str, Any]) -> None:
177
- port = getattr(args, "port", 8080)
177
+ port = getattr(args, "port", 8080) or 8080
178
178
  port = find_next_free_port_logic(port)
179
179
  print(f"Running container on port {port}")
180
180
  ```
@@ -201,6 +201,7 @@ chmod +x mycli.py
201
201
  | --- | --- |
202
202
  | `name` | Program name (used as `prog` in argparse) |
203
203
  | `script_dir` | Directory (relative to the config root) where command scripts are located |
204
+ | `known_args` | Whether to use `parse_known_args` (`true`) or `parse_args` (`false`), default `false` |
204
205
 
205
206
  > [!NOTE]
206
207
  > this section contains only sigil-specific configurations, other argparse arguments still apply
@@ -261,7 +262,8 @@ Types (`type:`) only support Python builtins
261
262
 
262
263
  Each script file must define a `def run(args: argparse.Namespace, ctx: dict[str, Any]) -> None` method.
263
264
 
264
- Args is the namespace supplied by argparse (parsed with parse_known_args). Any additional args can be found in `ctx['other_args']`.
265
+ Args is the namespace supplied by argparse (parsed with `parse_args`/`parse_known_args`).
266
+ Any additional args can be found in `ctx['other_args']` when using `parse_known_args`.
265
267
 
266
268
  Scripts run in sequence from command -> subcommand -> sub sub command -> ... and each may add to,
267
269
  remove or otherwise modify `args` and `ctx` to enrich or modify the behaviour of subsequent scripts.
@@ -140,7 +140,7 @@ import argparse
140
140
  from typing import Any
141
141
 
142
142
  def run(args: argparse.Namespace, ctx: dict[str, Any]) -> None:
143
- port = getattr(args, "port", 8080)
143
+ port = getattr(args, "port", 8080) or 8080
144
144
  port = find_next_free_port_logic(port)
145
145
  print(f"Running container on port {port}")
146
146
  ```
@@ -167,6 +167,7 @@ chmod +x mycli.py
167
167
  | --- | --- |
168
168
  | `name` | Program name (used as `prog` in argparse) |
169
169
  | `script_dir` | Directory (relative to the config root) where command scripts are located |
170
+ | `known_args` | Whether to use `parse_known_args` (`true`) or `parse_args` (`false`), default `false` |
170
171
 
171
172
  > [!NOTE]
172
173
  > this section contains only sigil-specific configurations, other argparse arguments still apply
@@ -227,7 +228,8 @@ Types (`type:`) only support Python builtins
227
228
 
228
229
  Each script file must define a `def run(args: argparse.Namespace, ctx: dict[str, Any]) -> None` method.
229
230
 
230
- Args is the namespace supplied by argparse (parsed with parse_known_args). Any additional args can be found in `ctx['other_args']`.
231
+ Args is the namespace supplied by argparse (parsed with `parse_args`/`parse_known_args`).
232
+ Any additional args can be found in `ctx['other_args']` when using `parse_known_args`.
231
233
 
232
234
  Scripts run in sequence from command -> subcommand -> sub sub command -> ... and each may add to,
233
235
  remove or otherwise modify `args` and `ctx` to enrich or modify the behaviour of subsequent scripts.
@@ -0,0 +1,10 @@
1
+ #!/usr/bin/env python3
2
+ # PYTHON_ARGCOMPLETE_OK
3
+ import sys
4
+
5
+ from sigil.__main__ import main
6
+
7
+ if __name__ == "__main__":
8
+ sys.argv[0] = sys.argv[0].removesuffix(".exe")
9
+ # your modifications here
10
+ sys.exit(main())
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "sigil-cli"
7
- version = "1.5.4"
7
+ version = "1.5.6"
8
8
  description = "Configuration driven CLI builder with subcommands and script loading"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.10"
@@ -39,8 +39,9 @@ Homepage = "https://github.com/kenzo-staelens/sigil"
39
39
  Repository = "https://github.com/kenzo-staelens/sigil"
40
40
  Issues = "https://github.com/kenzo-staelens/sigil/issues"
41
41
 
42
- [project.scripts]
43
- sigil = "sigil.__main__:main"
42
+ [tool.setuptools]
43
+ script-files = ['_install/sigil']
44
+ # sigil = "sigil.__main__:main"
44
45
 
45
46
  [tool.setuptools.packages.find]
46
47
  where = ["src"]
@@ -10,7 +10,7 @@ from .datasource import (
10
10
  try:
11
11
  from .datasource import YmlSource # noqa: F401
12
12
  yml_ok = True
13
- except ImportError:
13
+ except (ImportError, ModuleNotFoundError):
14
14
  yml_ok = False
15
15
  from .entrypoint import run_from_config
16
16
  from .models import (
@@ -1,5 +1,11 @@
1
1
  import argparse
2
2
 
3
+ try:
4
+ import argcomplete
5
+ USE_ARGCOMPLETE = True
6
+ except ImportError:
7
+ USE_ARGCOMPLETE = False
8
+
3
9
  from sigil import __version__
4
10
  from sigil.cli_tools.util import COMMAND_REGISTRY, REGISTER_CALLABLES
5
11
  from sigil.datasource import REAL_SOURCES
@@ -17,6 +23,8 @@ def main():
17
23
  sub = parser.add_subparsers(title="subcommands", dest='command')
18
24
  for fn in REGISTER_CALLABLES:
19
25
  fn(sub)
26
+ if USE_ARGCOMPLETE:
27
+ argcomplete.autocomplete(parser)
20
28
 
21
29
  args = parser.parse_args()
22
30
  if args.command not in COMMAND_REGISTRY:
@@ -19,7 +19,7 @@ def resolve_requirements(projectroot, datasource_name='YmlSource'):
19
19
  if not isinstance(parsed_data.requirements, list):
20
20
  print(
21
21
  f'requirements for {parsed_data.name}[{key}]'
22
- 'not in list format, ignoring...'
22
+ ' not in list format, ignoring...'
23
23
  )
24
24
  continue # invalid format
25
25
  reqs_list += ['',f'# {key}']
@@ -35,7 +35,7 @@ def add_sigil_requirements(command: argparse.ArgumentParser):
35
35
  default='.'
36
36
  )
37
37
  command.add_argument(
38
- '--out',
38
+ '--outfile',
39
39
  '-o',
40
40
  help="outfile",
41
41
  default='requirements.txt',
@@ -32,5 +32,5 @@ def get_datasource(name: str) -> type[DataSource]:
32
32
  if name not in REAL_SOURCES:
33
33
  # if you somehow manage to get here
34
34
  print(f'could not determine datasource {name}')
35
- sys.exit()
35
+ sys.exit(1)
36
36
  return REAL_SOURCES.get(name)
@@ -44,15 +44,19 @@ _logger = logging.getLogger(__name__)
44
44
 
45
45
 
46
46
  # actual validation logging
47
- def _validate_project(projectroot, datasource_name='YmlSource'):
47
+ def _validate_project(
48
+ projectroot,
49
+ datasource_name='YmlSource',
50
+ manifest_filename='manifest.yml'
51
+ ):
48
52
  projectpath = Path(projectroot)
49
53
 
50
- if not (projectpath/'manifest.yml').exists():
51
- _logger.error('missing manifest.yml, aborting.')
54
+ if not (projectpath/manifest_filename).exists():
55
+ _logger.error('missing manifest, aborting.')
52
56
  sys.exit(1)
53
57
 
54
58
  datasource = get_datasource(datasource_name)
55
- raw = Parser(datasource).load(projectroot)
59
+ raw = Parser(datasource).load(projectroot, manifest_filename)
56
60
 
57
61
  # these are easier for us to check
58
62
  if 'root' not in raw:
@@ -86,11 +90,19 @@ def _validate_project(projectroot, datasource_name='YmlSource'):
86
90
  # exit code wrapper
87
91
  # validation partially happens deep in the guts of sigil,
88
92
  # this caputures all validation logs, counts and converts to exit code
89
- def validate_project(projectroot, datasource_name='YmlSource'):
93
+ def validate_project(
94
+ projectroot,
95
+ datasource_name='YmlSource',
96
+ manifest_filename='manifest.yml'
97
+ ):
90
98
  package_name = __name__.split('.', 1)[0]
91
99
  with capture_package_warnings(package_name) as collector:
92
100
  try:
93
- _validate_project(projectroot, datasource_name)
101
+ _validate_project(
102
+ projectroot,
103
+ datasource_name,
104
+ manifest_filename
105
+ )
94
106
  except SystemExit: # special case to not hard exit
95
107
  pass
96
108
 
@@ -128,4 +140,9 @@ def add_sigil_validate(command: argparse.ArgumentParser):
128
140
  nargs='?',
129
141
  default='.',
130
142
  )
131
- return lambda args: validate_project(args.path, args.datasource)
143
+ command.add_argument(
144
+ '--manifest',
145
+ help="manifest filename, default 'manifest.yml'",
146
+ default='manifest.yml'
147
+ )
148
+ return lambda args: validate_project(args.path, args.datasource, args.manifest)
@@ -20,6 +20,6 @@ try:
20
20
  # any datasources with dependencies should import like this
21
21
  from .yml_source import YmlSource # noqa: F401
22
22
  REAL_SOURCES['YmlSource'] = YmlSource # known not abstract
23
- __all__.insert(0, 'YmlSource')
24
- except ImportError:
23
+ __all__.append('YmlSource')
24
+ except (ImportError, ModuleNotFoundError):
25
25
  pass
@@ -1,6 +1,7 @@
1
1
  import itertools
2
2
  import json
3
3
  import logging
4
+ import sys
4
5
  from pathlib import Path
5
6
 
6
7
  from .datasource import DataSource
@@ -21,10 +22,10 @@ class JSONSource(DataSource):
21
22
  # return yaml.load(f.read(), Loader=yaml.SafeLoader)
22
23
  except FileNotFoundError:
23
24
  _logger.error(f"file '{target}' not found")
24
- return
25
+ sys.exit(1)
25
26
  except json.JSONDecodeError as e:
26
27
  _logger.error(f"malformed json file ({target})\n {e}")
27
- return
28
+ sys.exit(1)
28
29
 
29
30
 
30
31
  def read_manifest(self, root_path: Path, filename: str) -> list | None:
@@ -1,5 +1,6 @@
1
1
  import itertools
2
2
  import logging
3
+ import sys
3
4
  from pathlib import Path
4
5
 
5
6
  import yaml
@@ -20,10 +21,10 @@ class YmlSource(DataSource):
20
21
  return yaml.load(f.read(), Loader=yaml.SafeLoader)
21
22
  except FileNotFoundError:
22
23
  _logger.error(f"file '{target}' not found")
23
- return
24
+ sys.exit(1)
24
25
  except yaml.error.YAMLError as e:
25
26
  _logger.error(f"malformed yaml file ({target})\n {e}")
26
- return
27
+ sys.exit(1)
27
28
 
28
29
 
29
30
  def read_manifest(self, root_path: Path, filename: str) -> list | None:
@@ -6,7 +6,7 @@ from .datasource import DataSource, JSONSource
6
6
  try:
7
7
  from .datasource import YmlSource
8
8
  yml_ok = True
9
- except ImportError:
9
+ except (ImportError, ModuleNotFoundError):
10
10
  yml_ok = False
11
11
  pass
12
12
  from .script_sources import FilesystemScriptSource, ScriptSource
@@ -4,9 +4,9 @@ from .command import ParserConfig
4
4
  from .script import SubcommandModule
5
5
 
6
6
  __all__ = [
7
- Argument,
8
- ArgumentGroup,
9
- LibArgParser,
10
- ParserConfig,
11
- SubcommandModule
7
+ 'Argument',
8
+ 'ArgumentGroup',
9
+ 'LibArgParser',
10
+ 'ParserConfig',
11
+ 'SubcommandModule'
12
12
  ]
@@ -58,11 +58,13 @@ class Argument:
58
58
 
59
59
  @classmethod
60
60
  def factory(cls, **kwargs: dict[str, Any]) -> 'Argument | ArgumentGroup':
61
- kind = kwargs.get('kind', 'argument') # default to argument
61
+ kind = kwargs.get('kind', 'argument')
62
62
  if kind not in ALLOWED_KINDS:
63
63
  raise ValueError(f'invalid kind {kind}')
64
64
  if kind in AGGREGATE_TYPES:
65
65
  return ArgumentGroup.factory(**kwargs)
66
+ if 'kind' in kwargs:
67
+ del kwargs['kind'] # fix explicit "kind: argument"
66
68
  name = kwargs.get('name')
67
69
  if isinstance(name, str):
68
70
  kwargs['name'] = [name] # type: ignore
@@ -1,4 +1,4 @@
1
- import importlib
1
+ import importlib.util
2
2
  import logging
3
3
  import sys
4
4
  from importlib.abc import Loader
@@ -41,8 +41,8 @@ class Builder:
41
41
  cls.attach_argument(argparser, arg)
42
42
  except Exception as e:
43
43
  _logger.error(
44
- f"unable to attach argument {arg.name}"
45
- f"to command '{subcommand.name}'\n {e}"
44
+ f"unable to attach argument {getattr(arg,'name', '?')} "
45
+ f"to command '{getattr(subcommand, 'name', '?')}'\n {e}"
46
46
  )
47
47
  # parser valid, just some args missing
48
48
  if subcommand.default:
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sigil-cli
3
- Version: 1.5.4
3
+ Version: 1.5.6
4
4
  Summary: Configuration driven CLI builder with subcommands and script loading
5
5
  Author-email: Kenzo Staelens <kenzostael@gmail.com>
6
6
  License: MIT
@@ -174,7 +174,7 @@ import argparse
174
174
  from typing import Any
175
175
 
176
176
  def run(args: argparse.Namespace, ctx: dict[str, Any]) -> None:
177
- port = getattr(args, "port", 8080)
177
+ port = getattr(args, "port", 8080) or 8080
178
178
  port = find_next_free_port_logic(port)
179
179
  print(f"Running container on port {port}")
180
180
  ```
@@ -201,6 +201,7 @@ chmod +x mycli.py
201
201
  | --- | --- |
202
202
  | `name` | Program name (used as `prog` in argparse) |
203
203
  | `script_dir` | Directory (relative to the config root) where command scripts are located |
204
+ | `known_args` | Whether to use `parse_known_args` (`true`) or `parse_args` (`false`), default `false` |
204
205
 
205
206
  > [!NOTE]
206
207
  > this section contains only sigil-specific configurations, other argparse arguments still apply
@@ -261,7 +262,8 @@ Types (`type:`) only support Python builtins
261
262
 
262
263
  Each script file must define a `def run(args: argparse.Namespace, ctx: dict[str, Any]) -> None` method.
263
264
 
264
- Args is the namespace supplied by argparse (parsed with parse_known_args). Any additional args can be found in `ctx['other_args']`.
265
+ Args is the namespace supplied by argparse (parsed with `parse_args`/`parse_known_args`).
266
+ Any additional args can be found in `ctx['other_args']` when using `parse_known_args`.
265
267
 
266
268
  Scripts run in sequence from command -> subcommand -> sub sub command -> ... and each may add to,
267
269
  remove or otherwise modify `args` and `ctx` to enrich or modify the behaviour of subsequent scripts.
@@ -1,6 +1,7 @@
1
1
  LICENSE
2
2
  README.md
3
3
  pyproject.toml
4
+ _install/sigil
4
5
  src/sigil/__init__.py
5
6
  src/sigil/__main__.py
6
7
  src/sigil/entrypoint.py
@@ -31,7 +32,6 @@ src/sigil/stages/script_loader.py
31
32
  src/sigil_cli.egg-info/PKG-INFO
32
33
  src/sigil_cli.egg-info/SOURCES.txt
33
34
  src/sigil_cli.egg-info/dependency_links.txt
34
- src/sigil_cli.egg-info/entry_points.txt
35
35
  src/sigil_cli.egg-info/requires.txt
36
36
  src/sigil_cli.egg-info/top_level.txt
37
37
  tests/test_builder.py
@@ -1,2 +0,0 @@
1
- [console_scripts]
2
- sigil = sigil.__main__:main
File without changes
File without changes