labtasker 0.2.2__tar.gz → 0.2.3__tar.gz

{labtasker-0.2.2 → labtasker-0.2.3}/.gitignore

@@ -1,3 +1,5 @@
+labtasker_db.json
+
 # Created by https://www.toptal.com/developers/gitignore/api/python
 # Edit at https://www.toptal.com/developers/gitignore?templates=python
 

{labtasker-0.2.2 → labtasker-0.2.3}/Dockerfile

@@ -16,7 +16,10 @@ RUN pip install --no-cache-dir "."
 
 # Health check
 HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
-    CMD curl -f http://localhost:${API_PORT:-8080}/health || exit 1
+    CMD curl -f http://localhost:${API_PORT:-9321}/health || exit 1
+
+# Set DB_MODE to external
+ENV DB_MODE=${DB_MODE:-external}
 
 # Run the application
-CMD ["python", "-m", "labtasker.server.run"]
+CMD ["labtasker-server", "serve"]

{labtasker-0.2.2 → labtasker-0.2.3}/MANIFEST.in

@@ -19,6 +19,8 @@ exclude coverage.xml
 exclude poetry.lock
 exclude poetry.toml
 
+exclude labtasker_db.json
+
 prune .vscode
 prune .github
 

{labtasker-0.2.2 → labtasker-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labtasker
-Version: 0.2.2
+Version: 0.2.3
 Summary: A task queue system for lab experiments
 Author-email: Your Name <your.email@example.com>
 License: Apache License 2.0
@@ -40,11 +40,11 @@ Requires-Dist: sse-starlette<3.0.0,>=2.1.3
 Requires-Dist: httpx-sse<0.5.0,>=0.4.0
 Requires-Dist: stamina<26.0.0,>=25.1.0
 Requires-Dist: noneprompt<0.2.0,>=0.1.9
-Requires-Dist: pytest-sugar<2.0.0,>=1.0.0
+Requires-Dist: mongomock<4.4.0,>=4.3.0
+Requires-Dist: jsonpickle<5.0.0,>=4.0.2
 Provides-Extra: dev
 Requires-Dist: pytest<9.0.0,>=8.0.0; extra == "dev"
 Requires-Dist: pytest-cov<7.0.0,>=5.0.0; extra == "dev"
-Requires-Dist: mongomock<4.4.0,>=4.3.0; extra == "dev"
 Requires-Dist: black<26.0.0,>=24.0.0; extra == "dev"
 Requires-Dist: isort<7.0.0,>=5.13.0; extra == "dev"
 Requires-Dist: mypy<2.0.0,>=1.14.0; extra == "dev"
@@ -56,6 +56,7 @@ Requires-Dist: pytest-asyncio<0.26.0,>=0.24.0; extra == "dev"
 Requires-Dist: asgi-lifespan<3.0.0,>=2.1.0; extra == "dev"
 Requires-Dist: tox<4.25.0,>=4.24.0; extra == "dev"
 Requires-Dist: pytest-dependency<0.7.0,>=0.6.0; extra == "dev"
+Requires-Dist: pytest-sugar<2.0.0,>=1.0.0; extra == "dev"
 Provides-Extra: doc
 Requires-Dist: mkdocs-material<9.7.0,>=9.6.5; extra == "doc"
 Requires-Dist: mkdocs-glightbox<0.5.0,>=0.4.0; extra == "doc"
@@ -66,7 +67,7 @@ Dynamic: license-file
 
 <p align="center"><em>Make your ML experiment wrapper scripts smarter with...</em></p>
 <h1 align="center" style="font-size: 40px;"> <a href="">Labtasker</a></h1>
-<p align="center"><a href="https://fkcptlst.github.io/labtasker/latest/install/install/">Install</a> • <a href="https://fkcptlst.github.io/labtasker/latest/guide/basic/">Tutorial / Demo</a> • <a href="https://fkcptlst.github.io/labtasker/latest/">Documentation</a> • <a href="https://fkcptlst.github.io/labtasker/dev/faq/">FAQs</a> • <a href="https://github.com/fkcptlst/labtasker/releases">Releases</a></p>
+<p align="center"><a href="https://fkcptlst.github.io/labtasker/latest/install/install/">Install</a> • <a href="https://fkcptlst.github.io/labtasker/latest/guide/basic/">Tutorial / Demo</a> • <a href="https://fkcptlst.github.io/labtasker/latest/">Documentation</a> • <a href="https://fkcptlst.github.io/labtasker/latest/faq/">FAQs</a> • <a href="https://github.com/fkcptlst/labtasker/releases">Releases</a></p>
 
 <p align="center">
   <img src="https://github.com/fkcptlst/labtasker/actions/workflows/unit-test-matrix.yml/badge.svg" alt="unit-test-matrix" />
@@ -122,9 +123,10 @@ For more detailed steps, please refer to the content in the [Tutorial / Demo](ht
 
 > [!NOTE]
 > You need a running Labtasker server to use the client tools.
+> Simply use the installed Python CLI `labtasker-server serve` or use docker-compose to deploy the server.
 > See [deployment instructions](https://fkcptlst.github.io/labtasker/latest/install/deployment/).
 
-### 1. Install Client Tools via PyPI
+### 1. Install via PyPI
 
 ```bash
 pip install labtasker
@@ -138,6 +140,12 @@ pip install git+https://github.com/fkcptlst/labtasker.git
 
 ## 🚀 Quick Start
 
+Use the following command to launch a labtasker server in the background:
+
+```bash
+labtasker-server serve &
+```
+
 Use the following command to quickly setup a labtasker queue for your project:
 
 ```bash

{labtasker-0.2.2 → labtasker-0.2.3}/README.md

@@ -1,6 +1,6 @@
 <p align="center"><em>Make your ML experiment wrapper scripts smarter with...</em></p>
 <h1 align="center" style="font-size: 40px;"> <a href="">Labtasker</a></h1>
-<p align="center"><a href="https://fkcptlst.github.io/labtasker/latest/install/install/">Install</a> • <a href="https://fkcptlst.github.io/labtasker/latest/guide/basic/">Tutorial / Demo</a> • <a href="https://fkcptlst.github.io/labtasker/latest/">Documentation</a> • <a href="https://fkcptlst.github.io/labtasker/dev/faq/">FAQs</a> • <a href="https://github.com/fkcptlst/labtasker/releases">Releases</a></p>
+<p align="center"><a href="https://fkcptlst.github.io/labtasker/latest/install/install/">Install</a> • <a href="https://fkcptlst.github.io/labtasker/latest/guide/basic/">Tutorial / Demo</a> • <a href="https://fkcptlst.github.io/labtasker/latest/">Documentation</a> • <a href="https://fkcptlst.github.io/labtasker/latest/faq/">FAQs</a> • <a href="https://github.com/fkcptlst/labtasker/releases">Releases</a></p>
 
 <p align="center">
   <img src="https://github.com/fkcptlst/labtasker/actions/workflows/unit-test-matrix.yml/badge.svg" alt="unit-test-matrix" />
@@ -56,9 +56,10 @@ For more detailed steps, please refer to the content in the [Tutorial / Demo](ht
 
 > [!NOTE]
 > You need a running Labtasker server to use the client tools.
+> Simply use the installed Python CLI `labtasker-server serve` or use docker-compose to deploy the server.
 > See [deployment instructions](https://fkcptlst.github.io/labtasker/latest/install/deployment/).
 
-### 1. Install Client Tools via PyPI
+### 1. Install via PyPI
 
 ```bash
 pip install labtasker
@@ -72,6 +73,12 @@ pip install git+https://github.com/fkcptlst/labtasker.git
 
 ## 🚀 Quick Start
 
+Use the following command to launch a labtasker server in the background:
+
+```bash
+labtasker-server serve &
+```
+
 Use the following command to quickly setup a labtasker queue for your project:
 
 ```bash

{labtasker-0.2.2 → labtasker-0.2.3}/docker-compose.yml

@@ -67,10 +67,10 @@ services:
       - DB_HOST=mongodb
       - DB_PORT=${DB_PORT:-27017}
       - API_HOST=${API_HOST:-0.0.0.0}
-      - API_PORT=${API_PORT:-8080}
+      - API_PORT=${API_PORT:-9321}
       - PERIODIC_TASK_INTERVAL=${PERIODIC_TASK_INTERVAL:-30}
     ports:
-      - "${API_PORT:-8080}:${API_PORT:-8080}"
+      - "${API_PORT:-9321}:${API_PORT:-9321}"
     depends_on:
       mongodb:
         condition: service_healthy

{labtasker-0.2.2 → labtasker-0.2.3}/labtasker/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.2"
+__version__ = "0.2.3"
 
 from labtasker.client.client_api import *
 from labtasker.client.core.config import get_client_config

{labtasker-0.2.2 → labtasker-0.2.3}/labtasker/client/cli/init.py

@@ -83,7 +83,8 @@ def setup_endpoint_url() -> Tuple[str, bool]:
 
     # 1. Prompt
     url = InputPrompt(
-        "URL of your Labtasker server (http://host:port or https://xxx.yyy): ",
+        "URL of your Labtasker server: ",
+        default_text="http://localhost:9321",
         validator=validator,
     ).prompt()
     url = str(HttpUrl(url))
@@ -186,7 +187,9 @@ def setup_queue(base_url, base_url_verified) -> Tuple[str, str]:
     except LabtaskerHTTPStatusError:
         pass
 
-    yes = ConfirmPrompt(question="Would you like to create this queue?").prompt()
+    yes = ConfirmPrompt(
+        question="Would you like to create this queue?", default_choice=True
+    ).prompt()
     if yes:
         try:
             resp = create_queue(queue_name, password, client=client)

{labtasker-0.2.2 → labtasker-0.2.3}/labtasker/client/templates/labtasker_root/client.toml

@@ -5,7 +5,7 @@ enable_traceback_filter = true  # prettify the traceback and filter sensitive co
 version_check = true    # check if current version is obsolete or new version is available (non-blocking, best effort)
 
 [endpoint]
-api_base_url = "http://localhost:8080/"  # change this to your server url
+api_base_url = "http://localhost:9321/"  # change this to your server url
 
 [queue]
 queue_name = "test-queue"  # change this

labtasker-0.2.3/labtasker/server/cli.py

@@ -0,0 +1,90 @@
+import os
+from enum import Enum
+from pathlib import Path
+from typing import Optional
+
+import typer
+import uvicorn
+
+from labtasker.filtering import install_traceback_filter
+from labtasker.server.config import get_server_config, init_server_config
+from labtasker.server.database import DBService, set_db_service
+from labtasker.server.embedded_db import MongoClient, ServerStore
+from labtasker.server.logging import log_config
+
+install_traceback_filter()
+
+cli = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})
+
+
+class DbMode(str, Enum):
+    EMBEDDED = "embedded"
+    EXTERNAL = "external"
+
+
+@cli.callback(invoke_without_command=True)
+def callback(ctx: typer.Context):
+    if not ctx.invoked_subcommand:
+        print(ctx.get_help())
+        raise typer.Exit()
+
+
+@cli.command()
+def serve(
+    host: str = typer.Option(
+        "0.0.0.0", envvar="API_HOST", help="IP address of the server."
+    ),
+    port: int = typer.Option(9321, envvar="API_PORT", help="Port to listen to."),
+    db_mode: DbMode = typer.Option(
+        "embedded", case_sensitive=False, envvar="DB_MODE", help="Database mode."
+    ),
+    db_path: Path = typer.Option(
+        Path("labtasker_db.json"),
+        writable=True,
+        readable=True,
+        help="Path to the database persistence file.",
+    ),
+    env_file: Optional[Path] = typer.Option(
+        None,
+        help="Path to the server.env file to load.",
+    ),
+):
+    """Create a local server with a Python emulated MongoDB.
+    (It is recommended to use the docker compose instead of this.)
+    """
+    if db_mode == "embedded":
+        # authentication is not needed, as we are using Python emulated embedded DB
+        os.environ["DB_USER"] = "admin"
+        os.environ["DB_PASSWORD"] = "admin"
+
+    os.environ["API_HOST"] = host
+    os.environ["API_PORT"] = str(port)
+
+    init_server_config(env_file)
+    config = get_server_config()
+
+    if db_mode == "embedded":
+        set_db_service(
+            DBService(
+                db_name=config.db_name,
+                client=MongoClient(
+                    _store=ServerStore(persistence_path=str(db_path)),
+                ),
+            )
+        )
+    else:
+        set_db_service(DBService(db_name=config.db_name, uri=config.mongodb_uri))
+
+    # import after set_db_service
+    from labtasker.server.endpoints import app
+
+    uvicorn.run(app, host=config.api_host, port=config.api_port, log_config=log_config)
+
+
+def main():
+    # Use this to invoke command to prevent typer overriding exception hook
+    return typer.main.get_command(cli).main()
+
+
+if __name__ == "__main__":
+    main()

{labtasker-0.2.2 → labtasker-0.2.3}/labtasker/server/config.py

@@ -1,4 +1,5 @@
-from typing import Optional
+from pathlib import Path
+from typing import Optional, Union
 
 from pydantic import field_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
@@ -14,7 +15,7 @@ class ServerConfig(BaseSettings):
 
     # API settings
     api_host: str = "0.0.0.0"
-    api_port: int = 8080
+    api_port: int = 9321
 
     # Other settings
     periodic_task_interval: float = 30.0
@@ -48,7 +49,7 @@ class ServerConfig(BaseSettings):
 _config: Optional[ServerConfig] = None
 
 
-def init_server_config(env_file: Optional[str] = None):
+def init_server_config(env_file: Optional[Union[Path, str]] = None):
     global _config
     if _config is not None:
         raise RuntimeError("ServerConfig already initialized.")

{labtasker-0.2.2 → labtasker-0.2.3}/labtasker/server/database.py

@@ -16,7 +16,6 @@ from starlette.status import (
 
 from labtasker.constants import Priority
 from labtasker.security import hash_password
-from labtasker.server.config import get_server_config
 from labtasker.server.db_utils import (
     arg_match,
     keys_to_query_dict,
@@ -114,9 +113,11 @@ class DBService:
 
     def erase(self):
         """Erase all data"""
-        self._queues.delete_many({})
-        self._tasks.delete_many({})
-        self._workers.delete_many({})
+        for col_name in self._db.list_collection_names():
+            collection = self._db[col_name]
+            collection.drop()
+
+        self._setup_collections()
 
     @property
     def projection(self):
@@ -1145,7 +1146,11 @@ _db_service = None
 def get_db() -> DBService:
     """Get database service instance."""
     global _db_service
-    config = get_server_config()
     if not _db_service:
-        _db_service = DBService(db_name=config.db_name, uri=config.mongodb_uri)
-    return _db_service
+        raise RuntimeError("Database service not initialized.")
+    return _db_service  # type: ignore
+
+
+def set_db_service(db_service: DBService):
+    global _db_service
+    _db_service = db_service