Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add metadata to shortfin python package. #489

Closed
wants to merge 1 commit into from
Closed

Add metadata to shortfin python package. #489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion shortfin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# shortfin - SHARK C++ inference library
# shortfin - SHARK inference library and serving engine

## Simple User Installation

Expand Down
25 changes: 24 additions & 1 deletion shortfin/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,12 @@ def build_tracy_configuration(self):
PYTHON_DEFAULT_BINARY_DIR = REL_CMAKE_DEFAULT_BUILD_DIR / "python"
PYTHON_TRACY_BINARY_DIR = REL_CMAKE_TRACY_BUILD_DIR / "python"

with open(
REL_SOURCE_DIR / "README.md",
"rt",
) as f:
README = f.read()


# We need some directories to exist before setup.
def populate_built_package(abs_dir):
Expand Down Expand Up @@ -361,8 +367,25 @@ def populate_built_package(abs_dir):
setup(
name="shortfin",
version=f"{PACKAGE_VERSION}",
description="Shortfin native library implementation",
author="SHARK Authors",
description="shortfin - SHARK inference library and serving engine",
long_description=README,
long_description_content_type="text/markdown",
license="Apache-2.0",
classifiers=[
"Development Status :: 3 - Alpha",
"License :: OSI Approved :: Apache Software License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
],
project_urls={
"repository": "https://github.com/nod-ai/SHARK-Platform",
"documentation": "https://shortfin.readthedocs.io/en/latest/",
},
python_requires=">=3.10",
Comment on lines +371 to +388
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may want to add this to the pyproject.toml file to have these information in the same place as for the sharktank and shark-ai package.

packages=packages,
zip_safe=False,
package_dir=combine_dicts(
Expand Down
Loading