diff --git a/.github/workflows/ci_plugins.yaml b/.github/workflows/ci_plugins.yaml index a9cd53522..4e99ee185 100644 --- a/.github/workflows/ci_plugins.yaml +++ b/.github/workflows/ci_plugins.yaml @@ -4,6 +4,8 @@ on: pull_request: branches: - main + paths: # run this action only when the docs folder is changed + - 'plugins/**' jobs: plugin_update_check: @@ -85,7 +87,11 @@ jobs: - name: Plugin Testing run: | export PYTHONPATH=./ - pytest --cov=superduper --cov-report=xml plugins/${{ matrix.plugin }}/plugin_test + if [ -f "plugins/${{ matrix.plugin }}/plugin_test" ]; then + pytest --cov=superduper --cov-report=xml plugins/${{ matrix.plugin }}/plugin_test + else + echo "Skipping tests for ${{ matrix.plugin }}, no test file found." + fi - name: Optionally run the base testing run: | diff --git a/.github/workflows/release_plugins.yaml b/.github/workflows/release_plugins.yaml new file mode 100644 index 000000000..672ecbfe3 --- /dev/null +++ b/.github/workflows/release_plugins.yaml @@ -0,0 +1,81 @@ +name: Release in Pypi/DockerHub +on: + push: + branches: + - main + paths: # run this action only when the docs folder is changed + - 'plugins/**' + +jobs: + plugin_update_check: + if: ${{ startsWith(github.event.head_commit.message, '[PLUGINS] Bump Version') }} + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Extract plugin names from commit message + id: set-matrix + run: | + commit_message="${{ github.event.head_commit.message }}" + echo "Commit message: $commit_message" + plugin_names=$(echo "$commit_message" | grep -oP '\[PLUGINS\] Bump Version \[\K[^\]]+') + + if [[ "$plugin_names" == "all" ]]; then + echo "Processing all plugins..." + plugin_list=$(find plugins/* -maxdepth 0 -type d ! -name 'template' -exec basename {} \;) + else + # Remove spaces around '|', then split by '|' + plugin_names=$(echo "$plugin_names" | sed 's/ *| */|/g') + IFS='|' read -ra plugins <<< "$plugin_names" + plugin_list=("${plugins[@]}") + fi + matrix_json=$(printf '%s\n' "${plugin_list[@]}" | jq -R -s -c '{plugin: split("\n")[:-1]}') + echo "matrix_json=$matrix_json" + echo "Matrix JSON: $matrix_json" + echo "matrix=$matrix_json" >> $GITHUB_OUTPUT + + outputs: + matrix: ${{ steps.set-matrix.outputs.matrix }} + + release_plugin: + needs: plugin_update_check + runs-on: ubuntu-latest + environment: publish-pypi + strategy: + fail-fast: false + matrix: ${{fromJson(needs.plugin_update_check.outputs.matrix)}} + permissions: + id-token: write + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Python 3.10 + id: setup-python + uses: actions/setup-python@v4 + with: + python-version: '3.10' + + - name: Install dependencies + run: python -m pip install --upgrade build + + - name: Build + run: python -m build plugins/${{ matrix.plugin }} + + + - name: Test package + run: | + python -m pip install '.' + python -m pip install plugins/${{ matrix.plugin }}/dist/*.whl + python -c "import superduper_${{ matrix.plugin }} as p; print(p.__version__)" + + - uses: actions/download-artifact@v3 + # Try uploading to Test PyPI first, in case something fails. + - uses: pypa/gh-action-pypi-publish@release/v1 + with: + repository-url: https://test.pypi.org/legacy/ + packages-dir: plugins/${{ matrix.plugin }}/dist/ + + - uses: pypa/gh-action-pypi-publish@release/v1 + with: + packages-dir: plugins/${{ matrix.plugin }}/dist/ diff --git a/plugins/dummy/LICENSE b/plugins/dummy/LICENSE new file mode 100644 index 000000000..a48ac85f9 --- /dev/null +++ b/plugins/dummy/LICENSE @@ -0,0 +1,202 @@ + + 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 [2023] [SuperDuperDB, Inc.] + + 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/plugins/dummy/pyproject.toml b/plugins/dummy/pyproject.toml new file mode 100644 index 000000000..c3a137e0b --- /dev/null +++ b/plugins/dummy/pyproject.toml @@ -0,0 +1,74 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "superduper_dummy" +readme = "README.md" +license = {file = "LICENSE"} +maintainers = [{name = "superduper.io, Inc.", email = "opensource@superduper.io"}] +keywords = [ + "databases", + "mongodb", + "data-science", + "machine-learning", + "mlops", + "vector-database", + "ai", +] +requires-python = ">=3.10" +dynamic = ["version"] +dependencies = [ +] + +[project.urls] +homepage = "https://www.superduper.com/" +documentation = "https://docs.superduper.com" +source = "https://github.com/superduper.io/superduper/" + +[tool.setuptools.packages.find] +include = ["superduper_dummy*"] + +[tool.setuptools.dynamic] +version = {attr = "superduper_dummy.__version__"} + +[tool.black] +skip-string-normalization = true +target-version = ["py38"] + +[tool.mypy] +ignore_missing_imports = true +no_implicit_optional = true +warn_unused_ignores = true +disable_error_code = ["has-type", "attr-defined", "assignment", "misc", "override", "call-arg"] + +[tool.pytest.ini_options] +addopts = "-W ignore" + +[tool.ruff.lint] +extend-select = [ + "I", # Missing required import (auto-fixable) + "F", # PyFlakes + #"W", # PyCode Warning + "E", # PyCode Error + #"N", # pep8-naming + "D", # pydocstyle +] +ignore = [ + "D100", # Missing docstring in public module + "D104", # Missing docstring in public package + "D107", # Missing docstring in __init__ + "D105", # Missing docstring in magic method + "D203", # 1 blank line required before class docstring + "D212", # Multi-line docstring summary should start at the first line + "D213", # Multi-line docstring summary should start at the second line + "D401", + "E402", +] + +[tool.ruff.lint.isort] +combine-as-imports = true + +[tool.ruff.lint.per-file-ignores] +"test/**" = ["D"] +"plugin_test/**" = ["D"] diff --git a/plugins/dummy/superduper_dummy/__init__.py b/plugins/dummy/superduper_dummy/__init__.py new file mode 100644 index 000000000..2d4385c8a --- /dev/null +++ b/plugins/dummy/superduper_dummy/__init__.py @@ -0,0 +1,3 @@ +__version__ = '0.0.1' + +print("This is a dummy package.") diff --git a/plugins/ibis/pyproject.toml b/plugins/ibis/pyproject.toml index e24feef1d..63bc66130 100644 --- a/plugins/ibis/pyproject.toml +++ b/plugins/ibis/pyproject.toml @@ -19,12 +19,14 @@ keywords = [ requires-python = ">=3.10" dynamic = ["version"] dependencies = [ - "ibis-framework>=9.0.1" + "ibis-framework[sqlite]>=9.0.1", + "click", + 'pandas', + "sqlalchemy" ] [project.optional-dependencies] test = [ - "ibis-framework[sqlite]>=5.1.0", # Annotation plugin dependencies will be installed in CI # :CI: plugins/sqlalchemy ] diff --git a/plugins/ibis/superduper_ibis/data_backend.py b/plugins/ibis/superduper_ibis/data_backend.py index 1da150f46..0d1efe7cc 100644 --- a/plugins/ibis/superduper_ibis/data_backend.py +++ b/plugins/ibis/superduper_ibis/data_backend.py @@ -12,7 +12,6 @@ from superduper.backends.base.data_backend import BaseDataBackend from superduper.backends.base.metadata import MetaDataStoreProxy from superduper.backends.local.artifacts import FileSystemArtifactStore -from superduper.backends.sqlalchemy.metadata import SQLAlchemyMetadata from superduper.base.enums import DBType from superduper.components.datatype import DataType from superduper.components.schema import Schema @@ -96,6 +95,7 @@ def build_artifact_store(self): def build_metadata(self): """Build metadata for the database.""" + from superduper.backends.sqlalchemy.metadata import SQLAlchemyMetadata def callback(): return self.conn.con, self.name diff --git a/plugins/mongodb/pyproject.toml b/plugins/mongodb/pyproject.toml index 231dbd19d..49f6c0fce 100644 --- a/plugins/mongodb/pyproject.toml +++ b/plugins/mongodb/pyproject.toml @@ -20,7 +20,8 @@ requires-python = ">=3.10" dynamic = ["version"] dependencies = [ "mongomock", - "pymongo" + "pymongo", + "click", ] [project.urls] diff --git a/plugins/sklearn/pyproject.toml b/plugins/sklearn/pyproject.toml index 5d6b0fe9f..b6e237160 100644 --- a/plugins/sklearn/pyproject.toml +++ b/plugins/sklearn/pyproject.toml @@ -19,6 +19,7 @@ keywords = [ requires-python = ">=3.10" dynamic = ["version"] dependencies = [ + "scikit-learn>=1.2.2", ] [project.optional-dependencies] diff --git a/plugins/template/workflow.yml b/plugins/template/workflow.yml deleted file mode 100644 index fa52ddae9..000000000 --- a/plugins/template/workflow.yml +++ /dev/null @@ -1,62 +0,0 @@ -name: Code Testing #PLUGIN - -on: - pull_request: - branches: - - main - paths: # Paths that may affect code quality - - "plugins/#PLUGIN/**" - -jobs: - # --------------------------------- - # Unit Testing - # --------------------------------- - unit_testing_#PLUGIN: - runs-on: ${{ matrix.os }} - strategy: - fail-fast: false - matrix: - os: [ "ubuntu-latest" ] - python-version: ["3.11"] - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - #--------------------------------------------------- - # Configuring Python environments. - # - # We cache both the pip packages and the installation dir. - # If the pyproject remains unchanged, we re-use the existing installation dir. - # If the pyproject has changed, we reinstall everything using the cached pip packages. - - name: Cache Pip Packages - id: setup-python - uses: actions/setup-python@v4 - with: - python-version: ${{ matrix.python-version }} - cache: 'pip' # caching pip dependencies - - - name: Check for test directory - id: check_test_dir - run: | - if [ ! -d "plugins/#PLUGIN/test" ]; then - echo "Test directory does not exist. Cancelling workflow." - exit 1 - fi - - - name: Cache Python Installation - uses: actions/cache@v4 - with: - path: ${{ env.pythonLocation }} # Cache the whole python installation dir. - key: ${{ matrix.os }}_python-${{ matrix.python-version }}_${{ hashFiles('pyproject.toml', '*/pyproject.toml') }} - #--------------------------------------------------- - - - name: Install SuperDuperDB Project - run: | - # Install core and testsuite dependencies on the cached python environment. - python -m pip install . - cd plugins/#PLUGIN && python -m pip install . - - - name: Run tests - run: | - python -m pip install pytest - cd plugins/#PLUGIN && pytest test