Remove API client from LightlySSL

.github/workflows/test.yml

@@ -57,15 +57,13 @@ jobs:
         if: matrix.python == '3.7'
         run: |
           source .venv/bin/activate
-          export LIGHTLY_SERVER_LOCATION="localhost:-1"
-          python -m pytest -s -v --runslow --ignore=./lightly/openapi_generated/
+          python -m pytest -s -v --runslow
       - name: Run Pytest with Coverage (Python 3.12)
         if: matrix.python == '3.12'
         run: |
           source .venv/bin/activate
-          export LIGHTLY_SERVER_LOCATION="localhost:-1"
           uv pip install pytest-cov==5.0.0
-          python -m pytest -s -v --runslow --cov=./lightly --cov-report=xml --ignore=./lightly/openapi_generated/
+          python -m pytest -s -v --runslow --cov=./lightly --cov-report=xml
       - name: Upload Coverage to Codecov
         if: matrix.python == '3.12'
         uses: codecov/codecov-action@v4

.github/workflows/test_minimal_deps.yml

@@ -50,5 +50,4 @@ jobs:
       - name: Run Tests
         run: |
           source .venv/bin/activate
-          export LIGHTLY_SERVER_LOCATION="localhost:-1"
           python -m pytest -s -v --runslow

.github/workflows/test_setup.yml

@@ -49,17 +49,14 @@ jobs:
       - name: Test CLI
         run: |
           source .venv/bin/activate
-          LIGHTLY_SERVER_LOCATION="localhost:-1"
           lightly-crop --help
           lightly-ssl-train --help
           lightly-embed --help
           lightly-magic --help
-          lightly-download --help
           lightly-version
       - name: Test CLI on Dataset
         run: |
           source .venv/bin/activate
-          LIGHTLY_SERVER_LOCATION="localhost:-1"
           git clone https://github.com/alexeygrigorev/clothing-dataset-small clothing_dataset_small
           INPUT_DIR_1="clothing_dataset_small/test/dress"
           lightly-ssl-train input_dir=$INPUT_DIR_1 trainer.max_epochs=1 loader.num_workers=6

Makefile

@@ -130,14 +130,6 @@ install-dev:
 	pre-commit install
 
 
-# Install package with API dependencies only.
-# Should be same command as in the docs with some extra flags for CI:
-# https://docs.lightly.ai/docs/install-lightly#install-the-lightly-python-client
-.PHONY: install-api-only
-install-api-only:
-	uv pip install --exclude-newer ${EXCLUDE_NEWER_DATE} --requirement requirements/base.txt
-	uv pip install --exclude-newer ${EXCLUDE_NEWER_DATE} . --no-deps
-
 # Install package with minimal dependencies.
 # 
 # This command is split into multiple steps:

README.md

@@ -23,7 +23,7 @@ a single command, please contact sales@lightly.ai.
 
 We've also built a whole platform on top, with additional features for active learning
 and [data curation](https://docs.lightly.ai/docs/what-is-lightly). If you're interested in the
-Lightly Worker Solution to easily process millions of samples and run [powerful algorithms](https://docs.lightly.ai/docs/customize-a-selection)
+LightlyStudio, our all-in-one product for [data curation and labeling](https://docs.lightly.ai/studio/)
 on your data, check out [lightly.ai](https://www.lightly.ai). It's free to get started!
 
 ## News 🚀
@@ -444,7 +444,7 @@ You can find out more about the company and it's services by following the links
 - [Homepage](https://www.lightly.ai)
 - [LightlyTrain](https://docs.lightly.ai/train/stable/index.html)
 - [Web-App](https://app.lightly.ai)
-- [Lightly Solution Documentation (Lightly Worker & API)](https://docs.lightly.ai/)
+- [LightlyStudio](https://docs.lightly.ai/studio/)
 - [Lightly's AwesomeSSL](https://github.com/lightly-ai/awesome-self-supervised-learning) (collection of SSL papers)
 
 [Back to top🚀](#top)

docs/source/getting_started/command_line_tool.rst

@@ -180,33 +180,6 @@ The embeddings.csv file should look like the following:
     101101-1.jpg,-67.958,-2.800,-28.861,103.812,0
     101146-1.jpg,-59.831,-2.719,-25.413,90.945,0
 
-Download data using the CLI
------------------------------------------------
-You can download a dataset with a given tag from the Lightly Platform using the 
-following CLI command. The CLI provides you with three options:
-
-* Download the list of filenames for a given tag in the dataset.
-
-* Download the images for a given tag in the dataset.
-
-* Copy the images for a given tag from an input directory to a target directory.
-
-The last option allows you to very quickly extract only the images in a given tag
-without the need to download them explicitly.
-
-.. code-block:: bash
-
-    # download a list of files
-    lightly-download tag_name=my_tag_name dataset_id=your_dataset_id token=your_token
-
-    # download the images and store them in an output directory
-    lightly-download tag_name=my_tag_name dataset_id=your_dataset_id token=your_token \
-                     output_dir=path/to/output/dir
-
-    # copy images from an input directory to an output directory
-    lightly-download tag_name=my_tag_name dataset_id=your_dataset_id token=your_token \
-                     input_dir=path/to/input/dir output_dir=path/to/output/dir
-
 .. _ref-breakdown-lightly-magic:
 
 Breakdown of lightly-magic

docs/source/index.rst

@@ -103,7 +103,6 @@ Lightly AI
    :caption: Python API
 
    lightly
-   lightly.api
    lightly.cli
    lightly.core
    lightly.data

docs/source/lightly.cli.rst

@@ -18,11 +18,6 @@ lightly.cli
 .. automodule:: lightly.cli.embed_cli
    :members:
 
-.download_cli
----------------
-.. automodule:: lightly.cli.download_cli
-   :members:
-
 .version_cli
 -------------
 .. automodule:: lightly.cli.version_cli

lightly/__init__.py

@@ -9,15 +9,10 @@
 
 The framework is structured into the following modules:
 
-- **api**:
-
-  The lightly.api module handles communication with the Lightly web-app.
-
 - **cli**:
 
   The lightly.cli module provides a command-line interface for training
-  self-supervised models and embedding images. Furthermore, the command-line
-  tool can be used to upload and download images from/to the Lightly web-app.
+  self-supervised models and creating embeddings.
 
 - **core**:
 
@@ -76,17 +71,3 @@
 
 __name__ = "lightly"
 __version__ = "1.5.24"
-
-
-import os
-
-if os.getenv("LIGHTLY_DID_VERSION_CHECK", "False") == "False":
-    os.environ["LIGHTLY_DID_VERSION_CHECK"] = "True"
-    import multiprocessing
-
-    if multiprocessing.current_process().name == "MainProcess":
-        from lightly.api import _version_checking
-
-        _version_checking.check_is_latest_version_in_background(
-            current_version=__version__
-        )

lightly/api/__init__.py

@@ -1,15 +1,13 @@
-"""The lightly.api module provides access to the Lightly API."""
+"""Deprecated compatibility module for the removed Lightly API client."""
 
 # Copyright (c) 2020. Lightly AG and its affiliates.
 # All Rights Reserved
-from lightly.api import patch as _patch
-from lightly.api.api_workflow_artifacts import ArtifactNotExist
-from lightly.api.api_workflow_client import ApiWorkflowClient
-from lightly.openapi_generated.swagger_client.api_client import (
-    Configuration as _Configuration,
-)
 
-# Make ApiWorkflowClient and swagger classes picklable.
-_patch.make_swagger_configuration_picklable(
-    configuration_cls=_Configuration,
+_ERROR_MESSAGE = (
+    "lightly.api and ApiWorkflowClient have been removed from the lightly package. "
+    "The API workflow client is deprecated. If you need ApiWorkflowClient, use "
+    "Lightly SSL version v1.15.x or older, for example with "
+    '`pip install "lightly<1.16"`.'
 )
+
+raise ImportError(_ERROR_MESSAGE)