From 672e7c6f9d2508d967ee181e3d7f3c92eab58fc1 Mon Sep 17 00:00:00 2001 From: Jeremy Dyer Date: Sat, 8 Feb 2025 14:02:22 -0500 Subject: [PATCH 1/3] Change client to use pyproject.toml so that dependencies can be managed in a more modern fashion --- README.md | 1 - client/LICENSE | 201 ++++++++++++++++++ client/MANIFEST.in | 8 + .../client_examples/docker/Dockerfile.client | 1 - client/pyproject.toml | 59 +++++ client/requirements.txt | 22 -- client/setup.py | 73 ------- client/src/version.py | 32 +++ .../getting-started/quickstart-guide.md | 1 - 9 files changed, 300 insertions(+), 98 deletions(-) create mode 100644 client/LICENSE create mode 100644 client/MANIFEST.in create mode 100644 client/pyproject.toml delete mode 100644 client/requirements.txt delete mode 100644 client/setup.py create mode 100644 client/src/version.py diff --git a/README.md b/README.md index 503574ab..9edde522 100644 --- a/README.md +++ b/README.md @@ -184,7 +184,6 @@ pip install . # When not using Conda, pip dependencies for the client can be installed directly via pip. Pip based installation of # the ingest service is not supported. cd client -pip install -r requirements.txt pip install . ``` diff --git a/client/LICENSE b/client/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/client/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/client/MANIFEST.in b/client/MANIFEST.in new file mode 100644 index 00000000..406ded85 --- /dev/null +++ b/client/MANIFEST.in @@ -0,0 +1,8 @@ +exclude *.egg-info + +include README.md +include LICENSE +recursive-include src/nv_ingest_client +include src/version.py +global-exclude __pycache__ +global-exclude *.pyc diff --git a/client/client_examples/docker/Dockerfile.client b/client/client_examples/docker/Dockerfile.client index 198e88b5..20885396 100644 --- a/client/client_examples/docker/Dockerfile.client +++ b/client/client_examples/docker/Dockerfile.client @@ -20,7 +20,6 @@ RUN apt update && apt install -y python3-pip git tree \ RUN cd /workspace \ && git clone https://github.com/NVIDIA/nv-ingest.git \ && cd /workspace/nv-ingest/client \ - && pip install -r ./requirements.txt \ && pip install . COPY examples /workspace/client_examples/examples diff --git a/client/pyproject.toml b/client/pyproject.toml new file mode 100644 index 00000000..d9d06e8e --- /dev/null +++ b/client/pyproject.toml @@ -0,0 +1,59 @@ +[build-system] +requires = ["setuptools", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "nv-ingest-client" +description = "Python client for the nv-ingest service" +dynamic = ["version"] # Declare attrs that will be generated at build time +readme = "README.md" +authors = [ + {name = "Jeremy Dyer", email = "jdyer@nvidia.com"} +] +license = {file = "LICENSE"} +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", +] +dependencies = [ + "azure-storage-blob==12.24.0", + "build>=1.2.2", + "charset-normalizer>=3.4.1", + "click>=8.1.8", + "fsspec>=2025.2.0", + "httpx==0.27.2", + "langchain-milvus==0.1.7", + "langchain-nvidia-ai-endpoints>=0.3.7", + "llama-index-embeddings-nvidia==0.1.5", + "minio>=7.2.15", + "openai==1.40.6", + "pyarrow>=19.0.0", + "pydantic>2.0.0", + "pydantic-settings>2.0.0", + "pymilvus==2.5.4", + "pymilvus[bulk_writer,model]", + "pypdfium2>=4.30.1", + "python-docx>=1.1.2", + "python-magic>=0.4.27", + "python-pptx==0.6.23", + "redis==5.0.8", + "requests>=2.32.3", + "setuptools>=75.8.0", + "tqdm>=4.67.1", +] + +[project.urls] +homepage = "https://github.com/NVIDIA/nv-ingest" +repository = "https://github.com/NVIDIA/nv-ingest" +documentation = "https://docs.nvidia.com/nv-ingest" + +[project.scripts] +nv-ingest-cli = "nv_ingest_client.nv_ingest_cli:main" +process-json-files = "nv_ingest_client.util.process_json_files:main" + +[tool.setuptools.packages.find] +where = ["src"] + +[tool.setuptools.dynamic] +version = {attr = "version.get_version"} diff --git a/client/requirements.txt b/client/requirements.txt deleted file mode 100644 index 116a2561..00000000 --- a/client/requirements.txt +++ /dev/null @@ -1,22 +0,0 @@ -azure-storage-blob==12.24.0 -charset-normalizer -click -fsspec -httpx==0.27.2 -llama-index-embeddings-nvidia==0.1.5 -openai==1.40.6 -pydantic>=2.0.0 -pymilvus==2.4.9 -pymilvus[bulk_writer,model] -pypdfium2 -python-docx -python-magic -python-pptx==0.6.23 -redis~=5.0.1 -requests -setuptools -tqdm -langchain-milvus -langchain-nvidia-ai-endpoints>=0.3.7 -minio -pyarrow diff --git a/client/setup.py b/client/setup.py deleted file mode 100644 index d703d311..00000000 --- a/client/setup.py +++ /dev/null @@ -1,73 +0,0 @@ -# SPDX-FileCopyrightText: Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES. -# All rights reserved. -# SPDX-License-Identifier: Apache-2.0 - - -import datetime -import os -import re - -from setuptools import find_packages -from setuptools import setup - - -def get_version(): - release_type = os.getenv("NV_INGEST_RELEASE_TYPE", "dev") - version = os.getenv("NV_INGEST_CLIENT_VERSION") - rev = os.getenv("NV_INGEST_REV", "0") - - if not version: - version = f"{datetime.datetime.now().strftime('%Y.%m.%d')}" - - # Ensure the version is PEP 440 compatible - pep440_regex = r"^\d{4}\.\d{1,2}\.\d{1,2}$" - if not re.match(pep440_regex, version): - raise ValueError(f"Version '{version}' is not PEP 440 compatible") - - # Construct the final version string - if release_type == "dev": - final_version = f"{version}.dev{rev}" - elif release_type == "release": - final_version = f"{version}.post{rev}" if int(rev) > 0 else version - else: - raise ValueError(f"Invalid release type: {release_type}") - - return final_version - - -def read_requirements(file_name): - """Read a requirements file and return a list of its packages.""" - with open(file_name) as f: - return f.read().splitlines() - - -# Specify your requirements files -base_dir = os.path.abspath(os.path.dirname(__file__)) -requirements_files = [] - -# Read and combine requirements from all specified files -combined_requirements = [] -for file in requirements_files: - combined_requirements.extend(read_requirements(file)) - -combined_requirements = list(set(combined_requirements)) - -setup( - author="Anuradha Karuppiah", - author_email="anuradhak@nvidia.com", - classifiers=[], - description="Python client for the nv-ingest service", - entry_points={ - "console_scripts": [ - "nv-ingest-cli=nv_ingest_client.nv_ingest_cli:main", - "process-json-files=nv_ingest_client.util.process_json_files:main", - ] - }, - install_requires=combined_requirements, - name="nv_ingest_client", - package_dir={"": "src"}, - packages=find_packages(where="src"), - python_requires=">=3.10", - version=get_version(), - license="Apache-2.0", -) diff --git a/client/src/version.py b/client/src/version.py new file mode 100644 index 00000000..218ae222 --- /dev/null +++ b/client/src/version.py @@ -0,0 +1,32 @@ +# SPDX-FileCopyrightText: Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES. +# All rights reserved. +# SPDX-License-Identifier: Apache-2.0 + + +import datetime +import os +import re + + +def get_version(): + release_type = os.getenv("NV_INGEST_RELEASE_TYPE", "dev") + version = os.getenv("NV_INGEST_CLIENT_VERSION") + rev = os.getenv("NV_INGEST_REV", "0") + + if not version: + version = f"{datetime.datetime.now().strftime('%Y.%m.%d')}" + + # Ensure the version is PEP 440 compatible + pep440_regex = r"^\d{4}\.\d{1,2}\.\d{1,2}$" + if not re.match(pep440_regex, version): + raise ValueError(f"Version '{version}' is not PEP 440 compatible") + + # Construct the final version string + if release_type == "dev": + final_version = f"{version}.dev{rev}" + elif release_type == "release": + final_version = f"{version}.post{rev}" if int(rev) > 0 else version + else: + raise ValueError(f"Invalid release type: {release_type}") + + return final_version diff --git a/docs/docs/user-guide/getting-started/quickstart-guide.md b/docs/docs/user-guide/getting-started/quickstart-guide.md index 091cfe3b..646d4016 100644 --- a/docs/docs/user-guide/getting-started/quickstart-guide.md +++ b/docs/docs/user-guide/getting-started/quickstart-guide.md @@ -112,7 +112,6 @@ To interact from the host, you'll need a Python environment and install the clie conda create --name nv-ingest-dev python=3.10 conda activate nv-ingest-dev cd client -pip install -r ./requirements.txt pip install . ``` From 8dfda5cf63878ed530de582da9e0d9502b46cfe2 Mon Sep 17 00:00:00 2001 From: Jeremy Dyer Date: Mon, 10 Feb 2025 13:57:05 -0500 Subject: [PATCH 2/3] Adjust Dockerfile as well and build_pip_packages to use Python build --- Dockerfile | 7 ++++++- ci/scripts/build_pip_packages.sh | 7 +++---- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/Dockerfile b/Dockerfile index 348335c1..95d90ecc 100644 --- a/Dockerfile +++ b/Dockerfile @@ -91,10 +91,15 @@ COPY client client COPY src/nv_ingest src/nv_ingest RUN rm -rf ./src/nv_ingest/dist ./client/dist +# Install python build from pip, version needed not present in conda +RUN source activate nv_ingest_runtime \ + && pip install 'build>=1.2.2' + # Add pip cache path to match conda's package cache RUN --mount=type=cache,target=/opt/conda/pkgs \ --mount=type=cache,target=/root/.cache/pip \ chmod +x ./ci/scripts/build_pip_packages.sh \ + && source activate nv_ingest_runtime \ && ./ci/scripts/build_pip_packages.sh --type ${RELEASE_TYPE} --lib client \ && ./ci/scripts/build_pip_packages.sh --type ${RELEASE_TYPE} --lib service @@ -104,7 +109,7 @@ RUN --mount=type=cache,target=/opt/conda/pkgs\ && pip install ./dist/*.whl \ && pip install ./client/dist/*.whl -RUN rm -rf src +# RUN rm -rf src FROM nv_ingest_install AS runtime diff --git a/ci/scripts/build_pip_packages.sh b/ci/scripts/build_pip_packages.sh index 2f0ca3fa..34433ad6 100755 --- a/ci/scripts/build_pip_packages.sh +++ b/ci/scripts/build_pip_packages.sh @@ -41,15 +41,14 @@ fi if [[ "$LIBRARY" == "client" ]]; then NV_INGEST_CLIENT_VERSION_OVERRIDE="${VERSION_SUFFIX}" export NV_INGEST_CLIENT_VERSION_OVERRIDE - SETUP_PATH="$SCRIPT_DIR/../../client/setup.py" + SETUP_PATH="$SCRIPT_DIR/../../client" + (cd "$(dirname "$SETUP_PATH")/client" && python -m build) elif [[ "$LIBRARY" == "service" ]]; then NV_INGEST_SERVICE_VERSION_OVERRIDE="${VERSION_SUFFIX}" export NV_INGEST_SERVICE_VERSION_OVERRIDE SETUP_PATH="$SCRIPT_DIR/../../setup.py" + (cd "$(dirname "$SETUP_PATH")" && python setup.py sdist bdist_wheel) else echo "Invalid library: $LIBRARY" usage fi - -# Build the wheel -(cd "$(dirname "$SETUP_PATH")" && python setup.py sdist bdist_wheel) From a04678876073e108993df3881cdd9a879e24467f Mon Sep 17 00:00:00 2001 From: Jeremy Dyer Date: Mon, 10 Feb 2025 13:59:07 -0500 Subject: [PATCH 3/3] Uncomment rm -rf src which was accidentally commented out --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 95d90ecc..4e6bf22d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -109,7 +109,7 @@ RUN --mount=type=cache,target=/opt/conda/pkgs\ && pip install ./dist/*.whl \ && pip install ./client/dist/*.whl -# RUN rm -rf src +RUN rm -rf src FROM nv_ingest_install AS runtime