weaviate-cli 2.1.3.dev1__tar.gz → 3.0.0__tar.gz

weaviate_cli-3.0.0/.github/workflows/main.yaml

@@ -0,0 +1,79 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '**'
+  pull_request:
+
+jobs:
+  lint-and-format:
+    name: Run Linter and Formatter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install -r requirements-dev.txt
+      - name: "Black"
+        run: black --check cli.py weaviate_cli test
+      - name: "Check release for pypi"
+        run: |
+          python -m build
+          python -m twine check dist/*
+
+  unit-tests:
+    name: Run Unit Tests
+    needs: [lint-and-format]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: [ "3.9", "3.10", "3.11", "3.12" ]
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.version }}
+    - run: pip install -e .
+    - name: Run unit tests with pytest
+      run: |
+        pip install pytest-html
+        pytest test/unittests --html=test-report-${{ matrix.version }}.html --self-contained-html
+    - name: Upload test results
+      if: always()
+      uses: actions/upload-artifact@v3
+      with:
+        name: test-results-${{ matrix.version }}
+        path: test-report-${{ matrix.version }}.html
+
+  integration-tests:
+    needs: [unit-tests]
+    env:
+      WEAVIATE_VERSION: "1.27.0"
+      MODULES: "text2vec-transformers,text2vec-contextionary"
+    name: Run Integration Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: [ "3.9", "3.10", "3.11", "3.12" ]
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.version }}
+    - run: pip install -e .
+    - name: Start up Weaviate cluster
+      uses: weaviate/weaviate-local-k8s@v2
+      with:
+        workers: 1
+        replicas: 1
+        weaviate-version: ${{ env.WEAVIATE_VERSION }}
+        modules: ${{ env.MODULES }}
+        enable-backup: true
+    - name: Run integration tests with pytest
+      run: |
+        pip install pytest-html
+        pytest test/integration/ --html=test-report-${{ matrix.version }}.html --self-contained-html

weaviate_cli-3.0.0/.github/workflows/release.yaml

@@ -0,0 +1,71 @@
+name: Build and Publish
+
+on:
+  push:
+    tags:
+      - '**'
+
+jobs:
+  build-package:
+    name: Build a package
+    runs-on: ubuntu-latest
+    steps:
+        - name: Checkout
+          uses: actions/checkout@v4
+          with:
+            fetch-depth: 0
+        - name: Set up Python 3.11
+          uses: actions/setup-python@v4
+          with:
+            python-version: "3.11"
+        - name: Install dependencies
+          run: pip install -r requirements-dev.txt
+        - name: Build a binary wheel
+          run: python -m build
+        - name: Create Wheel Artifacts
+          uses: actions/upload-artifact@v4
+          with:
+            path: "dist/*.whl"
+            name: weaviate-cli-wheel
+            retention-days: 30
+  gh-release:
+      name: Create a GitHub Release on new tags
+      needs: [build-package]
+      if: startsWith(github.ref, 'refs/tags')
+      runs-on: ubuntu-latest
+      permissions:
+        contents: write
+      steps:
+        - name: Download build artifact to append to release
+          uses: actions/download-artifact@v4
+          with:
+            name: weaviate-cli-wheel
+            path: dist
+        - name: Release
+          uses: softprops/action-gh-release@v2
+          with:
+            generate_release_notes: true
+            draft: true
+            files: dist/*.whl
+  publish:
+    runs-on: ubuntu-latest
+    needs: [gh-release]
+    steps:
+        - name: Checkout
+          uses: actions/checkout@v4
+          with:
+            fetch-depth: 0
+        - name: Set up Python 3.11
+          uses: actions/setup-python@v5
+          with:
+            python-version: "3.11"
+        - name: Install dependencies
+          run: pip install -r requirements-dev.txt
+        - name: Build a binary wheel
+          run: python -m build
+        - name: Publish distribution 📦 to PyPI on new tags
+          if: startsWith(github.ref, 'refs/tags')
+          uses: pypa/gh-action-pypi-publish@release/v1
+          with:
+            verbose: true
+            password: ${{ secrets.PYPI_API_TOKEN }}

weaviate_cli-3.0.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__
+modules/__pycache__
+dist/
+.venv/
+.vscode/
+.DS_Store
+build/
+.idea
+*.egg-info
+check_weaviate_client_python_version.sh
+.vscode/settings.json

weaviate_cli-3.0.0/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+
+-   repo: https://github.com/psf/black
+    rev: 24.2.0
+    hooks:
+    -   id: black
+        language_version: python3

weaviate_cli-3.0.0/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing to Weaviate CLI
+
+Thank you for looking into contributing to Weaviate CLI! We really appreciate that you are willing to spend some time and effort to make Weaviate better for everyone!
+
+We have a detailed [contributor guide](https://weaviate.io/developers/contributor-guide/current/) as a part of our documentation. If you are new, we recommend reading through the [getting started guide for contributors](https://weaviate.io/developers/contributor-guide/current/getting-started/index.html) after reading this overview.
+
+## Finding a Good First Issue
+We use the `good-first-issue` labels on issues that we think are great to get started. These issues are typically isolated to a specific area of the CLI.
+
+## Prerequisites
+To contribute to Weaviate CLI you should have:
+- Basic Python skills
+- Experience using Weaviate CLI to understand the effects of changes
+- Knowledge of writing tests (see our test files for examples)
+
+## Development Setup
+*Note: The Weaviate team uses Linux and Mac (darwin/arm64) machines exclusively. Development on Windows may lead to unexpected issues.*
+
+1. Fork the repository
+2. Clone your fork
+3. Create a virtual environment:
+    ```bash
+    python -m venv .venv
+    ```
+4. Install development dependencies using Makefile:
+    ```bash
+    make install-dev
+    ```
+
+### Code Style
+- We use Black for code formatting
+- Install development dependencies and pre-commit hooks (if not already installed):
+  ```bash
+  make install-dev
+  ```
+- Before committing, ensure code is formatted:
+  ```bash
+  make format
+  ```
+- CI will check formatting using:
+  ```bash
+  make lint
+  ```
+
+## Tagging Your Commit
+Please tag your commit(s) with the appropriate GH issue that your change refers to, e.g. `gh-9001 reduce memory allocations of ACME widget`. Please also include something in your PR description to indicate which issue it will close, e.g. `fixes #9001` or `closes #9001`.
+
+## Pull Request
+If you open an external pull request our CI pipeline will get started. This external run will not have access to secrets. This prevents people from submitting a malicious PR to steal secrets. As a result, the CI run will be slightly different from an internal one. For example, it will not automatically push a Docker image. If your PR is merged, a container with your changes will be built from the trunk.
+
+## Agreements
+
+### Code of Conduct
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+
+### Contributor License Agreement
+Contributions to Weaviate must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of Weaviate. Go to [this page](https://www.semi.technology/playbooks/misc/contributor-license-agreement.html) to read the current agreement.
+
+The process works as follows:
+- You contribute by opening a [pull request](#pull-request).
+- If you have not contributed before, our bot will ask you to agree with the CLA.
+
+## If in Doubt, Ask
+The Weaviate team consists of some of the nicest people on this planet. If something is unclear or you'd like a second opinion, please don't hesitate to ask. We are glad that you want to help us, so naturally, we will also do our best to help you on this journey.
+
+## Thanks for Contributing!
+We really appreciate your effort in making Weaviate better for everyone!

weaviate_cli-3.0.0/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+COPY . .
+
+RUN apt-get update && apt-get install -y git
+RUN  pip install .
+
+ENTRYPOINT ["python", "cli.py"]

weaviate_cli-3.0.0/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2021, SeMI Technologies B.V.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

weaviate_cli-3.0.0/MANIFEST.in

@@ -0,0 +1 @@
+include weaviate_cli/datasets/*.json

weaviate_cli-3.0.0/Makefile

@@ -0,0 +1,24 @@
+.PHONY: format lint test install-dev
+
+build:
+	python -m build
+
+build-check:
+	python -m twine check dist/*
+
+install-dev:
+	pip install -r requirements-dev.txt
+	pre-commit install
+
+format:
+	black cli.py weaviate_cli test
+
+lint:
+	black --check cli.py weaviate_cli test
+
+test:
+	pytest test/unittests
+
+build-all: build build-check
+
+all: format lint test build-all

weaviate_cli-3.0.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.1
+Name: weaviate-cli
+Version: 3.0.0
+Summary: Command line interface to interact with weaviate
+Home-page: https://github.com/weaviate/weaviate-cli
+Download-URL: https://github.com/weaviate/weaviate-cli
+Author: Weaviate
+Author-email: hello@weaviate.io
+License: BSD 3-clause
+Project-URL: Docs, https://github.com/weaviate/weaviate-cli/blob/main/README.rst
+Project-URL: Bugs, https://github.com/weaviate/weaviate-cli/issues
+Keywords: cli,weaviate
+Platform: Linux
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: License :: OSI Approved :: GNU General Public License (GPL)
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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 :: Implementation :: CPython
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: weaviate-client>=4.5.0
+Requires-Dist: click==8.1.7
+Requires-Dist: semver>=3.0.2
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: importlib-resources>=5.0.0
+
+# Weaviate CLI
+
+<img src="https://raw.githubusercontent.com/semi-technologies/weaviate/19de0956c69b66c5552447e84d016f4fe29d12c9/docs/assets/weaviate-logo.png" width="180" align="right" alt="Weaviate logo">
+
+[![Build Status](https://github.com/weaviate/weaviate-cli/actions/workflows/main.yaml/badge.svg)](https://github.com/weaviate/weaviate-cli/actions/workflows/main.yaml)
+[![PyPI version](https://badge.fury.io/py/weaviate-cli.svg)](https://badge.fury.io/py/weaviate-cli)
+
+A powerful command-line interface for managing and interacting with Weaviate vector databases directly from your terminal.
+
+## Key Features
+- **Collections**: Create, update, delete and get collection configurations
+- **Data Management**: Import, query, update and delete data with various search types (vector, keyword, hybrid)
+- **Multi-tenancy**: Manage tenants and their states across collections
+- **Backup & Restore**: Create and restore backups with support for S3, GCS and filesystem
+- **Sharding**: Monitor and manage collection shards
+- **Flexible Configuration**: Configure vector indexes, replication, consistency levels and more
+
+## Quick Start
+Install using pip:
+
+```bash
+pip install weaviate-cli
+```
+
+## Basic Usage
+
+```bash
+# Show available commands
+weaviate-cli --help
+
+# Create a collection
+weaviate-cli create collection --collection movies --vectorizer transformers
+
+# Import test data
+weaviate-cli create data --collection movies --limit 1000
+
+# Query data
+weaviate-cli query data --collection movies --search-type hybrid --query "action movies"
+```
+
+## Core Commands
+
+- **create**: Create collections, tenants, backups or import data
+- **delete**: Remove collections, tenants or data
+- **update**: Modify collection settings, tenant states or data
+- **get**: Retrieve collection info, tenant details or shard status
+- **query**: Search data using various methods
+- **restore**: Restore backups from supported backends
+
+## Configuration
+
+Weaviate CLI allows you to configure your cluster endpoints and parameters through a configuration file. By default, the CLI looks for a
+configuration file at `~/.config/weaviate/config.json`. If this file does not exist, it will be created with the following default values:
+
+```json
+{
+    "host": "localhost",
+    "http_port": "8080",
+    "grpc_port": "50051"
+}
+```
+
+You can also specify your own configuration file using the `--config-file` option:
+
+```bash
+weaviate-cli --config-file /path/to/your/config.json
+```
+
+The configuration file should be a JSON file with the following structure:
+
+```json
+{
+    "host": "your-weaviate-host",
+    "http_port": "your-http-port",
+    "grpc_port": "your-grpc-port",
+    "auth": {
+        "type": "api_key",
+        "api_key": "your-api-key"
+    }
+}
+```
+
+If you are using a remote Weaviate instance, you can use the `weaviate-cli` command to authenticate with your Weaviate instance.
+Here you can see an example on how the configuration file should look like if you are connecting to a WCD cluster:
+
+```json
+ {
+     "host": "thisisaninventedcluster.url.s3.us-west3.prov.weaviate.cloud",
+     "auth": {
+         "type": "api_key",
+         "api_key": "jfeRFsdfRfSasgsDoNOtTrYToUsErRQwqqdZfghasd"
+     }
+ }
+```
+
+## Requirements
+
+- Python 3.9+
+- Weaviate instance (local or remote)
+
+## Documentation
+
+Detailed documentation will be added soon.
+
+## Community & Support
+
+- [Slack Community](https://weaviate.io/slack) - Join our active community
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/weaviate) - Search using the `weaviate` tag
+- [GitHub Issues](https://github.com/weaviate/weaviate-cli/issues) - Report bugs or request features
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guidelines](https://github.com/weaviate/weaviate-cli/blob/main/CONTRIBUTING.md) for
+details.
+
+## License
+
+BSD-3-Clause License

weaviate_cli-3.0.0/README.md

@@ -0,0 +1,118 @@
+# Weaviate CLI
+
+<img src="https://raw.githubusercontent.com/semi-technologies/weaviate/19de0956c69b66c5552447e84d016f4fe29d12c9/docs/assets/weaviate-logo.png" width="180" align="right" alt="Weaviate logo">
+
+[![Build Status](https://github.com/weaviate/weaviate-cli/actions/workflows/main.yaml/badge.svg)](https://github.com/weaviate/weaviate-cli/actions/workflows/main.yaml)
+[![PyPI version](https://badge.fury.io/py/weaviate-cli.svg)](https://badge.fury.io/py/weaviate-cli)
+
+A powerful command-line interface for managing and interacting with Weaviate vector databases directly from your terminal.
+
+## Key Features
+- **Collections**: Create, update, delete and get collection configurations
+- **Data Management**: Import, query, update and delete data with various search types (vector, keyword, hybrid)
+- **Multi-tenancy**: Manage tenants and their states across collections
+- **Backup & Restore**: Create and restore backups with support for S3, GCS and filesystem
+- **Sharding**: Monitor and manage collection shards
+- **Flexible Configuration**: Configure vector indexes, replication, consistency levels and more
+
+## Quick Start
+Install using pip:
+
+```bash
+pip install weaviate-cli
+```
+
+## Basic Usage
+
+```bash
+# Show available commands
+weaviate-cli --help
+
+# Create a collection
+weaviate-cli create collection --collection movies --vectorizer transformers
+
+# Import test data
+weaviate-cli create data --collection movies --limit 1000
+
+# Query data
+weaviate-cli query data --collection movies --search-type hybrid --query "action movies"
+```
+
+## Core Commands
+
+- **create**: Create collections, tenants, backups or import data
+- **delete**: Remove collections, tenants or data
+- **update**: Modify collection settings, tenant states or data
+- **get**: Retrieve collection info, tenant details or shard status
+- **query**: Search data using various methods
+- **restore**: Restore backups from supported backends
+
+## Configuration
+
+Weaviate CLI allows you to configure your cluster endpoints and parameters through a configuration file. By default, the CLI looks for a
+configuration file at `~/.config/weaviate/config.json`. If this file does not exist, it will be created with the following default values:
+
+```json
+{
+    "host": "localhost",
+    "http_port": "8080",
+    "grpc_port": "50051"
+}
+```
+
+You can also specify your own configuration file using the `--config-file` option:
+
+```bash
+weaviate-cli --config-file /path/to/your/config.json
+```
+
+The configuration file should be a JSON file with the following structure:
+
+```json
+{
+    "host": "your-weaviate-host",
+    "http_port": "your-http-port",
+    "grpc_port": "your-grpc-port",
+    "auth": {
+        "type": "api_key",
+        "api_key": "your-api-key"
+    }
+}
+```
+
+If you are using a remote Weaviate instance, you can use the `weaviate-cli` command to authenticate with your Weaviate instance.
+Here you can see an example on how the configuration file should look like if you are connecting to a WCD cluster:
+
+```json
+ {
+     "host": "thisisaninventedcluster.url.s3.us-west3.prov.weaviate.cloud",
+     "auth": {
+         "type": "api_key",
+         "api_key": "jfeRFsdfRfSasgsDoNOtTrYToUsErRQwqqdZfghasd"
+     }
+ }
+```
+
+## Requirements
+
+- Python 3.9+
+- Weaviate instance (local or remote)
+
+## Documentation
+
+Detailed documentation will be added soon.
+
+## Community & Support
+
+- [Slack Community](https://weaviate.io/slack) - Join our active community
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/weaviate) - Search using the `weaviate` tag
+- [GitHub Issues](https://github.com/weaviate/weaviate-cli/issues) - Report bugs or request features
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guidelines](https://github.com/weaviate/weaviate-cli/blob/main/CONTRIBUTING.md) for
+details.
+
+## License
+
+BSD-3-Clause License

weaviate_cli-3.0.0/cli.py

@@ -0,0 +1,55 @@
+import click
+import sys
+from weaviate_cli.managers.config_manager import ConfigManager
+from weaviate_cli.commands.create import create
+from weaviate_cli.commands.delete import delete
+from weaviate_cli.commands.get import get
+from weaviate_cli.commands.update import update
+from weaviate_cli.commands.query import query
+from weaviate_cli.commands.restore import restore
+from weaviate_cli import __version__
+
+
+def print_version(ctx, param, value):
+    if not value or ctx.resilient_parsing:
+        return
+    click.echo(f"Weaviate CLI version {__version__}")
+    ctx.exit()
+
+
+@click.group()
+@click.option(
+    "--config-file",
+    required=False,
+    default=None,
+    type=str,
+    is_flag=False,
+    help="If specified cli uses the config specified with this path.",
+)
+@click.option(
+    "--version",
+    is_flag=True,
+    callback=print_version,
+    expose_value=False,
+    is_eager=True,
+    help="Prints the version of the CLI.",
+)
+@click.pass_context
+def main(ctx: click.Context, config_file):
+    """Weaviate CLI tool"""
+    try:
+        ctx.obj = {"config": ConfigManager(config_file)}
+    except Exception as e:
+        click.echo(f"Fatal Error: {e}")
+        sys.exit(1)
+
+
+main.add_command(create)
+main.add_command(delete)
+main.add_command(get)
+main.add_command(update)
+main.add_command(restore)
+main.add_command(query)
+
+if __name__ == "__main__":
+    main()

weaviate_cli-3.0.0/publish.md

@@ -0,0 +1,8 @@
+1. Set the new version in the `weaviate/version.py` and `test/test_version.py`.
+2. Run all tests. (Check `test/README.md`)
+3. Check if you are on the correct **GitBranch**.
+4. **Commit** the most current version to GitHub if this has not been done yet.
+5. Give the commit of the current version a proper tag:\
+`git tag -a '<your tag>' -m '<some message for the tag>' && git push --tags`
+Tags are either in the form of `v0.2.5` or `v0.2.5rc0`.
+6. The release workflow defined in `.github/workflows/release.yaml` will take care of building, creating the release, and pushing to PyPI.

weaviate_cli-3.0.0/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = [
+    "setuptools >= 65",
+    "setuptools_scm[toml] >6.2",
+    "wheel >= 0.38.1",
+]
+build-backend = 'setuptools.build_meta'
+
+[tool.setuptools_scm]
+
+[tool.black]
+line-length = 88
+target-version = ['py311']
+include = '\.pyi?$'
+extend-exclude = '''
+# A regex preceded with ^/ will apply only to files and directories
+# in the root of the project.
+^/docs
+'''

weaviate_cli-3.0.0/requirements-dev.txt

@@ -0,0 +1,13 @@
+weaviate-client>=4.0.0
+click==8.1.7
+twine
+pytest
+semver==3.0.2
+numpy>=1.24.0
+build
+wheel
+importlib_metadata==8.5.0
+importlib-resources>=5.0.0
+setuptools_scm
+black==24.3.0
+pre-commit==3.6.2