pyproject.toml

[project]
name = "getfactormodels"
dynamic = ["version"]
description = "Retrieve data for various multifactor asset pricing models."
authors = [{name = "S. Martin", email = "x512@pm.me"}, ]
license = {file = "LICENSE"}
readme = "README.md"
keywords = ['finance', 'pricing models', 'financial analysis', 'econometrics',
            'asset pricing', 'multifactor models']
classifiers = [
    "Topic :: Office/Business :: Financial",
    "Topic :: Office/Business :: Financial :: Investment",
    "Topic :: Scientific/Engineering :: Mathematics",
    "Topic :: Scientific/Engineering :: Information Analysis",
    "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",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3 :: Only",
    "Operating System :: OS Independent",
    "Environment :: Console",
    "License :: OSI Approved :: MIT License",
    "Intended Audience :: Financial and Insurance Industry",
    "Development Status :: 2 - Pre-Alpha"
]
requires-python = ">=3.7"   # Will lower soon
dependencies = [ "pandas >=1.4",
                 "numpy >=1.18.5",
                 "requests >=2.20.0",
                 "pyarrow >=14.0.1",
                 "openpyxl >=3.0.3",
                 "tabulate >=0.8.7",
                 "cachetools==5.3.2" ]

[project.optional-dependencies]
dev = ["flit>=3.2,<=3.9", "ruff>=0.1.6", "pytest-cov", "pytest>=7.0",
       "isort>=5.12", "pytest-randomly", "nox==2023.4.22"]

[project.urls]
"Homepage" = "https://github.com/x512/getfactormodels"

[project.scripts]
getfactormodels = "getfactormodels.__main__:main"

[build-system]
requires = ["flit_core >=3.2,<=3.9"]
build-backend = "flit_core.buildapi"

[tool.flit.sdist]
exclude = ["**/*.ipynb"]

[tool.isort]
lines_between_sections = false

[tool.ruff]
line-length = 79
target-version = "py312"
indent-width = 4
respect-gitignore = true

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
line-ending = "auto"

# Some rules in preview, enable them:
## docs.astral.sh/ruff/settings/#format-preview
preview = true

[tool.ruff.lint]
exclude = [".git", ".git-rewrite",]
# run `ruff linter` to see all available rules
## see: docs.astral.sh/ruff/rules/
select = ["E4", "E7", "E9", "F", "B",
          "DTZ", "W2", "W5", "N", "PL",
          "NPY", "SIM", "TID", "PD",
          "E241", "S", "PTH", "RUF", 
          "FIX001", "TD004", "EM",
          "TD005", "TD007", "E501",
          "FA", "FIX002", "ANN",   # fix
          "E261"]                        # requires '--preview'
        # "TCH" (flake 8 typechecking)
        # "C901" (McCabe complexity)
        # "CPY" Copyright notices

# Undo soon:
ignore = ["PD901",]  # TODO: fix all generic variable name `df` for DataFrames

# see: docs.astral.sh/ruff/configuration/
fixable = ["W29", "W5", "E241", "E261"]
unfixable = ["B", "FIX001", "FIX002", "UP"]

[tool.ruff.per-file-ignores]
"**/__init__.py" = ["F401"]
"__main__.py" = ["F401"]  # the function names are constructed with a key

[tool.coverage.run]
omit = ['tests/*']