bucket_C8/python-jsonargparse

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-jsonargparse
   4 VERSION=                4.23.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/76/cb/46990ca2a355ec970565686f2e4fca919839b3b9023c96fb55b966796047
  14 DISTFILE[1]=            jsonargparse-4.23.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.23.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:3406:descriptions/desc.single]
  35
  36
  37 jsonargparse
  38 ============
  39
  40 Docs: https://jsonargparse.readthedocs.io/ | Source:
  41 https://github.com/omni-us/jsonargparse/
  42
  43 This package is an extension to python's argparse which simplifies parsing
  44 of
  45 configuration options from command line arguments, json configuration files
  46 ([yaml] or [jsonnet] supersets),
  47 environment variables and hard-coded defaults.
  48
  49 The aim is similar to other projects such as [configargparse
  50 ], [yconf
  51 ], [confuse
  52 ], [typer
  53 ], [OmegaConf
  54 ], [Fire
  55 ] and [click
  56 ]. The obvious question is, why yet another
  57 package similar to many already existing ones? The answer is simply that
  58 none of
  59 the existing projects had the exact features we wanted and after analyzing
  60 the
  61 alternatives it seemed simpler to start a new project.
  62
  63 Features
  64 ========
  65
  66 - Great support of type hints for automatic creation of parsers and minimal
  67   boilerplate command line interfaces.
  68
  69 - Non-intrusive/decoupled parsing logic. No need to inherit from a special
  70 class
  71   or add decorators or use custom type hints.
  72
  73 - Easy to implement configurable dependency injection (object composition).
  74
  75 - Support for nested namespaces making possible to parse config files with
  76   non-flat hierarchies.
  77
  78 - Parsing of relative paths within config files and path lists.
  79
  80 - Support for json, yaml, jsonnet and extendible to more.
  81
  82 - Parsers can be configured just like with python's argparse, thus it has a
  83   gentle learning curve.
  84
  85 - Several convenient types and action classes to ease common parsing use
  86 cases
  87   (paths, comparison operators, json schemas, regex strings, ...).
  88
  89 - Support for command line tab argument completion using [argcomplete
  90  ].
  91
  92 .. _installation:
  93
  94 Installation
  95 ============
  96
  97 You can install using [pip] as:
  98
  99 .. code-block:: bash
 100
 101     pip install jsonargparse
 102
 103 By default the only dependency that jsonargparse installs is [PyYAML
 104 ]. However, several optional features can be
 105 enabled by specifying any of the following extras requires: signatures,
 106 jsonschema, jsonnet, urls, argcomplete and reconplogger.
 107 There is also the all extras require to enable all optional features.
 108 Installing jsonargparse with extras require is as follows:
 109
 110 .. code-block:: bash
 111
 112     pip install "jsonargparse[signatures,urls]"  # Enable signatures and
 113 URLs features
 114     pip install "jsonargparse[all]"              # Enable all optional
 115 features
 116
 117 The following table references sections that describe optional features and
 118 the
 119 corresponding extras requires that enables them.
 120
 121 +-----------------------------+-------------+-------------+---------+------------+------------+
 122 |                             | urls/fsspec | argcomplete | jsonnet |
 123 jsonschema | signatures |
 124 +-----------------------------+-------------+-------------+---------+------------+------------+
 125 | `classes-methods-functions` |             |             |         |
 126      | ✓          |
 127 +-----------------------------+-------------+-------------+---------+------------+------------+
 128 | `parsing-urls`              | ✓           |             |         |
 129        |            |
 130 +-----------------------------+-------------+-------------+---------+------------+------------+
 131 | `json-schemas`              |             |             |         | ✓
 132        |            |
 133 +-----------------------------+-------------+-------------+---------+------------+------------+
 134 | `jsonnet-files`             |             |             | ✓       |
 135
 136
 137 [FILE:115:distinfo]
 138 225a401cb0e0ed8ed65f4557f8cc70b3a53d8aaf98c8676dd32cb9556794d406       199118 jsonargparse-4.23.1-py3-none-any.whl
 139