Skip to content

Commit 1adb2c5

Browse files
committed
feat: Update pyproject.toml and README
1 parent a88075e commit 1adb2c5

2 files changed

Lines changed: 36 additions & 7 deletions

File tree

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,55 @@
11
# vtk-sdk
22

33
[![Actions Status][actions-badge]][actions-link]
4+
5+
<!--
46
[![Documentation Status][rtd-badge]][rtd-link]
7+
-->
58

9+
<!--
610
[![PyPI version][pypi-version]][pypi-link]
7-
[![Conda-Forge][conda-badge]][conda-link]
811
[![PyPI platforms][pypi-platforms]][pypi-link]
12+
-->
913

10-
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
14+
[![Discourse Forum][discourse-forum-badge]][discourse-forum-link]
1115

1216
<!-- SPHINX-START -->
1317

18+
## Overview
19+
20+
The Visualization Toolkit (VTK) is a robust and open-source software system that
21+
provides advanced features in 3D computer graphics, image processing, modeling,
22+
volume rendering, and scientific visualization. It offers threaded and
23+
distributed-memory parallel processing for scalability and better performance.
24+
25+
This project is intended to distribute the content of the existing VTK wheel
26+
SDKs as first-class `vtk-sdk` wheels.
27+
28+
Each `vtk-sdk` Python wheel is equipped with a scikit-build-core `cmake-module`
29+
[entrypoint][scikit-build-core-entrypoint], housing the official VTK SDK sourced
30+
from the corresponding [archive][wheel-sdks-link].
31+
32+
[wheel-sdks-link]: https://vtk.org/files/wheel-sdks/
33+
[scikit-build-core-entrypoint]:
34+
https://scikit-build-core.readthedocs.io/en/latest/cmakelists.html#finding-other-packages
35+
36+
## License
37+
38+
VTK is distributed under the OSI-approved BSD 3-clause License. See
39+
Copyright.txt for details.
40+
1441
<!-- prettier-ignore-start -->
1542
[actions-badge]: https://github.com/Kitware/vtk-sdk-python-distributions/workflows/CI/badge.svg
1643
[actions-link]: https://github.com/Kitware/vtk-sdk-python-distributions/actions
17-
[conda-badge]: https://img.shields.io/conda/vn/conda-forge/vtk-sdk
18-
[conda-link]: https://github.com/conda-forge/vtk-sdk-feedstock
19-
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
20-
[github-discussions-link]: https://github.com/Kitware/vtk-sdk-python-distributions/discussions
44+
[discourse-forum-badge]: https://img.shields.io/discourse/https/discourse.vtk.org/status.svg
45+
[discourse-forum-link]: https://discourse.vtk.org/
46+
47+
<!--
2148
[pypi-link]: https://pypi.org/project/vtk-sdk/
2249
[pypi-platforms]: https://img.shields.io/pypi/pyversions/vtk-sdk
2350
[pypi-version]: https://img.shields.io/pypi/v/vtk-sdk
2451
[rtd-badge]: https://readthedocs.org/projects/vtk-sdk/badge/?version=latest
2552
[rtd-link]: https://vtk-sdk.readthedocs.io/en/latest/?badge=latest
53+
-->
2654

2755
<!-- prettier-ignore-end -->

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ build-backend = "scikit_build_core.build"
66
[project]
77
name = "vtk-sdk"
88
authors = [
9+
{ name = "Alexy Pellegrini", email = "alexy.pellegrini@kitware.com" },
910
{ name = "Jean-Christophe Fillion-Robin", email = "jchris.fillionr@kitware.com" },
1011
]
1112
description = "Distribution of the VTK wheel SDKs as first-class Python wheels"
@@ -57,7 +58,7 @@ Changelog = "https://github.com/Kitware/vtk-sdk-python-distributions/releases"
5758

5859

5960
[tool.scikit-build]
60-
minimum-version = "0.4"
61+
minimum-version = "0.8.2"
6162
build-dir = "build/{wheel_tag}"
6263
metadata.version.provider = "scikit_build_core.metadata.setuptools_scm"
6364
sdist.include = ["src/vtk_sdk/_version.py"]

0 commit comments

Comments
 (0)