build: add PEP-517 build config with Poetry

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+import-order-style = pep8
+application-import-names = yamllint
+ignore = W503,W504

.github/workflows/ci.yaml

@@ -53,8 +53,10 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Append GitHub Actions system path
         run: echo "$HOME/.local/bin" >> $GITHUB_PATH
-      - run: pip install coveralls
+      - run: pip install coverage[toml]
       - run: pip install .
       - run: coverage run --source=yamllint -m unittest discover
+      # https://github.com/AndreMiras/coveralls-python-action/issues/18
+      - run: echo -e "[run]\nrelative_files = True" > .coveragerc
       - name: Coveralls
         uses: AndreMiras/coveralls-python-action@develop

docs/conf.py

@@ -7,7 +7,7 @@
 
 sys.path.insert(0, os.path.abspath('..'))
 
-from yamllint import __copyright__, APP_NAME, APP_VERSION  # noqa
+from yamllint import __copyright__, APP_NAME, __version__  # noqa
 
 # -- General configuration ------------------------------------------------
 
@@ -22,8 +22,8 @@
 project = APP_NAME
 copyright = __copyright__.lstrip('Copyright ')
 
-version = APP_VERSION
-release = APP_VERSION
+version = __version__
+release = __version__
 
 pygments_style = 'sphinx'
 

docs/quickstart.rst

@@ -45,7 +45,7 @@ If you prefer installing from source, you can run, from the source directory:
 
 .. code:: bash
 
- python setup.py sdist
+ poetry build
  pip install --user dist/yamllint-*.tar.gz
 
 Running yamllint

pyproject.toml

@@ -0,0 +1,50 @@
+[tool.poetry]
+name = "yamllint"
+version = "1.30.0"
+description = ""
+authors = ["Adrien Vergé"]
+license = "GPLv3"
+readme = "README.rst"
+homepage = "https://github.com/adrienverge/yamllint"
+repository = "https://github.com/adrienverge/yamllint"
+documentation = "https://yamllint.readthedocs.io"
+keywords = ["yaml", "lint", "linter", "syntax", "checker"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Software Development",
+    "Topic :: Software Development :: Debuggers",
+    "Topic :: Software Development :: Quality Assurance",
+    "Topic :: Software Development :: Testing",
+]
+include = ["docs/*", "tests/*.py", "tests/rules/*.py", "tests/yaml-1.2-spec-examples/*"]
+
+[tool.poetry.urls]
+Download = "https://pypi.org/project/yamllint/#files"
+
+[tool.poetry.dependencies]
+python = ">=3.7"
+pathspec = ">=0.5.3"
+pyyaml = ">=6.0"
+importlib-metadata = { version = ">=4.10.0", python = "<3.8" }
+
+[tool.poetry.group.dev.dependencies]
+flake8 = {version = ">=6.0.0", python = ">=3.8.1"}
+
+[tool.poetry.scripts]
+yamllint = "yamllint.cli:run"
+
+[tool.coverage.run]
+relative_files = true
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

yamllint/__init__.py

@@ -19,12 +19,12 @@
 repetition and cosmetic problems such as lines length, trailing spaces,
 indentation, etc."""
 
+from importlib import metadata
 
 APP_NAME = 'yamllint'
-APP_VERSION = '1.30.0'
 APP_DESCRIPTION = __doc__
 
 __author__ = 'Adrien Vergé'
 __copyright__ = 'Copyright 2022, Adrien Vergé'
 __license__ = 'GPLv3'
-__version__ = APP_VERSION
+__version__ = metadata.version('yamllint')

yamllint/cli.py

@@ -19,7 +19,7 @@
 import platform
 import sys
 
-from yamllint import APP_DESCRIPTION, APP_NAME, APP_VERSION
+from yamllint import APP_DESCRIPTION, APP_NAME, __version__
 from yamllint import linter
 from yamllint.config import YamlLintConfig, YamlLintConfigError
 from yamllint.linter import PROBLEM_LEVELS
@@ -171,7 +171,7 @@ def run(argv=None):
                         action='store_true',
                         help='output only error level problems')
     parser.add_argument('-v', '--version', action='version',
-                        version='{} {}'.format(APP_NAME, APP_VERSION))
+                        version='{} {}'.format(APP_NAME, __version__))
 
     args = parser.parse_args(argv)