pyproject.toml

# BSD 2-Clause License
#
# Copyright (c) 2021-2024, Hewlett Packard Enterprise
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


[build-system]
requires = ["setuptools", "wheel", "cmake>=3.13"]
build-backend = "setuptools.build_meta"


[project]
name = "smartdashboard"
version = "0.0.4"
requires-python = ">=3.9,<3.12"
authors = [
  {name = "CrayLabs: a Hewlett Packard Enterprise OSS Organization", email = "craylabs@hpe.com"},
]
description = "Visualize SmartSim Experiments"
license = { text = "BSD 2-Clause License" }
keywords = ["scientific", "ai", "workflow", "hpc", "analysis"]
classifiers = [
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "License :: OSI Approved :: BSD License",
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering",
]
readme = "README.md"
dependencies = [
    "altair>=5.2.0",
    "pandas>=2.0.0",
    "pydantic>=1.10.14, <2", # this is pinned to keep consistency with SmartSim
    "streamlit>=1.28.0, !=1.31.0, !=1.31.1",
    "watchdog>=3.0.0",
]

[project.urls]
Homepage = "https://www.craylabs.org"
Documentation = "https://github.com/CrayLabs/SmartDashboard"
Repository = "https://github.com/CrayLabs/SmartDashboard"


[project.optional-dependencies]
dev = [
  "black>=20.8b1",
  "isort>=5.6.4",
  "pylint>=2.10.0",
  "pytest>=6.0.0",
  "pytest-cov>=2.10.1",
  "build>=1.0.3",
]
mypy = [
  "mypy>=1.3.0",
  "pandas-stubs",
  "types-Pillow",
]
doc = [
  "sphinx==4.4.0",
  "sphinx-book-theme==0.2.0",
  "nbsphinx>=0.8.2",
  "breathe==4.31.0",
  "jinja2==3.0.3",
]


[project.scripts]
smart-dash = "smartdashboard.__main__:main"


[tool.setuptools]
packages = ["smartdashboard", "smartdashboard.pages", "smartdashboard.utils"]
include-package-data = true


[tool.setuptools.package-data]
assets = ["*.png", "*.css"]


[tool.setuptools.exclude-package-data]
tests = ["tests"]


[tool.black]
line-length = 88
target-version = ['py39', 'py310', 'py311']
exclude = '''
(
  | \.egg
  | \.git
  | \.hg
  | \.mypy_cache
  | \.nox
  | \.tox
  | \.venv
  | _build
  | build
  | dist
  | setup.py
)
'''


[tool.pytest.ini_options]
log_cli = true
log_cli_level = "debug"


[tool.isort]
# supress circular import warning
profile = "black"
# skip = []


[tool.coverage.run]
source = ["smartdashboard"]
# see test_configs/*_cov.cfg for "omit"

[tool.coverage.report]
ignore_errors = true
# see test_configs/*_cov.cfg for "exclude_lines"


[tool.coverage.html]
directory = "htmlcov"


[tool.mypy]
namespace_packages = true
files = [
  "smartdashboard"
]
plugins = []
ignore_errors = false

# Dynamic typing
disallow_any_generics = true
warn_return_any = true

# Strict fn defs
disallow_untyped_calls = true
disallow_untyped_defs = true
disallow_incomplete_defs = true
disallow_untyped_decorators = true

# Safety/Upgrading Mypy
warn_unused_ignores = true
warn_redundant_casts = true
warn_unused_configs = true
show_error_codes = true