standardize packaging, tooling, docs, CI, and licensing

This commit is contained in:
2026-09-10 18:49:06 +05:30
parent f92d40ed7f
commit 1e7e7c8a6c
38 changed files with 283 additions and 138 deletions

View File

@@ -1,13 +1,14 @@
[build-system]
requires = ["setuptools>=65.0", "wheel"]
requires = ["setuptools>=68", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "omniread"
version = "0.0.1"
description = "Composable content ingestion framework with pluggable scrapers and parsers for HTML, PDF, and structured data"
readme = "README.md"
requires-python = ">=3.9"
requires-python = ">=3.10"
license = { text = "MIT" }
authors = [
@@ -17,6 +18,7 @@ maintainers = [
{ name = "Aetos Skia", email = "dev@aetoskia.com" }
]
keywords = [
"scraping",
"parsing",
@@ -33,39 +35,49 @@ classifiers = [
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Topic :: Security",
"Topic :: Software Development :: Libraries :: Python Modules",
"Topic :: Internet :: WWW/HTTP",
"Topic :: Text Processing",
"Typing :: Typed",
]
dependencies = [
"requests>=2.31.0",
"beautifulsoup4>=4.12.0",
# "lxml>=5.0.0",
"pypdf>=4.0.0",
"openpyxl>=3.1.0",
]
[project.optional-dependencies]
dev = [
"pytest>=7.4.0",
"pytest>=8.0.0",
"pytest-asyncio>=0.21.0",
"pytest-cov>=4.1.0",
"black>=23.0.0",
"ruff>=0.1.0",
"mypy>=1.5.0",
"ruff>=0.3.0",
"mypy>=1.8.0",
"build>=1.0.0",
"twine>=4.0.0",
"pre-commit>=3.4.0",
"doc-forge[mcp,mkdocs]>=0.0.6",
]
docs = [
"mkdocs>=1.5.0",
"mkdocs-material>=9.5.0",
"mkdocstrings[python]>=0.24.0",
]
all = [
"omniread[dev,fastapi]",
"omniread[dev,docs]",
]
[project.urls]
Homepage = "https://git.aetoskia.com/aetos/omniread"
Documentation = "https://git.aetoskia.com/aetos/omniread#readme"
@@ -73,12 +85,14 @@ Repository = "https://git.aetoskia.com/aetos/omniread.git"
Issues = "https://git.aetoskia.com/aetos/omniread/issues"
Versions = "https://git.aetoskia.com/aetos/omniread/tags"
[tool.setuptools]
packages = { find = { include = ["omniread*"] } }
[tool.setuptools.package-data]
omniread = ["py.typed"]
[tool.pytest.ini_options]
testpaths = ["tests"]
asyncio_mode = "auto"
@@ -94,9 +108,10 @@ addopts = [
"--cov-report=xml",
]
[tool.black]
line-length = 88
target-version = ["py39", "py310", "py311", "py312", "py313"]
target-version = ["py310", "py311", "py312", "py313"]
include = '\.pyi?$'
extend-exclude = '''
/(
@@ -111,9 +126,12 @@ extend-exclude = '''
)/
'''
[tool.ruff]
line-length = 88
target-version = "py39"
target-version = "py310"
[tool.ruff.lint]
select = [
"E",
"W",
@@ -129,31 +147,30 @@ ignore = [
"C901",
]
[tool.ruff.per-file-ignores]
"__init__.py" = ["F401"]
[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401", "I001"]
"tests/*" = ["B008"]
[tool.mypy]
python_version = "3.9"
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = true
disallow_incomplete_defs = true
check_untyped_defs = true
disallow_untyped_decorators = false
no_implicit_optional = true
warn_redundant_casts = true
warn_unused_ignores = true
warn_no_return = true
follow_imports = "normal"
strict_optional = true
python_version = "3.10"
strict = true
exclude = [
"tests/",
]
files = ["omniread"]
[[tool.mypy.overrides]]
module = [
"jose.*",
"httpx.*",
"requests.*",
"bs4.*",
"lxml.*",
"pypdf.*",
"openpyxl.*",
]
ignore_missing_imports = true
[tool.coverage.run]
source = ["omniread"]
omit = [
@@ -170,4 +187,4 @@ exclude_lines = [
"raise NotImplementedError",
"if TYPE_CHECKING:",
"@abstractmethod",
]
]