Skip to content

Commit

Permalink
add DESCRIPTION.rst and improve pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
leofang committed Dec 13, 2024
1 parent f1267cd commit 0a2ff31
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 3 deletions.
26 changes: 26 additions & 0 deletions cuda_core/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
*******************************************************
cuda-core: Pythonic access to CUDA core functionalities
*******************************************************

`cuda.core <https://nvidia.github.io/cuda-python/cuda-core/>`_ bridges Python's productivity
with CUDA's performance through intuitive, pythonic APIs.
The mission is to provide users full access to all of the CUDA features in Python.

* `Repository <https://github.com/NVIDIA/cuda-python/tree/main/cuda_core>`_
* `Documentation <https://nvidia.github.io/cuda-python/cuda-core/>`_
* `Examples <https://github.com/NVIDIA/cuda-python/tree/main/cuda_core/examples>`_
* `Issue tracker <https://github.com/NVIDIA/cuda-python/issues/>`_

`cuda.core` is currently under active development. Any feedbacks or suggestions are welcomed!


Installation
============

.. code-block:: bash
pip install cuda-core[cu12]
Please refer to the `installation instructions
<https://nvidia.github.io/cuda-python/cuda-core/latest/install.html>`_ for different
ways of installing `cuda.core`, including building from source.
2 changes: 1 addition & 1 deletion cuda_core/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `cuda.core`: (experimental) pythonic CUDA module

Currently under active developmen; see [the documentation](https://nvidia.github.io/cuda-python/cuda-core/latest/) for more details.
Currently under active development; see [the documentation](https://nvidia.github.io/cuda-python/cuda-core/latest/) for more details.

## Installing

Expand Down
10 changes: 8 additions & 2 deletions cuda_core/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ authors = [
]
license = {text = "NVIDIA Software License"}
classifiers = [
"Development Status :: 3 - Alpha",
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"Intended Audience :: End Users/Desktop",
Expand All @@ -36,6 +36,7 @@ classifiers = [
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: Implementation :: CPython",
"Environment :: GPU :: NVIDIA CUDA",
"Environment :: GPU :: NVIDIA CUDA :: 11",
Expand All @@ -47,14 +48,19 @@ dependencies = [
"cuda-python <13",
]

[project.urls]
homepage = "https://nvidia.github.io/cuda-python/"
documentation = "https://nvidia.github.io/cuda-python/cuda-core/"
repository = "https://github.com/NVIDIA/cuda-python/tree/main/cuda_core"
issues = "https://github.com/NVIDIA/cuda-python/issues/"

[tool.setuptools.packages.find]
include = ["cuda.core*"]


[tool.setuptools.dynamic]
version = { attr = "cuda.core._version.__version__" }
readme = { file = ["README.md"], content-type = "text/markdown" }
readme = { file = ["DESCRIPTION.rst"], content-type = "text/x-rst" }

[tool.ruff]
line-length = 120
Expand Down

0 comments on commit 0a2ff31

Please sign in to comment.