pyproject.toml

####################################################################################################
####### PLEASE READ THE CONTRIBUTING DOCUMENT FIRST BEFORE APPLYING ANY CHANGES TO THIS FILE #######
########################################### SLICKML TEAM ###########################################
####################################################################################################

[tool.poetry]
name = "slickml"
version = "0.3.1"
description = "SlickML: Slick Machine Learning in Python"
license = "MIT"
authors = [
    "Amirhessam Tahmassebi <admin@slickml.com>",
]
maintainers = [
    "Amirhessam Tahmassebi <admin@slickml.com>",
]
readme = "README.md"
homepage = "https://www.slickml.com"
repository = "https://github.com/slickml/slick-ml"
documentation = "https://www.docs.slickml.com"
keywords = [
    "python",
    "data-science",
    "machine-learning",
]

classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Natural Language :: English",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Typing :: Typed",
]
packages = [
    { include = "slickml", from = "src" },
]
include = ["src/slickml", "*.md"]
exclude = [
    "docs",
    "assets",
    "tests",
    "examples",
]


[tool.poetry.dependencies]
python = ">=3.9,<3.13"

# --- scientific-computing ---
numpy = ">=1.22,<2.0"
pandas = ">=1.4,<2.0"
scipy = ">=1.9"
statsmodels = ">=0.13"

# --- machine-learning ---
scikit-learn = ">=1.5"
xgboost = ">=1.7,<2.0"
python-glmnet = ">=2.2"
shap = ">=0.46"

# --- optimization ----
bayesian-optimization = ">=1.2"
hyperopt = ">=0.2"

# --- visualization ---
matplotlib = ">=3.5"
seaborn = ">=0.12"

# --- command-lines ---
click = ">=8.1"


[tool.poetry.group.dev.dependencies]

# --- package-management ---
pip = ">=22.3"
setuptools = ">=70.3"

# --- task-management ---
poethepoet = ">=0.16"

# --- testenv-management ---
tox = ">=3.28"

# --- formatting ---
add-trailing-comma = ">=2.4"
isort = ">=5.11"
black = ">=22.12"
jupyter-black = ">=0.3"

# --- linting ---
flake8 = ">=5.0"
flake8-commas = ">=4.0"
flake8-annotations = ">=2.9"
flake8-comprehensions = ">=3.10"
flake8-eradicate = ">=1.4"
flake8-simplify = ">=0.19"
flake8-tidy-imports = ">=4.8"
flake8-type-checking = ">=2.3"
flake8-typing-imports = ">=1.12"
flake8-use-fstring = ">=1.4"
pep8-naming = ">=0.13"

# --- type-checking ---
mypy = ">=0.991"
pandas-stubs = ">=1.5"
data-science-types = ">=0.2"

# --- unit-testing ---
pytest = ">=7.2"
pytest-cov = ">=4.0"
pytest-mock = ">=3.10"
mock = ">=4.0"
coverage = ">=6.5"
assertpy = ">=1.1"

# --- docs ----
sphinx = ">=5.3"
sphinx-autoapi = ">=1.9"
sphinx_design = ">=0.3"
myst-parser = ">=0.18"
furo = ">=2022.9"

# --- jupyter ---
ipykernel = ">=6.29"
jupytext = ">=1.14"

# --- monitoring ---
watchdog = ">=2.1"

# --- image manipulation ---
pillow = ">=9.3"


[tool.poetry.scripts]
slickml = "slickml.cli:cli"

# -- try `poe --help` for options
[tool.poe.tasks]

[tool.poe.tasks.greet]
help = "Runtime user greetings"
cmd = """
echo "Welcome to SlickML ♡♡♡ $USER ♡♡♡ ...\n\n \
███████╗██╗     ██╗ ██████╗██╗  ██╗███╗   ███╗██╗     
██╔════╝██║     ██║██╔════╝██║ ██╔╝████╗ ████║██║     
███████╗██║     ██║██║     █████╔╝ ██╔████╔██║██║     
╚════██║██║     ██║██║     ██╔═██╗ ██║╚██╔╝██║██║     
███████║███████╗██║╚██████╗██║  ██╗██║ ╚═╝ ██║███████╗
╚══════╝╚══════╝╚═╝ ╚═════╝╚═╝  ╚═╝╚═╝     ╚═╝╚══════╝\
" """

[tool.poe.tasks.clean]
help = "Remove all the ignored directories/files"
cmd = """
    rm -rf .coverage
           dist/ 
           .mypy_cache/ 
           .pytest_cache/
           .tox
           htmlcov/
           xmlcov/
           **/__pycache__/
           **/.ipynb_checkpoints/
    """

[tool.poe.tasks.add-trailing-comma]
help = "Format code style via add-trailing-comma"
cmd = "poetry run add-trailing-comma --exit-zero-even-if-changed src/**/*.py tests/**/*.py"

[tool.poe.tasks.black]
help = "Format code style via black"
cmd = "poetry run black --line-length 100 ."

[tool.poe.tasks.isort]
help = "Sort imported libraries via isort"
cmd = "poetry run isort --profile black ."

[tool.poe.tasks.flake8]
help = "Lint code via flake8"
cmd = "poetry run flake8 --verbose --benchmark --color always --config .flake8"

[tool.poe.tasks.mypy]
help = "Lint types via mypy"
cmd = "poetry run mypy --config-file mypy.ini"

[tool.poe.tasks.test]
help = "Run unit-tests via pytest"
cmd = "poetry run python -m pytest --cov=src --cov-report=term --cov-report=html --cov-report=xml --cov-config=.coveragerc --tb=short -ra -v"

[tool.poe.tasks.sphinx]
help = "Build API docs via sphinx"
cmd = "poetry run sphinx-build -b html docs/ docs/_build"

[tool.poe.tasks.tox]
help = "Test environments via tox"
cmd = "poetry run tox --conf=tox.ini --root=."

[tool.poe.tasks.format]
help = "Apply all formatting steps."
sequence = [
    "greet",
    "add-trailing-comma",
    "isort",
    "black",
]

[tool.poe.tasks.check]
help = "Check all linting steps. "
sequence = [
    "greet",
    { cmd = "poe black --check" },
    { cmd = "poe isort --check-only" },
    { cmd = "poe flake8 ." },
    { cmd = "poe mypy ." },
]


[build-system]
requires = ["poetry-core>=1.9.0"]
build-backend = "poetry.core.masonry.api"