pyproject.toml

[project]
name = "pelican"
authors = [{ name = "Justin Mayer", email = "authors@getpelican.com" }]
description = "Static site generator supporting Markdown and reStructuredText"
version = "4.10.1"
license = { text = "AGPLv3" }
readme = "README.rst"
keywords = ["static site generator", "static sites", "ssg"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Environment :: Console",
    "Framework :: Pelican",
    "Intended Audience :: End Users/Desktop",
    "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: Implementation :: CPython",
    "Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System",
    "Topic :: Internet :: WWW/HTTP :: Site Management",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Text Processing :: Markup :: Markdown",
    "Topic :: Text Processing :: Markup :: HTML",
    "Topic :: Text Processing :: Markup :: reStructuredText",
]
requires-python = ">=3.8.1,<4.0"
dependencies = [
    "blinker>=1.7.0",
    "docutils>=0.20.1",
    "feedgenerator>=2.1.0",
    "jinja2>=3.1.2",
    "ordered-set>=4.1.0",
    "pygments>=2.16.1",
    "python-dateutil>=2.8.2",
    "rich>=13.6.0",
    "unidecode>=1.3.7",
    "backports-zoneinfo>=0.2.1; python_version < \"3.9\"",
    "watchfiles>=0.21.0",
    "tzdata; sys_platform == 'win32'",
]

[project.optional-dependencies]
markdown = ["markdown>=3.1"]

[project.urls]
Homepage = "https://getpelican.com"
Funding = "https://donate.getpelican.com/"
"Issue Tracker" = "https://github.com/getpelican/pelican/issues"
Repository = "https://github.com/getpelican/pelican"
Documentation = "https://docs.getpelican.com"

[project.scripts]
pelican = "pelican.__main__:main"
pelican-import = "pelican.tools.pelican_import:main"
pelican-plugins = "pelican.plugins._utils:list_plugins"
pelican-quickstart = "pelican.tools.pelican_quickstart:main"
pelican-themes = "pelican.tools.pelican_themes:main"

[tool.autopub]
project-name = "Pelican"
git-username = "botpub"
git-email = "52496925+botpub@users.noreply.github.com"
changelog-file = "docs/changelog.rst"
changelog-header = "###############"
version-header = "="

[tool.pdm]
ignore_package_warnings = ["sphinx"]

[tool.pdm.scripts]
docbuild = "invoke docbuild"
docserve = "invoke docserve"
lint = "invoke lint"
test = "invoke tests"

[tool.pdm.dev-dependencies]
dev = [
    "BeautifulSoup4>=4.12.2",
    "jinja2>=3.1.2",
    "lxml>=4.9.3",
    "markdown>=3.5.1",
    "typogrify>=2.0.7",
    "sphinx>=7.1.2",
    "sphinxext-opengraph>=0.9.0",
    "furo==2023.9.10",
    "livereload>=2.6.3",
    "psutil>=5.9.6",
    "pygments>=2.16.1",
    "pytest>=7.4.3",
    "pytest-cov>=4.1.0",
    "pytest-sugar>=0.9.7",
    "pytest-xdist>=3.4.0",
    "tox>=4.11.3",
    "invoke>=2.2.0",
    # ruff version should match the one in .pre-commit-config.yaml
    "ruff==0.7.2",
    "tomli>=2.0.1; python_version < \"3.11\"",
]

[tool.pdm.build]
source-includes = [
    "CONTRIBUTING.rst",
    "THANKS",
    "docs/changelog.rst",
    "samples/",
]

[build-system]
requires = ["pdm-backend"]
build-backend = "pdm.backend"


[tool.ruff.lint]
# see https://docs.astral.sh/ruff/configuration/#using-pyprojecttoml
# "F" contains autoflake, see https://github.com/astral-sh/ruff/issues/1647
# add more rules
select = [
    # default Ruff checkers as of ruff 0.1.3: E4, E7, E9, F
    "E4",
    "E7",
    "E9",
    "F",  # pyflakes

    # the rest in alphabetical order:
    # TODO: "A",   # flake8-builtins
    # TODO: "ARG", # flake8-unused-arguments
    "B",   # flake8-bugbear
    # TODO: "BLE", # flake8-blind-except
    # TODO: Do I want "COM", # flake8-commas
    "C4",  # flake8-comprehensions
    # TODO: "DJ",  # flake8-django
    # TODO: "DTZ", # flake8-datetimez
    # TODO: "EM",  # flake8-errmsg
    "EXE", # flake8-executable
    # TODO: "FURB", # refurb
    # TODO: "FBT", # flake8-boolean-trap
    # TODO: "G",   # flake8-logging-format
    "I",   # isort
    "ICN", # flake8-import-conventions
    "INP", # flake8-no-pep420
    # TODO: "INT", # flake8-gettext
    "ISC", # flake8-implicit-str-concat
    # TODO: "LOG", # flake8-logging
    "PERF", # perflint
    "PIE", # flake8-pie
    "PL",  # pylint
    "PYI", # flake8-pyi
    # TODO: "RET", # flake8-return
    "RSE", # flake8-raise
    "RUF",
    # TODO: "SIM", # flake8-simplify
    "SLF", # flake8-self
    "SLOT", # flake8-slots
    "TID", # flake8-tidy-imports
    "UP",  # pyupgrade
    "Q",   # flake8-quotes
    "TCH", # flake8-type-checking
    "T10", # flake8-debugger
    "T20", # flake8-print
    # TODO: "S",   # flake8-bandit
    "YTT", # flake8-2020
    # TODO: add more flake8 rules
  ]

ignore = [
    # suppression in order of # of violations in Dec 2023:
    "PLW2901",  # redefined-loop-name
    "SLF001",  # private-member-access
    "PLR0912",  # too-many-branches
    "PLR0913",  # too-many-arguments
    # RUF005: this is a different style of concatenating literals.  It perhaps performs
    # a bit better, but doesn't seem any more readable to me.  So, ignore it.
    "RUF005",  # collection-literal-concatenation
    # TODO: several classes have class variables.  If that is correct, we should
    #   annotate them with ClassVar.
    # See https://docs.astral.sh/ruff/rules/mutable-class-default/
    "RUF012",  # mutable-class-default
    "PLR0915",  # too-many-statements
    # Note: we have a couple of "namespace packages" (i.e. missing __init__.py)
    # Not sure if we should add __init__.py to them, or they really need to be
    # namespace packages.
    "INP001",  # implicit-namespace-package
    # ruff-format wants us to ignore ISC001.  I don't love that, but okay.
    # "warning: The following rules may cause conflicts when used with the formatter:
    #  `ISC001`. To avoid unexpected behavior, we recommend disabling these rules,
    #  either by removing them from the `select` or `extend-select` configuration,
    #  or adding them to the `ignore` configuration."
    "ISC001",  # single-line-implicit-string-concatenation
    # PERF203 has minimal performance impact, and you have to catch the exception
    # inside the loop if you want to ignore it, so let's ignore PERF203.
    "PERF203",  # try-except-in-loop
]

[tool.ruff.lint.extend-per-file-ignores]

"pelican/__init__.py" = [
    # allow imports after a call to a function, see the file
    "E402"
]
"pelican/tests/test_utils.py" = [
    # the tests have a bunch of unicode characters
    "RUF001"
]
"pelican/tests/test_generators.py" = [
    # the tests have a bunch of constants, why not
    "PLR2004"
]

"pelican/tools/*.py}" = [
    # this is a command-line utility, prints are fine
    "T201"
]