build: optimize dependencies management (#120)

* build: optimize dependencies management

* build: drop deprecated sections

* fix: correct typo and commands

* refactor: optimize pyproject.toml

* ci: add Python release testing workflow

* build: optimize version constraints and optional groups

* fix: update patch paths for SentenceChunker and QdrantClient in tests

* ci: enhance dependency and building test

* docs: update installation instructions

* fix: move ruff dependency to test group

* fix: specify encoding

* fix: refine wheel and sdist installation steps for OS-specific handling

* fix: update Windows installation commands to use PowerShell syntax

* chore: add comments for clarity in Python tests workflow

* fix: report slowest tests

* ci: support macos-13 as much as possible

* fix: macos-13 testing

* chore: add comments

* chore: update comments in pyproject.toml

* docs: support all platforms

* fix: poetry update

* fix: move scikit-learn and qdrant-client

* docs: clarify optional dependencies

---------

Co-authored-by: CaralHsi <caralhsi@gmail.com>

.github/workflows/python-tests.yml

@@ -26,6 +26,7 @@ jobs:
         os:
           - "ubuntu-latest"
           - "windows-latest"
+          - "macos-13"
           - "macos-14"
           - "macos-15"
           # Ref: https://docs.github.com/en/actions/how-tos/writing-workflows/choosing-where-your-workflow-runs/choosing-the-runner-for-a-job
@@ -46,13 +47,54 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
         cache: 'poetry'
-    - name: Install dependencies
+
+    # Dependency and building tests
+    - name: Install main dependencies
+      run: |
+        poetry install --no-root --no-interaction
+    - name: Check no top-level optional dependencies
+      run: |
+        poetry run python scripts/check_dependencies.py
+    - name: Build sdist and wheel
+      run: poetry build
+    - name: Test wheel installation on Windows
+      if: startsWith(matrix.os, 'windows')
+      run: |
+        Get-ChildItem dist/*.whl | ForEach-Object { pip install $_.FullName }
+        pip uninstall -y memoryos
+    - name: Test wheel installation on Linux / Mac
+      if: ${{ !startsWith(matrix.os, 'windows') }}
+      run: |
+        pip install dist/*.whl
+        pip uninstall -y memoryos
+    - name: Test sdist installation on Windows
+      if: startsWith(matrix.os, 'windows')
       run: |
-        poetry install --no-interaction --with dev --with test
-    - name: Test with ruff
+        Get-ChildItem dist/*.tar.gz | ForEach-Object { pip install $_.FullName }
+        pip uninstall -y memoryos
+    - name: Test sdist installation on Linux / Mac
+      if: ${{ !startsWith(matrix.os, 'windows') }}
+      run: |
+        pip install dist/*.tar.gz
+        pip uninstall -y memoryos
+
+    # Ruff checks
+    - name: Install test group dependencies
+      run: |
+        poetry install --no-interaction --with test
+    - name: Ruff checks
       run: |
         poetry run ruff check
         poetry run ruff format --check
-    - name: Test with pytest
+
+    # PyTest checks
+    - name: Install all extra dependencies
+      # macos-13 doesn't support torch==2.7.1
+      # So, pytest won't work
+      if: ${{ !startsWith(matrix.os, 'macos-13') }}
+      run: |
+        poetry install --no-interaction --extras all
+    - name: PyTest unit tests
+      if: ${{ !startsWith(matrix.os, 'macos-13') }}
       run: |
-        poetry run pytest tests -vv
+        poetry run pytest tests -vv --durations=10

Makefile

@@ -1,7 +1,7 @@
 .PHONY: test
 
 install:
-	poetry install --with dev --with test
+	poetry install --extras all --with dev --with test
 	poetry run pre-commit install --install-hooks
 
 clean:

README.md

@@ -17,6 +17,9 @@
     <a href="https://pypi.org/project/MemoryOS">
       <img src="https://img.shields.io/pypi/pyversions/MemoryOS.svg" alt="Supported Python versions">
     </a>
+    <a href="https://pypi.org/project/MemoryOS">
+      <img src="https://img.shields.io/badge/Platform-Linux%20%7C%20macOS%20%7C%20Windows-lightgrey" alt="Supported Platforms">
+    </a>
     <a href="https://memos-docs.openmem.net/home/overview/">
       <img src="https://img.shields.io/badge/Documentation-view-blue.svg" alt="Documentation">
     </a>
@@ -138,34 +141,37 @@ For more detailed examples, please check out the [`examples`](./examples) direct
 
 ## 📦 Installation
 
-> [!WARNING]
-> MemOS is compatible with Linux, Windows, and macOS.
->
-> However, if you're using macOS, please note that there may be dependency issues that are difficult to resolve.
->
-> For example, compatibility with macOS 13 Ventura is currently challenging.
-
 ### Install via pip
 
 ```bash
 pip install MemoryOS
 ```
 
-### Development Install
+### Optional Dependencies
+
+MemOS provides several optional dependency groups for different features. You can install them based on your needs.
+
+| Feature               | Package Name              |
+| --------------------- | ------------------------- |
+| Tree Memory           | `MemoryOS[tree-mem]`      |
+| Memory Reader         | `MemoryOS[mem-reader]`    |
+| Memory Scheduler      | `MemoryOS[mem-scheduler]` |
 
-To contribute to MemOS, clone the repository and install it in editable mode:
+Example installation commands:
 
 ```bash
-git clone https://github.com/MemTensor/MemOS.git
-cd MemOS
-make install
+pip install MemoryOS[tree-mem]
+pip install MemoryOS[tree-mem,mem-reader]
+pip install MemoryOS[mem-scheduler]
+pip install MemoryOS[tree-mem,mem-reader,mem-scheduler]
 ```
 
-### Optional Dependencies
+### External Dependencies
 
 #### Ollama Support
 
 To use MemOS with [Ollama](https://ollama.com/), first install the Ollama CLI:
+
 ```bash
 curl -fsSL https://ollama.com/install.sh | sh
 ```

evaluation/README.md

@@ -12,7 +12,7 @@ This repository provides tools and scripts for evaluating the LoCoMo dataset usi
 
 2. Install the required dependencies:
    ```bash
-   poetry install --with eval
+   poetry install --extras all --with eval
    ```
 
 ## Configuration