unitlab 2.3.0__tar.gz → 2.3.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.4
1
+ Metadata-Version: 2.1
2
2
  Name: unitlab
3
- Version: 2.3.0
3
+ Version: 2.3.4
4
4
  Home-page: https://github.com/teamunitlab/unitlab-sdk
5
5
  Author: Unitlab Inc.
6
6
  Author-email: team@unitlab.ai
@@ -21,11 +21,6 @@ Requires-Dist: requests
21
21
  Requires-Dist: tqdm
22
22
  Requires-Dist: typer
23
23
  Requires-Dist: validators
24
- Dynamic: author
25
- Dynamic: author-email
26
- Dynamic: classifier
27
- Dynamic: home-page
28
- Dynamic: keywords
29
- Dynamic: license
30
- Dynamic: license-file
31
- Dynamic: requires-dist
24
+ Requires-Dist: psutil
25
+ Requires-Dist: pyyaml
26
+ Requires-Dist: jupyter
@@ -26,6 +26,35 @@ Once you have successfully installed the Unitlab package, you can conveniently h
26
26
  ## Quickstart
27
27
  Follow [the quickstart guide for the Python SDK](https://docs.unitlab.ai/cli-python-sdk/unitlab-python-sdk).
28
28
 
29
+ ## CLI Commands
30
+
31
+ ### Agent Commands
32
+
33
+ The agent module provides commands for running device agents with Jupyter, SSH tunnels, and metrics reporting.
34
+
35
+ #### Run Agent
36
+
37
+ Run a full device agent that sets up Jupyter notebooks, SSH tunnels, and system metrics reporting:
38
+
39
+ ```bash
40
+ unitlab agent run --api-key YOUR_API_KEY [OPTIONS]
41
+ ```
42
+
43
+ **Options:**
44
+ - `--api-key` (required): Your Unitlab API key
45
+
46
+ **Example:**
47
+ ```bash
48
+ # Run with auto-generated device ID
49
+ unitlab agent run your-api-key-here
50
+
51
+
52
+
53
+ The agent will:
54
+ - Initialize Jupyter notebook server
55
+ - Set up SSH tunnels for remote access
56
+ - Collect and report system metrics
57
+ - Handle graceful shutdown on interruption
29
58
 
30
59
  ## Documentation
31
60
  [The documentation](https://docs.unitlab.ai/) provides comprehensive instructions on how to utilize the Unilab SDK effectively.
@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
2
2
 
3
3
  setup(
4
4
  name="unitlab",
5
- version="2.3.0",
5
+ version="2.3.4",
6
6
  license="MIT",
7
7
  author="Unitlab Inc.",
8
8
  author_email="team@unitlab.ai",
@@ -29,6 +29,10 @@ setup(
29
29
  "tqdm",
30
30
  "typer",
31
31
  "validators",
32
+ 'psutil',
33
+ 'pyyaml',
34
+ 'jupyter',
35
+
32
36
  ],
33
37
  entry_points={
34
38
  "console_scripts": ["unitlab=unitlab.main:app"],