pyproject.toml

# Copyright (C) British Crown (Met Office) & Contributors.
#
# This file is part of Rose, a framework for meteorological suites.
#
# Rose is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Rose is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Rose. If not, see <http://www.gnu.org/licenses/>.

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "metomi-rose"
description = "Rose, a framework for meteorological suites."
authors = [
    { name = "British Crown (Met Office) & Contributors", email = "metomi@metoffice.gov.uk" }
]
readme = "README.md"
license = "GPL-3.0-only"
keywords = [
    "hpc",
    "weather-modelling",
    "weather-model",
    "meteorological-suites",
    "meteorological-modelling",
    "meteorological-models",
    "workflows",
    "workflow-automation",
]
classifiers = [
    "Environment :: Console",
    "Environment :: Web Environment",
    "Intended Audience :: Developers",
    "Intended Audience :: System Administrators",
    "Intended Audience :: Science/Research",
    "Operating System :: POSIX :: Linux",
    "Programming Language :: Python :: 3",
    "Topic :: Scientific/Engineering :: Atmospheric Science"
]
requires-python = ">=3.12"
dynamic = ["version"]
dependencies = [
    "aiofiles",
    "jinja2>=2.10.1",
    "keyring>=23.0.0",
    "metomi-isodatetime==1!3.*",
    "psutil>=5.6.0",
    "requests",
]

[project.urls]
Homepage = "https://metomi.github.io/rose/doc/html/index.html"
Repository = "https://github.com/metomi/rose"
Changelog = "https://github.com/metomi/rose/blob/master/CHANGES.md"

[project.optional-dependencies]
docs = [
    "cylc-sphinx-extensions[all]>=1.2.0",
    "hieroglyph>=2.1.0",
    "sphinx",
    "sphinx-copybutton",
    "sphinx_rtd_theme",
    "sphinxcontrib-httpdomain",
    "sphinxcontrib-svg2pdfconverter",
]
graph = [
    "pygraphviz>1.0,!=1.8"
]
tests = [
    "aiosmtpd",
    "pytest",
    "towncrier>=24.7.0"
    # Note: some tests also depend on cylc-rose which has to be the
    # development version installed manually (because the latest production
    # version is pinned to the previous rose release)
]
lint = [
    "flake8>=6.0.0",
    "flake8-type-checking",
    "mypy>=0.800",
    "types-aiofiles"
]
tutorials = [
    "cylc-flow[tutorials]>=8.6.1"
]
rosa = []
edit = [
    "pygobject>=3.50.0",
]
ldap = [
    "python-ldap",
]
disco = [
    "sqlalchemy==1.*",
    "tornado",
]
all = [
    "metomi-rose[lint]",
    "metomi-rose[docs]",
    "metomi-rose[graph]",
    "metomi-rose[tests]",
    "metomi-rose[tutorials]",
    "metomi-rose[rosa]",
    "metomi-rose[edit]",
    "metomi-rose[disco]",
]

[project.scripts]
rose = "metomi.rose.rose:rose"
rosie = "metomi.rose.rose:rosie"
rosa = "metomi.rose.rose:rosa"

[project.entry-points."rose.commands"]
"app-run" = "metomi.rose.app_run:main"
"app-upgrade" = "metomi.rose.upgrade:main"
"check-software" = "metomi.rose.check_software:main"
"config" = "metomi.rose.config_cli:main"
"config-diff" = "metomi.rose.config_diff:main"
"config-dump" = "metomi.rose.config_dump:main"
"config-edit" = "metomi.rose.config_editor.main:main [edit]"
"date" = "metomi.rose.date_cli:main"
"env-cat" = "metomi.rose.env_cat:main"
"host-select" = "metomi.rose.host_select:main"
"host-select-client" = "metomi.rose.host_select_client:main"
"launch-splash-screen" = "metomi.rose.gtk.splash:main"
"macro" = "metomi.rose.macro:main"
"metadata-check" = "metomi.rose.metadata_check:main"
"metadata-gen" = "metomi.rose.metadata_gen:main"
"metadata-graph" = "metomi.rose.metadata_graph:main [graph]"
"namelist-dump" = "metomi.rose.namelist_dump:main"
"resource" = "metomi.rose.resource:main"
"task-env" = "metomi.rose.task_env:main"
"task-run" = "metomi.rose.task_run:main"

[project.entry-points."rosie.commands"]
"checkout" = "metomi.rosie.vc:checkout"
"create" = "metomi.rosie.vc:create"
"delete" = "metomi.rosie.vc:delete"
"disco" = "metomi.rosie.ws:main [disco]"
"graph" = "metomi.rosie.graph:main [graph]"
"hello" = "metomi.rosie.ws_client_cli:hello"
"id" = "metomi.rosie.suite_id:main"
"lookup" = "metomi.rosie.ws_client_cli:lookup"
"ls" = "metomi.rosie.ws_client_cli:list_local_suites"

[tool.setuptools.packages.find]
include = ["metomi*"]
exclude = ["metomi.rose.tests*", "metomi.rosie.tests*"]

[tool.setuptools]
include-package-data = true

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


[tool.towncrier]
directory = "changes.d"
name = "Rose"
package = "metomi.rose"
filename = "CHANGES.md"
template = "changes.d/changelog-template.jinja"
underlines = ["", "", ""]
title_format = "## {version} (Released {project_date})"
issue_format = "[#{issue}](https://github.com/metomi/rose/pull/{issue})"
ignore = ["changelog-template.jinja"]

# These changelog sections will be shown in the defined order:
[[tool.towncrier.type]]
directory = "break" # NB this is just the filename not directory e.g. 123.break.md
name = "⚠ Breaking Changes"
showcontent = true
[[tool.towncrier.type]]
directory = "feat"
name = "🚀 Enhancements"
showcontent = true
[[tool.towncrier.type]]
directory = "fix"
name = "🔧 Fixes"
showcontent = true


# Not mandated to use these tools, but if you do:

[tool.ruff]
line-length = 79
target-version = "py312"

[tool.ruff.format]
quote-style = "preserve"


[tool.black]
line-length = 79
target-version = ['py312']
skip-string-normalization = true


[tool.isort]
profile = "black"
line_length = 79
force_grid_wrap = 2
lines_after_imports = 2
combine_as_imports = true
force_sort_within_sections = true
known_first_party = ["metomi"]

[tool.ruff.lint.isort]
# force-grid-wrap = 2  # astral-sh/ruff#2601
lines-after-imports = 2
combine-as-imports = true
force-sort-within-sections = true