diff options
| author | Andrej Shadura <andrewsh@debian.org> | 2021-01-04 09:29:54 +0100 |
|---|---|---|
| committer | Andrej Shadura <andrewsh@debian.org> | 2021-01-04 09:29:54 +0100 |
| commit | 4b1125a04c4212be50e3c01bb71a5baa1de9068f (patch) | |
| tree | 2b23c27791e373d94444ae695a43f30da2e0d19a /README.md | |
| parent | 735c78d3ecb695dd16cb37879880f522c4b29c72 (diff) | |
New upstream version 1.8.0
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 7 insertions, 17 deletions
@@ -48,21 +48,11 @@ The files can be found here and show both schema/data combinations that will wor - `tests/files/partial_schemas/` -# PyYaml and ruamel.yaml +# YAML parser -`PyYaml` is the default installed YAML parser and `ruamel.yaml` is possible to install at the same time with the following command +`ruamel.yaml` is the default YAMl parser installed with pykwalify. -```bash -pip install 'pykwalify[ruamel]' - -# or for development: - -pip install -e '.[ruamel]' -``` - -`ruamel.yaml` will however be used if both are installed because it is more up to date and includes the YAML 1.2 specification that `PyYaml` does not support. - -`PyYaml` will still be the default parser because it is used more and is still considered the default `YAML` parser in the Python world. +Ruamel.yaml is more supported in the yaml 1.2 spec and is more actively developed. Depending on how both libraries are developed, this can change in the future in any major update. @@ -70,7 +60,7 @@ Depending on how both libraries are developed, this can change in the future in ## UTF-8 and data encoding -If you have problems with unicode values not working properly when running pykwalify on Python 2.7.x then try to add this environment variable to your execution: +If you have problems with unicode values not working properly when running pykwalify on Python 3.6x then try to add this environment variable to your execution: ``` PYTHONIOENCODING=UTF-8 pykwalify ... @@ -83,11 +73,11 @@ and it might help to force UTF-8 encoding on all string objects. If this does no | | | |---|---| -| python support | 2.7, 3.5, 3.6, 3.7 | +| python support | 3.6, 3.7, 3.8, 3.9 | | Source | https://github.com/Grokzen/pykwalify | | Docs (Latest release) | http://pykwalify.readthedocs.io/en/master/ | | Docs (Unstable branch) | http://pykwalify.readthedocs.io/en/unstable/ | -| Gitter (Free Chat) | [](https://gitter.im/Grokzen/pykwalify?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | +| Gitter (Free Chat) | [](https://gitter.im/Grokzen/pykwalify?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | | Changelog | https://github.com/Grokzen/pykwalify/blob/unstable/docs/release-notes.rst | | Upgrade instructions | https://github.com/Grokzen/pykwalify/blob/unstable/docs/upgrade-instructions.rst | | Issues | https://github.com/Grokzen/pykwalify/issues | @@ -102,4 +92,4 @@ and it might help to force UTF-8 encoding on all string objects. If this does no | install stable | `pip install pykwalify` | | install dev | `$ git clone git@github.com:Grokzen/pykwalify.git pykwalify`<br>`$ cd ./pykwalify`<br>`$ virtualenv .venv`<br>`$ source .venv/bin/activate`<br>`$ pip install -r dev-requirements.txt`<br>`$ pip install -e .` | | required dependencies | `docopt >= 0.6.2`<br> `python-dateutil >= 2.4.2` | -| supported yml parsers | `PyYaml >= 3.11`<br>`ruamel.yaml >= 0.11.0` | +| supported yml parsers | `ruamel.yaml >= 0.11.0` | |