pyproject.toml

#
# Ralph package
#
[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[project]
name = "ralph-malph"
description = "Ralph, the ultimate Learning Record Store (and more!) for your learning analytics."
readme = "README.md"
authors = [
    { "name" = "Open FUN (France Université Numérique)", "email" = "fun.dev@fun-mooc.fr" }
]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Natural Language :: English",
    "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"
]
requires-python = ">=3.8"
license = { file = "LICENSE.md" }
keywords = ["LRS", "Analytics", "xAPI", "Open edX"]
dependencies = [
    # By default, we only consider core dependencies required to use Ralph as a
    # library (mostly models).
    "importlib-metadata>=8.5, <8.6",
    "langcodes>=3.2.0",
    "pydantic[email]>=2.5.3,<3.0",
    "pydantic_settings>=2.1.0,<3.0",
    "rfc3987>=1.3.0",
]
dynamic = ["version"]

[project.urls]
"Homepage" = "https://openfun.github.io/ralph/"
"Bug Tracker" = "https://github.com/openfun/ralph/issues"
"Changelog" = "https://github.com/openfun/ralph/blob/main/CHANGELOG.md"
"Repository" = "https://github.com/openfun/ralph"

[project.optional-dependencies]
backend-clickhouse = [
    "clickhouse-connect[numpy,pandas]<0.8",
    "python-dateutil>=2.8.2",
]
backend-es = [
    "elasticsearch[async]>=8.0.0",
]
backend-ldp = [
    "ovh==1.2.0",
    "requests>=2.0.0",
]
backend-lrs = [
    "httpx<0.27.3", # pin as `pytest-httpx<0.23.0` requires `httpx==0.24.*`
]
backend-mongo = [
    "motor[srv]>=3.3.0",
    "pymongo[srv]>=4.0.0",
    "python-dateutil>=2.8.2",
]
backend-s3 = [
    "boto3>=1.24.70",
    "botocore>=1.27.71",
    "requests-toolbelt>=1.0.0",
]
backend-swift = [
    "python-keystoneclient>=5.0.0",
    "python-swiftclient>=4.0.0",
]
backend-ws = [
    "websockets>=13.0",
]
backends = [
    "ralph-malph[backend-clickhouse,backend-es,backend-ldp,backend-lrs,backend-mongo,backend-s3,backend-swift]",
]
ci = [
    "twine==5.1.1",
]
cli = [
    "bcrypt>=4.0.0",
    "click>=8.1.0",
    "click-option-group>=0.5.0",
    "sentry-sdk[fastapi]>=1.9.0",
]
dev = [
    "anyio==4.4.0",
    "black==24.8.0",
    "cryptography==43.0.1",
    "factory-boy==3.3.1",
    "logging-gelf==0.0.32",
    "mike==2.1.3",
    "mkdocs==1.6.1",
    "mkdocs-click==0.8.1",
    "mkdocs-material==9.5.34",
    "mkdocstrings[python-legacy]==0.26.1",
    "moto==5.0.14",
    "mypy==1.11.2",
    "neoteroi-mkdocs==1.1.0",
    "polyfactory==2.16.2",
    "pyfakefs==5.6.0",
    "pymdown-extensions==10.9",
    "pytest<8.0.0", # pin as pytest-httpx<0.23.0 is not compatible with pytest 8.0.0 
    "pytest-cov==5.0.0",
    "pytest-httpx<0.23.0", # pin as Python 3.8 is no longer supported from release 0.23.0
    "requests-mock==1.12.1",
    "responses==0.25.3",
    "ruff==0.6.5",
    "types-python-dateutil ==2.9.0.20240906",
    "types-python-jose ==3.3.4.20240106",
    "types-requests<2.32.0.20240915",
    "types-cachetools ==5.5.0.20240820",
]
lrs = [
    "bcrypt==4.2.0",
    "fastapi==0.114.2",
    "cachetools==5.5.0",
    "httpx<0.27.3", # pin as `pytest-httpx<0.23.0` requires `httpx==0.24.*`
    "sentry_sdk==2.14.0",
    "python-jose==3.3.0",
    "uvicorn[standard]==0.30.6",
]
full = [
    "ralph-malph[backends,cli,lrs]",
]


[project.scripts]
ralph = "ralph.__main__:cli.cli"

[project.entry-points."ralph.backends.data"]
async_es = "ralph.backends.data.async_es:AsyncESDataBackend"
async_lrs = "ralph.backends.data.async_lrs:AsyncLRSDataBackend"
async_mongo = "ralph.backends.data.async_mongo:AsyncMongoDataBackend"
async_ws = "ralph.backends.data.async_ws:AsyncWSDataBackend"
clickhouse = "ralph.backends.data.clickhouse:ClickHouseDataBackend"
es = "ralph.backends.data.es:ESDataBackend"
fs = "ralph.backends.data.fs:FSDataBackend"
ldp = "ralph.backends.data.ldp:LDPDataBackend"
lrs = "ralph.backends.data.lrs:LRSDataBackend"
mongo = "ralph.backends.data.mongo:MongoDataBackend"
s3 = "ralph.backends.data.s3:S3DataBackend"
swift = "ralph.backends.data.swift:SwiftDataBackend"

[project.entry-points."ralph.backends.lrs"]
async_es = "ralph.backends.lrs.async_es:AsyncESLRSBackend"
async_mongo = "ralph.backends.lrs.async_mongo:AsyncMongoLRSBackend"
clickhouse = "ralph.backends.lrs.clickhouse:ClickHouseLRSBackend"
es = "ralph.backends.lrs.es:ESLRSBackend"
fs = "ralph.backends.lrs.fs:FSLRSBackend"
mongo = "ralph.backends.lrs.mongo:MongoLRSBackend"

[tool.setuptools]
packages = { find = { where = ["src"] } }
zip-safe = true

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

[tool.distutils.bdist_wheel]
universal = true

#
# Third-party packages configuration
#
[tool.ruff]
exclude = [
    ".conda",
    ".git",
    ".venv",
    "build",
    "scripts",
    "venv",
    "__pycache__",
    "node_modules",
    "*/migrations/*",
]
line-length = 88

[tool.ruff.lint]
select = [
    "ARG",  # flake8-unused-arguments
    "B",  # flake8-bugbear
    "BLE",  # flake8-blind-except
    "C4",  # flake8-comprehensions
    "D",  # pydocstyle
    "E",  # pycodestyle error
    "F",  # Pyflakes
    "FIX",  # flake8-fixme
    "I",  # isort
    "PLC",  # Pylint Convention
    "PLE",  # Pylint Error
    "PLR",  # Pylint Refactor
    "PLW",  # Pylint Warning
    "RUF100",  # Ruff unused-noqa
    "S",  # flake8-bandit
    "SLF",  # flake8-self
    "T20",  # flake8-print
    "W",  # pycodestyle warning
]
ignore = [
    "B008",  # function-call-in-default-argument
    "N806",  # non-lowercase-variable-in-function
    "N815",  # mixed-case-variable-in-class-scope
    "N818",  # error-suffix-on-exception-name
]

[tool.ruff.lint.isort]
section-order = ["future", "standard-library", "third-party", "ralph", "first-party", "local-folder"]
[tool.ruff.lint.isort.sections]
ralph = ["ralph"]

[tool.ruff.lint.per-file-ignores]
"tests/*" = [
    "ARG",  # flake8-unused-arguments
    "D",  # pydocstyle
    "S",  # flake8-bandit
    "SLF",  # flake8-self
    "PLR2004",  # Pylint magic-value-comparison
]
"setup.py" = [
    "D" # Pydocstyle rules
]

[tool.ruff.lint.pydocstyle]
# Use Google-style docstrings.
convention = "google"

[tool.mypy]
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = true
files = "src/ralph/**/*.py"
plugins = "pydantic.mypy"

[[tool.mypy.overrides]]
module = [
    "rfc3987.*",
    "requests_toolbelt.*",
    "botocore.*",
    "boto3.*",
    "clickhouse_connect.*",
    "ovh.*",
    "swiftclient.service.*",
]
ignore_missing_imports = true

[tool.pydantic-mypy]
init_forbid_extra = true
init_typed = true
warn_required_dynamic_aliases = true

[tool.pytest.ini_options]
addopts = "-v --cov-report term-missing --cov-config=.coveragerc --cov=ralph"
python_files = [
    "test_*.py",
    "tests.py",
]
testpaths = "tests"