add license & fix long_description (#2211)

NVIDIA · Aug 13, 2024 · d7c83fe · d7c83fe
1 parent 098fb29
commit d7c83fe
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/python/cuda/README.md b/python/cuda/README.md
@@ -1,3 +1,11 @@
+# `cuda.cooperative`: Experimental CUDA Core Compute Library for Python
+
+## Documentation
+
+Please visit the documentation here: https://nvidia.github.io/cccl/python.html.
+
+## Local development
+
 ```bash
 pip3 install -e .[test]
 pytest -v ./tests/device/

diff --git a/python/cuda/setup.py b/python/cuda/setup.py
@@ -25,6 +25,10 @@
 del __version__
 
 
+with open("README.md") as f:
+    long_description = f.read()
+
+
 class CustomBuildCommand(build_py):
     def run(self):
         self.run_command('package_cccl')
@@ -62,6 +66,8 @@ def run(self):
     name="cuda-cooperative",
     version=ver,
     description="Experimental Core Library for CUDA Python",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     author="NVIDIA Corporation",
     classifiers=[
         "Programming Language :: Python :: 3 :: Only",
@@ -85,5 +91,7 @@ def run(self):
         'build_py': CustomBuildCommand,
         'bdist_wheel': CustomWheelBuild,
     },
-    include_package_data=True
+    include_package_data=True,
+    license="Apache-2.0 with LLVM exception",
+    license_files = ('../../LICENSE',),
 )