From f7014dd8032e6a80f80cd5b2f8b1c141e16cfb0c Mon Sep 17 00:00:00 2001 From: SaeHie Park Date: Thu, 21 Nov 2024 13:31:07 +0900 Subject: [PATCH] DRAFT enable publish of tools/model_explorer_circle on-going draft to enable publish of tools/model_explorer_circle. Signed-off-by: SaeHie Park --- .github/workflows/run-tools-mec-build.yml | 49 +++++ tools/model_explorer_circle/.gitignore | 1 + tools/model_explorer_circle/HOWTO.md | 23 ++ tools/model_explorer_circle/LICENSE | 201 ++++++++++++++++++ tools/model_explorer_circle/MANIFEST.in | 3 + tools/model_explorer_circle/noxfile.py | 52 +++++ tools/model_explorer_circle/pyproject.toml | 26 +++ .../src/circle_adapter/__init__.py | 0 tools/model_explorer_circle/tests/__init__.py | 0 .../tests/test_package.py | 27 +++ 10 files changed, 382 insertions(+) create mode 100644 .github/workflows/run-tools-mec-build.yml create mode 100644 tools/model_explorer_circle/LICENSE create mode 100644 tools/model_explorer_circle/MANIFEST.in create mode 100644 tools/model_explorer_circle/noxfile.py create mode 100644 tools/model_explorer_circle/pyproject.toml create mode 100644 tools/model_explorer_circle/src/circle_adapter/__init__.py create mode 100644 tools/model_explorer_circle/tests/__init__.py create mode 100644 tools/model_explorer_circle/tests/test_package.py diff --git a/.github/workflows/run-tools-mec-build.yml b/.github/workflows/run-tools-mec-build.yml new file mode 100644 index 00000000000..4c9f8eeaab3 --- /dev/null +++ b/.github/workflows/run-tools-mec-build.yml @@ -0,0 +1,49 @@ +name: Run tools/model-explorer-circle build + +on: + push: + branches: + - master + - release/* + paths: + - '.github/workflows/run-tools-mec-build.yml' + - 'tools/model_explorer_circle/**' + - '!**/*.md' + pull_request: + branches: + - master + - release/* + paths: + - '.github/workflows/run-tools-mec-build.yml' + - 'tools/model_explorer_circle/**' + - '!**/*.md' + +defaults: + run: + shell: bash + +jobs: + test: + strategy: + matrix: + python: ['3.10'] # ['3.10', '3.11', '3.12'] + platform: [ubuntu-latest] # [ubuntu-latest, macos-latest, windows-latest] + + runs-on: ${{ matrix.platform }} + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up Python ${{ matrix.python }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python }} + + - name: Install test dependencies + run: python -m pip install --upgrade nox + + - name: Test + run: | + cd tools/model_explorer_circle + python -m nox -s tests-${{ matrix.python }} diff --git a/tools/model_explorer_circle/.gitignore b/tools/model_explorer_circle/.gitignore index 31a8789d950..6207f4a9b72 100644 --- a/tools/model_explorer_circle/.gitignore +++ b/tools/model_explorer_circle/.gitignore @@ -1,2 +1,3 @@ venv src/*.egg-info/ +dist/ diff --git a/tools/model_explorer_circle/HOWTO.md b/tools/model_explorer_circle/HOWTO.md index a663a081f20..d69ec360b7a 100644 --- a/tools/model_explorer_circle/HOWTO.md +++ b/tools/model_explorer_circle/HOWTO.md @@ -8,3 +8,26 @@ flatc -p --gen-onefile --gen-object-api circle_schema.fbs ``` * Note: For `--gen-onefile` option, you need to use the latest version of `flatc`. (tested version = v24.3.25) + +## How to local build with nox + +Use separate virtual-env and enter. +``` +python3 -m venv venv +source venv/bin/activate +``` + +Install `nox` +``` +python -m pip install --upgrade nox +``` + +To test with python 3.10, +``` +python -m nox -s tests-3.10 +``` + +Run lint (format checker with flake8) +``` +python -m nox -s lint +``` diff --git a/tools/model_explorer_circle/LICENSE b/tools/model_explorer_circle/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/tools/model_explorer_circle/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/tools/model_explorer_circle/MANIFEST.in b/tools/model_explorer_circle/MANIFEST.in new file mode 100644 index 00000000000..f26379c3d41 --- /dev/null +++ b/tools/model_explorer_circle/MANIFEST.in @@ -0,0 +1,3 @@ +graft src + +global-exclude *~ *.py[cod] HOWTO.md diff --git a/tools/model_explorer_circle/noxfile.py b/tools/model_explorer_circle/noxfile.py new file mode 100644 index 00000000000..3b7d483ead7 --- /dev/null +++ b/tools/model_explorer_circle/noxfile.py @@ -0,0 +1,52 @@ +# Copyright (c) 2024 Samsung Electronics Co., Ltd. All Rights Reserved +# +# 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. + +import os +import nox + +nox.options.sessions = ["lint"] + +# Define the minimal nox version required to run +nox.options.needs_version = ">= 2024.3.2" + + +@nox.session +def lint(session): + # NOTE no need to run lint as format checker runs with yapf including this project + session.install("yapf==0.40.2") + session.run("yapf", "--verbose", "--in-place", "--recursive", "--exclude", + "src/circle_adapter/circle_schema_generated.py", "noxfile.py", "./src", + "./tests") + + +@nox.session +def build_and_check_dists(session): + session.install("build", "check-manifest >= 0.42", "twine") + + session.run("check-manifest", "--ignore", "noxfile.py,tests/**") + session.run("python", "-m", "build") + session.run("python", "-m", "twine", "check", "dist/*") + + +@nox.session(python=["3.10"]) +def tests(session): + session.install("pytest") + build_and_check_dists(session) + + generated_files = os.listdir("dist/") + generated_sdist = os.path.join("dist/", generated_files[1]) + + session.install(generated_sdist) + + session.run("py.test", "tests/", *session.posargs) diff --git a/tools/model_explorer_circle/pyproject.toml b/tools/model_explorer_circle/pyproject.toml new file mode 100644 index 00000000000..7bff3800863 --- /dev/null +++ b/tools/model_explorer_circle/pyproject.toml @@ -0,0 +1,26 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "model-explorer-circle" +version = "0.0.1" +authors = [ + { name="NNFW", email="nnfw@samsung.com" }, +] +maintainers = [ + { name="NNFW", email="nnfw@samsung.com" }, +] +description = "Model Explorer Circle Adaptor" +readme = "README.md" +requires-python = ">=3.10" +license = { file = "LICENSE" } +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: Apache Software License", + "Operating System :: OS Independent", +] + +[project.urls] +"Homepage" = "https://github.com/Samsung/ONE/tree/master/tools/model_explorer_circle/" +"Bug Reports" = "https://github.com/Samsung/ONE/issues" diff --git a/tools/model_explorer_circle/src/circle_adapter/__init__.py b/tools/model_explorer_circle/src/circle_adapter/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/tools/model_explorer_circle/tests/__init__.py b/tools/model_explorer_circle/tests/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/tools/model_explorer_circle/tests/test_package.py b/tools/model_explorer_circle/tests/test_package.py new file mode 100644 index 00000000000..094e8af69e3 --- /dev/null +++ b/tools/model_explorer_circle/tests/test_package.py @@ -0,0 +1,27 @@ +# Copyright (c) 2024 Samsung Electronics Co., Ltd. All Rights Reserved +# +# 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. + +import unittest + +import circle_adapter.main as ca + + +class SimpleTestPackage(unittest.TestCase): + def test_package(self): + pkg = ca.CircleAdapter() + print(pkg) + + +if __name__ == '__main__': + unittest.main()