whl-deploy 0.0.1__tar.gz

whl_deploy-0.0.1/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.

whl_deploy-0.0.1/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: whl-deploy
+Version: 0.0.1
+Summary: A deployment tool for WheelOS.
+Author-email: daohu527 <daohu527@gmail.com>
+Project-URL: Homepage, https://github.com/wheelos-tools/whl-conf
+Project-URL: Bug Tracker, https://github.com/wheelos-tools/whl-conf/issues
+Keywords: whl-conf,wheelos,configuration-management,cli-tool
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: pyyaml
+Requires-Dist: tqdm
+Dynamic: license-file
+
+# whl_deploy
+
+`whl_deploy` is a powerful tool **designed specifically for Apollo deployment**, aiming to significantly simplify the setup of Apollo environments and the import/export of resources. By automating key steps, `whl_deploy` ensures an efficient, consistent, and seamless Apollo deployment experience.
+
+## ✨ Key Features
+
+`whl_deploy` provides three core functionalities, covering the essential aspects of the Apollo deployment lifecycle:
+
+1.  **Automated Environment Setup**: Installs and configures Docker, NVIDIA Container Toolkit, and optimizes the system, providing an ideal environment for Apollo.
+2.  **Apollo Resource Import**: Unified import of core Apollo components, including Docker images, source code, AI models, high-definition maps, and compiled caches, drastically reducing initial setup and startup times.
+3.  **Resource Packaging & Distribution**: Packages pre-configured or downloaded Apollo resources into reusable bundles, facilitating rapid deployment across multiple machines, especially useful in offline environments.
+
+## 🚀 Quick Start
+
+This section guides you on how to quickly install and use `whl_deploy`, focusing on the most common end-to-end deployment flow.
+
+### 1. Installation
+
+To ensure compatibility, please upgrade your `setuptools` and `pip` first:
+
+```bash
+# Highly Recommended: Upgrade setuptools and pip first
+pip install setuptools -U
+pip install --upgrade pip
+
+# Install whl-deploy
+pip install whl-deploy
+```
+
+### 2. End-to-End Deployment - Express Mode!
+
+The following two commands are the essence of `whl_deploy`, covering the vast majority of Apollo deployment scenarios:
+
+#### Step A: Prepare Host Environment
+
+This command will automatically install Docker, the NVIDIA Container Toolkit, and perform necessary system configurations. This is the foundation for running Apollo.
+
+```bash
+whl-deploy setup all
+```
+
+#### Step B: Import Apollo Resources
+
+After setting up the environment, you can import all pre-packaged core Apollo resources, such as source code, Docker images, AI models, etc., with a single command. **Please ensure your `source` package is ready.**
+
+```bash
+whl-deploy import all --package=source
+```
+
+---
+
+### 3. More Granular Control
+
+If you require more fine-grained control, `whl_deploy` also provides individual commands.
+
+#### 3.1. Host Environment Configuration - Step-by-Step
+
+In some cases, you might want to configure the host environment step-by-step:
+
+```bash
+# Only install and configure Docker
+whl-deploy setup docker
+
+# Only install and configure NVIDIA Container Toolkit
+whl-deploy setup nvidia
+
+# Only perform system-level host configurations (e.g., kernel parameters, user groups)
+whl-deploy setup host
+```
+
+#### 3.2. Resource Import & Export - Category Management
+
+`whl_deploy` allows you to manage various Apollo resources separately.
+
+**a. Source Code**
+
+*   **Import Source Code Package**: Imports a zipped Apollo source code archive to a specified location.
+    ```bash
+    whl-deploy import source-code --input=apollo-lite-main.zip
+    ```
+*   **Export Source Code Package**: Packages the source code from the current Apollo environment for reuse elsewhere.
+    ```bash
+    whl-deploy export source-code --output=apollo-main.zip
+    ```
+
+**b. Compiled Cache (Bazel Cache)**
+
+The Bazel compilation cache is crucial for accelerating the Apollo build process.
+
+*   **Import Compiled Cache**: Imports a pre-packaged Bazel cache.
+    ```bash
+    whl-deploy import cache --input=bazel_cache.tar.gz
+    ```
+*   **Export Compiled Cache**: Exports the current Bazel cache for use across multiple machines or in future deployments.
+    ```bash
+    whl-deploy export cache --output=bazel_cache.tar.gz
+    ```
+
+**c. Docker Images**
+
+Manage Apollo's core container images.
+
+*   **Import Docker Image**: Imports a Docker image from a `.tar` file. This is useful for offline deployments or pre-loading images.
+    ```bash
+    whl-deploy import docker-image --input=whl_docker_image.tar
+    ```
+*   **Export Docker Image**:
+    *   **Export information about all currently recognized Apollo-related Docker images**:
+        ```bash
+        whl-deploy export docker-image --info
+        ```
+    *   **Export a specific Docker image to a `.tar` file**:
+        ```bash
+        whl-deploy export docker-image --input=nvidia/cuda:11.8.0-cudnn8-devel-ubuntu20.04 --output=cuda_image.tar
+        ```
+        *   **Note**: Here, the `--input` parameter should specify the **name and tag of the image to be exported**. For example, to export an Apollo development image, use: `whl-deploy export docker-image --input=apollo:dev-latest --output=apollo_dev.tar`
+
+**d. High-Definition Maps (HD Maps) (TODO - To Be Implemented)**
+
+*   `whl-deploy import hd-maps --input=...`
+*   `whl-deploy export hd-maps --output=...`
+
+**e. AI Models (TODO - To Be Implemented)**
+
+*   `whl-deploy import models --input=...`
+*   `whl-deploy export models --output=...`
+
+## 🤝 Contribution & Support
+
+`whl_deploy` aims to simplify Apollo deployment. If you have any questions, suggestions, or wish to contribute code, feel free to submit an Issue or a Pull Request.

whl_deploy-0.0.1/README.md

@@ -0,0 +1,130 @@
+# whl_deploy
+
+`whl_deploy` is a powerful tool **designed specifically for Apollo deployment**, aiming to significantly simplify the setup of Apollo environments and the import/export of resources. By automating key steps, `whl_deploy` ensures an efficient, consistent, and seamless Apollo deployment experience.
+
+## ✨ Key Features
+
+`whl_deploy` provides three core functionalities, covering the essential aspects of the Apollo deployment lifecycle:
+
+1.  **Automated Environment Setup**: Installs and configures Docker, NVIDIA Container Toolkit, and optimizes the system, providing an ideal environment for Apollo.
+2.  **Apollo Resource Import**: Unified import of core Apollo components, including Docker images, source code, AI models, high-definition maps, and compiled caches, drastically reducing initial setup and startup times.
+3.  **Resource Packaging & Distribution**: Packages pre-configured or downloaded Apollo resources into reusable bundles, facilitating rapid deployment across multiple machines, especially useful in offline environments.
+
+## 🚀 Quick Start
+
+This section guides you on how to quickly install and use `whl_deploy`, focusing on the most common end-to-end deployment flow.
+
+### 1. Installation
+
+To ensure compatibility, please upgrade your `setuptools` and `pip` first:
+
+```bash
+# Highly Recommended: Upgrade setuptools and pip first
+pip install setuptools -U
+pip install --upgrade pip
+
+# Install whl-deploy
+pip install whl-deploy
+```
+
+### 2. End-to-End Deployment - Express Mode!
+
+The following two commands are the essence of `whl_deploy`, covering the vast majority of Apollo deployment scenarios:
+
+#### Step A: Prepare Host Environment
+
+This command will automatically install Docker, the NVIDIA Container Toolkit, and perform necessary system configurations. This is the foundation for running Apollo.
+
+```bash
+whl-deploy setup all
+```
+
+#### Step B: Import Apollo Resources
+
+After setting up the environment, you can import all pre-packaged core Apollo resources, such as source code, Docker images, AI models, etc., with a single command. **Please ensure your `source` package is ready.**
+
+```bash
+whl-deploy import all --package=source
+```
+
+---
+
+### 3. More Granular Control
+
+If you require more fine-grained control, `whl_deploy` also provides individual commands.
+
+#### 3.1. Host Environment Configuration - Step-by-Step
+
+In some cases, you might want to configure the host environment step-by-step:
+
+```bash
+# Only install and configure Docker
+whl-deploy setup docker
+
+# Only install and configure NVIDIA Container Toolkit
+whl-deploy setup nvidia
+
+# Only perform system-level host configurations (e.g., kernel parameters, user groups)
+whl-deploy setup host
+```
+
+#### 3.2. Resource Import & Export - Category Management
+
+`whl_deploy` allows you to manage various Apollo resources separately.
+
+**a. Source Code**
+
+*   **Import Source Code Package**: Imports a zipped Apollo source code archive to a specified location.
+    ```bash
+    whl-deploy import source-code --input=apollo-lite-main.zip
+    ```
+*   **Export Source Code Package**: Packages the source code from the current Apollo environment for reuse elsewhere.
+    ```bash
+    whl-deploy export source-code --output=apollo-main.zip
+    ```
+
+**b. Compiled Cache (Bazel Cache)**
+
+The Bazel compilation cache is crucial for accelerating the Apollo build process.
+
+*   **Import Compiled Cache**: Imports a pre-packaged Bazel cache.
+    ```bash
+    whl-deploy import cache --input=bazel_cache.tar.gz
+    ```
+*   **Export Compiled Cache**: Exports the current Bazel cache for use across multiple machines or in future deployments.
+    ```bash
+    whl-deploy export cache --output=bazel_cache.tar.gz
+    ```
+
+**c. Docker Images**
+
+Manage Apollo's core container images.
+
+*   **Import Docker Image**: Imports a Docker image from a `.tar` file. This is useful for offline deployments or pre-loading images.
+    ```bash
+    whl-deploy import docker-image --input=whl_docker_image.tar
+    ```
+*   **Export Docker Image**:
+    *   **Export information about all currently recognized Apollo-related Docker images**:
+        ```bash
+        whl-deploy export docker-image --info
+        ```
+    *   **Export a specific Docker image to a `.tar` file**:
+        ```bash
+        whl-deploy export docker-image --input=nvidia/cuda:11.8.0-cudnn8-devel-ubuntu20.04 --output=cuda_image.tar
+        ```
+        *   **Note**: Here, the `--input` parameter should specify the **name and tag of the image to be exported**. For example, to export an Apollo development image, use: `whl-deploy export docker-image --input=apollo:dev-latest --output=apollo_dev.tar`
+
+**d. High-Definition Maps (HD Maps) (TODO - To Be Implemented)**
+
+*   `whl-deploy import hd-maps --input=...`
+*   `whl-deploy export hd-maps --output=...`
+
+**e. AI Models (TODO - To Be Implemented)**
+
+*   `whl-deploy import models --input=...`
+*   `whl-deploy export models --output=...`
+
+## 🤝 Contribution & Support
+
+`whl_deploy` aims to simplify Apollo deployment. If you have any questions, suggestions, or wish to contribute code, feel free to submit an Issue or a Pull Request.

whl_deploy-0.0.1/pyproject.toml

@@ -0,0 +1,54 @@
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "whl-deploy"
+version = "0.0.1"
+description = "A deployment tool for WheelOS."
+readme = "README.md"
+authors = [
+  { name = "daohu527", email = "daohu527@gmail.com" }
+]
+urls = { Homepage = "https://github.com/wheelos-tools/whl-conf", "Bug Tracker" = "https://github.com/wheelos-tools/whl-conf/issues" }
+classifiers = [
+  "Development Status :: 3 - Alpha", # Project's development stage
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3 :: Only", # Python 3 only
+  "License :: OSI Approved :: MIT License", # Specify license type
+  "Operating System :: OS Independent",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Build Tools", # More specific category
+  "Topic :: Utilities"
+]
+
+# Python version requirements.
+requires-python = ">=3.8"
+
+# Runtime dependencies
+dependencies = [
+  "requests",
+  "pyyaml",
+  "tqdm"
+]
+
+# Keywords for PyPI search.
+keywords = ["whl-conf", "wheelos", "configuration-management", "cli-tool"]
+
+[project.scripts]
+# Command-line entry points.
+whl-deploy = "whl_deploy.cli:main"
+
+[tool.setuptools]
+include-package-data = true
+package-dir = { "" = "." } # Root directory for Python packages
+
+[tool.setuptools.packages.find]
+# Automatically discover Python packages.
+where = ["."]
+# exclude = ["tests*", "docs*"]

whl_deploy-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+