bucket_C8/python-jsonargparse

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-jsonargparse
   4 VERSION=                4.21.1
   5 KEYWORDS=               python
   6 VARIANTS=               py310 v11
   7 SDESC[py310]=           JSON argument and config file parser (3.10)
   8 SDESC[v11]=             JSON argument and config file parser (3.11)
   9 HOMEPAGE=               none
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/db/26/bd50729ce4423f59f1eab3db2526fbaf4677ac9f49fc0d19ffc1308adc3b
  14 DISTFILE[1]=            jsonargparse-4.21.1-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[py310]=           single
  17 SPKGS[v11]=             single
  18
  19 OPTIONS_AVAILABLE=      PY310 PY311
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py310]=           PY310=ON PY311=OFF
  22 VOPTS[v11]=             PY310=OFF PY311=ON
  23
  24 DISTNAME=               jsonargparse-4.21.1.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY310].RUN_DEPENDS_ON=                 python-PyYAML:single:py310
  29 [PY310].USES_ON=                        python:py310,wheel
  30
  31 [PY311].RUN_DEPENDS_ON=                 python-PyYAML:single:v11
  32 [PY311].USES_ON=                        python:v11,wheel
  33
  34 [FILE:3387:descriptions/desc.single]
  35
  36
  37 jsonargparse
  38 ============
  39
  40 https://github.com/omni-us/jsonargparse/
  41
  42 This package is an extension to python's argparse which simplifies parsing
  43 of
  44 configuration options from command line arguments, json configuration files
  45 ([yaml] or [jsonnet] supersets),
  46 environment variables and hard-coded defaults.
  47
  48 The aim is similar to other projects such as [configargparse
  49 ], [yconf
  50 ], [confuse
  51 ], [typer
  52 ], [OmegaConf
  53 ], [Fire
  54 ] and [click
  55 ]. The obvious question is, why yet another
  56 package similar to many already existing ones? The answer is simply that
  57 none of
  58 the existing projects had the exact features we wanted and after analyzing
  59 the
  60 alternatives it seemed simpler to start a new project.
  61
  62 Features
  63 ========
  64
  65 - Great support of type hints for automatic creation of parsers and minimal
  66   boilerplate command line interfaces.
  67
  68 - Non-intrusive/decoupled parsing logic. No need to inherit from a special
  69 class
  70   or add decorators or use custom type hints.
  71
  72 - Easy to implement configurable dependency injection (object composition).
  73
  74 - Support for nested namespaces making possible to parse config files with
  75   non-flat hierarchies.
  76
  77 - Parsing of relative paths within config files and path lists.
  78
  79 - Support for two popular supersets of json: yaml and jsonnet.
  80
  81 - Parsers can be configured just like with python's argparse, thus it has a
  82   gentle learning curve.
  83
  84 - Several convenient types and action classes to ease common parsing use
  85 cases
  86   (paths, comparison operators, json schemas, enums, regex strings, ...).
  87
  88 - Support for command line tab argument completion using [argcomplete
  89  ].
  90
  91 .. _installation:
  92
  93 Installation
  94 ============
  95
  96 You can install using [pip] as:
  97
  98 .. code-block:: bash
  99
 100     pip install jsonargparse
 101
 102 By default the only dependency that jsonargparse installs is [PyYAML
 103 ]. However, several optional features can be
 104 enabled by specifying any of the following extras requires: signatures,
 105 jsonschema, jsonnet, urls, argcomplete and reconplogger.
 106 There is also the all extras require to enable all optional features.
 107 Installing jsonargparse with extras require is as follows:
 108
 109 .. code-block:: bash
 110
 111     pip install "jsonargparse[signatures,urls]"  # Enable signatures and
 112 URLs features
 113     pip install "jsonargparse[all]"              # Enable all optional
 114 features
 115
 116 The following table references sections that describe optional features and
 117 the
 118 corresponding extras requires that enables them.
 119
 120 +-----------------------------+-------------+-------------+---------+------------+------------+
 121 |                             | urls/fsspec | argcomplete | jsonnet |
 122 jsonschema | signatures |
 123 +-----------------------------+-------------+-------------+---------+------------+------------+
 124 | `classes-methods-functions` |             |             |         |
 125      | ✓          |
 126 +-----------------------------+-------------+-------------+---------+------------+------------+
 127 | `parsing-urls`              | ✓           |             |         |
 128        |            |
 129 +-----------------------------+-------------+-------------+---------+------------+------------+
 130 | `json-schemas`              |             |             |         | ✓
 131        |            |
 132 +-----------------------------+-------------+-------------+---------+------------+------------+
 133 | `jsonnet-files`             |             |             | ✓       |
 134        |            |
 135
 136
 137 [FILE:115:distinfo]
 138 dffb6a446d2a7d3b78288489b406d77f5bf83c9ea10e7cfce43a1029fbbde313       191410 jsonargparse-4.21.1-py3-none-any.whl
 139