python/pyproject.toml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

[build-system]
requires = [
  "scikit-build-core>=0.8.3",
  "pybind11",
  "ninja ~= 1.11",
  "setuptools-scm",
]
build-backend = "scikit_build_core.build"


[project]
name = "graphar"
# The version is derived from the git tags at build time;
dynamic = ["version"]
description = "An open source, standard data file format for graph data storage and retrieval."
readme = "README.md"
authors = [{ name = "GraphAr community", email = "dev@graphar.apache.org" }]
requires-python = ">=3.10"

# The version of the PyArrow here should exactly match the version inside the GraphAr core!!!
dependencies = [
  "pyarrow == 24.0.0",
  "typer ~= 0.1",
  "pydantic ~= 2.0",
  "pyyaml ~= 6.0",
]
license = "Apache-2.0"
classifiers = [
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
]

[tool.poetry]
# Placeholder only: Poetry requires a version for the root package;
version = "0.0.0"

[tool.poetry.group.docs]
optional = true

[tool.poetry.group.docs.dependencies]
pdoc = "*"

[tool.poetry.group.test]
optional = true

[tool.poetry.group.test.dependencies]
pandas = ">=2.0, <3.0"
typing_extensions = ">=4.0, <5.0"
pytest = ">=7.0, <8.0"

[tool.setuptools_scm]
# The git repository root is one level above python/ (the repo checkout),
# so setuptools-scm must search parent directories for the .git metadata.
search_parent_directories = true
local_scheme = "no-local-version"

[[tool.dynamic-metadata]]
provider = "scikit_build_core.metadata.setuptools_scm"

# Write the resolved version into the wheel as graphar/_version.py
# (imported by src/graphar/__init__.py). Using generate (instead of
# setuptools-scm's write_to) makes sure the file lands in the wheel even
# though it is not tracked by git.
[[tool.scikit-build.generate]]
path = "graphar/_version.py"
template = '__version__ = "${version}"'

[tool.scikit-build]
build-dir = "build"

[tool.scikit-build.sdist]
include = [
  "../cpp/**",
  "../CMakeLists.txt",
  "../LICENSE",
  "../NOTICE",
]

[project.scripts]
graphar = "cli.graphar_cli:main"

[tool.ruff]
src = ["src"]
line-length = 100

[tool.ruff.lint]
extend-select = [
  "B",   # flake8-bugbear
  "I",   # isort
  "ARG", # flake8-unused-arguments
  "C4",  # flake8-comprehensions
  "EM",  # flake8-errmsg
  "ICN", # flake8-import-conventions
  "G",   # flake8-logging-format
  "PGH", # pygrep-hooks
  "PIE", # flake8-pie
  "PL",  # pylint
  "PT",  # flake8-pytest-style
  "PTH", # flake8-use-pathlib
  "RET", # flake8-return
  "RUF", # Ruff-specific
  "SIM", # flake8-simplify
  "T20", # flake8-print
  "UP",  # pyupgrade
  "YTT", # flake8-2020
  "EXE", # flake8-executable
  "NPY", # NumPy specific rules
  "PD",  # pandas-vet
]
ignore = [
  "PLR09",   # Too many X
  "PLR2004", # Magic comparison
]