bucket_93/python-voluptuous

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-voluptuous
   4 VERSION=                0.14.2
   5 KEYWORDS=               python
   6 VARIANTS=               v11 v12
   7 SDESC[v11]=             Python data validation library (3.11)
   8 SDESC[v12]=             Python data validation library (3.12)
   9 HOMEPAGE=               https://github.com/alecthomas/voluptuous
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/3e/21/0424844b889dccd8f1899f92f239d6eca5f4995f5c86baff094694140828
  14 DISTFILE[1]=            voluptuous-0.14.2-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[v11]=             single
  17 SPKGS[v12]=             single
  18
  19 OPTIONS_AVAILABLE=      PY311 PY312
  20 OPTIONS_STANDARD=       none
  21 VOPTS[v11]=             PY311=ON PY312=OFF
  22 VOPTS[v12]=             PY311=OFF PY312=ON
  23
  24 DISTNAME=               voluptuous-0.14.2.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY311].USES_ON=                        python:v11,wheel
  29
  30 [PY312].USES_ON=                        python:v12,wheel
  31
  32 [FILE:2653:descriptions/desc.single]
  33
  34 # CONTRIBUTIONS ONLY
  35
  36 **What does this mean?** I do not have time to fix issues myself. The only
  37 way fixes or new features will be added is by people submitting PRs.
  38
  39 **Current status:** Voluptuous is largely feature stable. There hasn't been
  40 a need to add new features in a while, but there are some bugs that should
  41 be fixed.
  42
  43 **Why?** I no longer use Voluptuous personally (in fact I no longer
  44 regularly write Python code). Rather than leave the project in a limbo of
  45 people filing issues and wondering why they're not being worked on, I
  46 believe this notice will more clearly set expectations.
  47
  48 # Voluptuous is a Python data validation library
  49
  50 [image]
  51 [image]
  52 [image]
  53 [Test status]
  54 [Coverage status]
  55 [Gitter chat]
  56
  57 Voluptuous, *despite* the name, is a Python data validation library. It
  58 is primarily intended for validating data coming into Python as JSON,
  59 YAML, etc.
  60
  61 It has three goals:
  62
  63 1. Simplicity.
  64 2. Support for complex data structures.
  65 3. Provide useful error messages.
  66
  67 ## Contact
  68
  69 Voluptuous now has a mailing list! Send a mail to
  70 [<voluptuous@librelist.com>] to subscribe. Instructions
  71 will follow.
  72
  73 You can also contact me directly via [email] or
  74 [Twitter].
  75
  76 To file a bug, create a [new issue] on GitHub with a short example of how
  77 to replicate the issue.
  78
  79 ## Documentation
  80
  81 The documentation is provided [here].
  82
  83 ## Contribution to Documentation
  84
  85 Documentation is built using `Sphinx`. You can install it by
  86
  87     pip install -r requirements.txt
  88
  89 For building `sphinx-apidoc` from scratch you need to set PYTHONPATH to
  90 `voluptuous/voluptuous` repository.
  91
  92 The documentation is provided [here.]
  93
  94 ## Changelog
  95
  96 See [CHANGELOG.md].
  97
  98 ## Why use Voluptuous over another validation library?
  99
 100 **Validators are simple callables:**
 101 No need to subclass anything, just use a function.
 102
 103 **Errors are simple exceptions:**
 104 A validator can just `raise Invalid(msg)` and expect the user to get
 105 useful messages.
 106
 107 **Schemas are basic Python data structures:**
 108 Should your data be a dictionary of integer keys to strings?
 109 `{int: str}` does what you expect. List of integers, floats or
 110 strings? `[int, float, str]`.
 111
 112 **Designed from the ground up for validating more than just forms:**
 113 Nested data structures are treated in the same way as any other
 114 type. Need a list of dictionaries? `[{}]`
 115
 116 **Consistency:**
 117 Types in the schema are checked as types. Values are compared as
 118 values. Callables are called to validate. Simple.
 119
 120 ## Show me an example
 121
 122 Twitter's [user search API] accepts
 123 query URLs like:
 124
 125 ```bash
 126 $ curl
 127 'https://api.twitter.com/1.1/users/search.json?q=python&per_page=20&page=1'
 128 ```
 129
 130 To validate this we might use a schema like:
 131
 132 ```pycon
 133
 134
 135 [FILE:113:distinfo]
 136 efc1dadc9ae32a30cc622602c1400a17b7bf8ee2770d64f70418144860739c3b        31160 voluptuous-0.14.2-py3-none-any.whl
 137