NuKVM/yamllint
3
0
Fork 0
mirror of https://github.com/adrienverge/yamllint.git synced 2025-02-25 18:55:20 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add Python API usage example

Browse Source 
Fixes: #297
This commit is contained in:
Sorin Sbarnea 2020-08-25 19:10:32 +01:00 committed by GitHub
parent 8da98f2122
commit d274543b72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/development.rst
View File

@ -2,7 +2,17 @@ Development
=========== ===========
yamllint provides both a script and a Python module. The latter can be used to yamllint provides both a script and a Python module. The latter can be used to
write your own linting tools: write your own linting tools.
Basic example of running the linter from Python:
.. code-block:: python
import yamllint
yaml_config = yamllint.config.YamlLintConfig("extends: default")
for p in yamllint.linter.run("example.yaml", yaml_config):
print(p.desc, p.line, p.rule)
.. automodule:: yamllint.linter .. automodule:: yamllint.linter
:members: :members: