summaryrefslogtreecommitdiffstats
path: root/docs/development.rst
blob: b179de27b20c65392d3735448443e748e16f05f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Development
===========

yamllint provides both a script and a Python module. The latter can be used to
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(open("example.yaml", "r"), yaml_config):
       print(p.desc, p.line, p.rule)

.. automodule:: yamllint.linter
   :members: