pyproject.toml

[project]
name = "reader"
authors = [{name = "lemon24"}]
description = "A Python feed reader library."
readme = "README.rst"
license = {text = "BSD-3-Clause"}
keywords = [
    "atom", "cdf", "feed", "rdf", "rss", "json feed",
    "web feed", "podcast", "feed reader", "feed aggregator",
]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Environment :: Console",
    "Environment :: Web Environment",
    "Intended Audience :: Developers",
    "Intended Audience :: End Users/Desktop",
    "License :: OSI Approved :: BSD License",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Programming Language :: Python :: Implementation :: CPython",
    "Programming Language :: Python :: Implementation :: PyPy",
    "Topic :: Internet",
    "Topic :: Internet :: WWW/HTTP :: Dynamic Content :: News/Diary",
    "Topic :: Internet :: WWW/HTTP :: Indexing/Search",
    "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
    "Topic :: Software Development :: Libraries",
    "Topic :: Utilities",
    "Typing :: Typed",
]
requires-python = ">=3.11"
dependencies = [
    "typing-extensions>=4",
    "feedparser>=6",
    "requests>=2.18",
    # for _http_utils
    "werkzeug>2",
    # for JSON Feed date parsing
    "iso8601>=1",
    # search
    "beautifulsoup4>=4.5",
]
dynamic = ["version"]

[project.urls]
Documentation = "https://reader.readthedocs.io/"
Repository = "https://github.com/lemon24/reader"
Issues = "https://github.com/lemon24/reader/issues"
Changelog = "https://reader.readthedocs.io/en/latest/changelog.html"

[project.optional-dependencies]

# UNSTABLE

all = ["reader[cli,app,unstable-plugins]"]

cli = [
    "click>=7",
]
app = [
    "flask>=0.10",
    "humanize>=4",
    # for config
    "PyYAML",
    # for v2
    "WTForms",
    "Flask-WTF",
    "jinja2-fragments",
]

# mushed together for convenience
unstable-plugins = [
    # enclosure-tags
    "requests",
    "mutagen",
    # preview-feed-list
    "requests",
    "beautifulsoup4",
    "blinker>=1.4",
    # sqlite-releases
    "beautifulsoup4",
    # timer
    "tabulate",
]

[dependency-groups]

tests = [
    "pytest>=9",
    "pytest-randomly",
    "pytest-rerunfailures",
    "coverage",
    "requests-mock",
    # mechanicalsoup hard-depends on lxml (see below)
    'mechanicalsoup; (implementation_name != "pypy" and python_version <= "3.14")',
    "requests-wsgi-adapter",
    # we want to test search with all known bs4 parsers.
    # lxml usually does not have recent PyPy wheels.
    # lxml usually does not have pre-relase CPython wheels.
    'lxml; (implementation_name != "pypy" and python_version <= "3.14")',
    "html5lib",
    # for bench.py
    'numpy; (implementation_name != "pypy" and os_name == "posix" and python_version <= "3.14")',
]

typing = [
    'mypy',
    "types-requests",
    "types-beautifulsoup4",
]

docs = [
    "sphinx",
    # TODO: remove when https://github.com/sphinx-doc/sphinx/issues/14186 is solved
    "roman_numerals<4.1",
    "sphinx-rtd-theme",
    "click>=7",
    "sphinx-click",
    "sphinxcontrib-log-cabinet",
    # for read_configuration used in conf.py
    "setuptools",
]

dev = [
    {include-group = "tests"},
    {include-group = "typing"},
    {include-group = "docs"},
    "tox",
    "pre-commit",
    "build",
    "twine",
]

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools.dynamic]
version = {attr = "reader.__version__"}

[tool.pytest.ini_options]
addopts = "--strict-markers"
markers = [
    "slow: mark a test as slow.",
    "requires_lxml: mark a test to only run in places where we have lxml.",
    "apptest: mark a test as a web app test (skipped sometimes).",
    "noscheduled: force update_feeds(scheduled=...) to false.",
    "noautoclose: skip 'autoclose' autouse fixture for a test."
]
filterwarnings = [
    "ignore:No parser was explicitly specified::reader._storage._html_utils",
]
testpaths = ["tests"]

[tool.coverage.run]
branch = true
source = ["reader", "tests"]
omit = [
    "src/reader/_vendor/*",
]
# TODO: remove when https://github.com/nedbat/coveragepy/issues/1987 is solved
core = "ctrace"
[tool.coverage.paths]
source = ["src", "*/site-packages"]

[tool.mypy]
files = ["src"]
show_error_codes = true
pretty = true
strict = true
[[tool.mypy.overrides]]
module = [
    "reader.__main__",
    "reader._cli",
    "reader._config_utils",
    "reader._app",
    "reader._app.*",
    "reader._plugins.*",
    "reader.plugins.enclosure_dedupe",
    "reader.plugins.entry_dedupe",
    "reader.plugins.ua_fallback",
    "reader.plugins.readtime",
    "reader.plugins.mark_as_read",
    "reader._vendor.feedparser.*",
]
ignore_errors = true

[tool.isort]
profile = "black"
py_version = 311
src_paths = ["src", "tests"]
extend_skip = ["examples", "src/reader/_vendor"]
skip_gitignore = true
filter_files = true
force_single_line = true
order_by_type = false