pyproject.toml

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

[tool.poetry]
name = "slickcore"
version = "0.1.0"
description = "SlickCore: Slick Core Functionalities 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-log"
documentation = "https://github.com/slickml/slick-log"
keywords = [
    "core",
    "utils",
    "utilities",
    "logging",
    "env",
]

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 = "slickcore", from = "src" },
]
include = ["src/slickcore", "*.md"]
exclude = ["assets", "tests"]


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

# --- logging ---
structlog = ">=24.4"
python-json-logger = ">=2.0"

[tool.poetry.dev-dependencies]

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

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

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

# --- formatting ---
add-trailing-comma = ">=2.2"
isort = ">=5.10"
black = ">=22.10"

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

# --- 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"


[tool.poetry.scripts]

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

[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.tox]
help = "Test environments via tox"
cmd = "poetry run tox --conf=tox.ini --root=."

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

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


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