vastai 1.0.0.dev1__tar.gz → 1.0.0.dev2__tar.gz

{vastai-1.0.0.dev1 → vastai-1.0.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vastai
-Version: 1.0.0.dev1
+Version: 1.0.0.dev2
 Summary: SDK for Vast.ai GPU Cloud Service
 License-File: LICENSE
 Author: Chris McKenzie
@@ -44,36 +44,71 @@ Project-URL: Repository, https://github.com/vast-ai/vast-sdk
 Project-URL: Source, https://github.com/vast-ai/vast-sdk
 Description-Content-Type: text/markdown
 
-# Vast.ai Python SDK
-[![PyPI version](https://badge.fury.io/py/vastai-sdk.svg)](https://badge.fury.io/py/vastai-sdk)
+# Vast.ai Python SDK & CLI
+[![PyPI version](https://badge.fury.io/py/vastai.svg)](https://badge.fury.io/py/vastai)
 
-The official Vast.ai SDK pip package.
+The official Vast.ai Python package — provides both the CLI and SDK for managing Vast.ai GPU cloud resources, plus a serverless client for endpoint inference.
 
 ## Install
+
 ```bash
-pip install vastai-sdk
+pip install vastai
 ```
-## Examples
 
-NOTE: Ensure your Vast.ai API key is set in your working environment as `VAST_API_KEY`. Alternatively, you may pass the API key in as a parameter to either client.
+> **Note:** `pip install vastai-sdk` also works and installs the same package. Both package names are supported for backward compatibility.
 
-### Using the VastAI CLI client
+## Quickstart
 
-1. Create the client
-```python
-from vastai import VastAI
-vastai = VastAI() # or, VastAI("YOUR_API_KEY")
+1. Get your API key from [https://cloud.vast.ai/manage-keys/](https://cloud.vast.ai/manage-keys/)
+
+2. Set your API key:
+```bash
+vastai set api-key YOUR_API_KEY
 ```
-2. Run commands
-```python
-vastai.search_offers()
+
+3. Test a search:
+```bash
+vastai search offers --limit 3
+```
+You should see a short list of available GPU offers.
+
+## CLI Usage
+
+The `vastai` command provides full access to the Vast.ai platform from your terminal:
+
+```bash
+vastai search offers 'gpu_name=RTX_4090 num_gpus>=4'
+vastai create instance 12345 --image pytorch/pytorch --disk 32 --ssh --direct
+vastai show instances
+vastai stop instance 12345
+vastai destroy instance 12345
+```
+
+Run `vastai --help` for a full list of commands. You can also use `--help` on any subcommand:
+
+```bash
+vastai search offers --help
+vastai create instance --help
 ```
-3. Get help
+
+## SDK Usage
+
 ```python
-help(v.create_instances)
+from vastai import VastAI
+
+vast = VastAI()  # uses VAST_API_KEY env var, or pass api_key="..."
+
+vast.search_offers(query='gpu_name=RTX_4090 num_gpus>=4')
+vast.show_instances()
+vast.start_instance(id=12345)
+vast.stop_instance(id=12345)
 ```
 
-### Using the Serverless client
+Use `help(vast.search_offers)` to view documentation for any method.
+
+> **Migrating from `vastai-sdk`?** The old import still works: `from vastai_sdk import VastAI`
+
+## Using the Serverless Client
 
 1. Create the client
 ```python
@@ -100,5 +135,23 @@ text = response["response"]["choices"][0]["text"]
 print(text)
 ```
 
-Find more examples in the `examples` directory
+Find more examples in the `examples/` directory.
+
+## Tab Completion
+
+Tab completion is supported in Bash and Zsh via [argcomplete](https://github.com/kislyuk/argcomplete) (installed automatically). To enable it:
+
+```bash
+activate-global-python-argcomplete
+```
+
+Or for a single session:
+
+```bash
+eval "$(register-python-argcomplete vastai)"
+```
+
+## Contributing
+
+This [repository](https://github.com/vast-ai/vast-sdk) is open source. If you find a bug, please [open an issue](https://github.com/vast-ai/vast-sdk/issues). PRs are welcome.
 

vastai-1.0.0.dev2/README.md

@@ -0,0 +1,110 @@
+# Vast.ai Python SDK & CLI
+[![PyPI version](https://badge.fury.io/py/vastai.svg)](https://badge.fury.io/py/vastai)
+
+The official Vast.ai Python package — provides both the CLI and SDK for managing Vast.ai GPU cloud resources, plus a serverless client for endpoint inference.
+
+## Install
+
+```bash
+pip install vastai
+```
+
+> **Note:** `pip install vastai-sdk` also works and installs the same package. Both package names are supported for backward compatibility.
+
+## Quickstart
+
+1. Get your API key from [https://cloud.vast.ai/manage-keys/](https://cloud.vast.ai/manage-keys/)
+
+2. Set your API key:
+```bash
+vastai set api-key YOUR_API_KEY
+```
+
+3. Test a search:
+```bash
+vastai search offers --limit 3
+```
+You should see a short list of available GPU offers.
+
+## CLI Usage
+
+The `vastai` command provides full access to the Vast.ai platform from your terminal:
+
+```bash
+vastai search offers 'gpu_name=RTX_4090 num_gpus>=4'
+vastai create instance 12345 --image pytorch/pytorch --disk 32 --ssh --direct
+vastai show instances
+vastai stop instance 12345
+vastai destroy instance 12345
+```
+
+Run `vastai --help` for a full list of commands. You can also use `--help` on any subcommand:
+
+```bash
+vastai search offers --help
+vastai create instance --help
+```
+
+## SDK Usage
+
+```python
+from vastai import VastAI
+
+vast = VastAI()  # uses VAST_API_KEY env var, or pass api_key="..."
+
+vast.search_offers(query='gpu_name=RTX_4090 num_gpus>=4')
+vast.show_instances()
+vast.start_instance(id=12345)
+vast.stop_instance(id=12345)
+```
+
+Use `help(vast.search_offers)` to view documentation for any method.
+
+> **Migrating from `vastai-sdk`?** The old import still works: `from vastai_sdk import VastAI`
+
+## Using the Serverless Client
+
+1. Create the client
+```python
+from vastai import Serverless
+serverless = Serverless() # or, Serverless("YOUR_API_KEY")
+```
+2. Get an endpoint
+```python
+endpoint = await serverless.get_endpoint("my-endpoint")
+```
+3. Make a request
+```python
+request_body = {
+    "model": "Qwen/Qwen3-8B",
+    "prompt" : "Who are you?",
+    "max_tokens" : 100,
+    "temperature" : 0.7
+}
+response = await serverless.request("/v1/completions", request_body)
+```
+4. Read the response
+```python
+text = response["response"]["choices"][0]["text"]
+print(text)
+```
+
+Find more examples in the `examples/` directory.
+
+## Tab Completion
+
+Tab completion is supported in Bash and Zsh via [argcomplete](https://github.com/kislyuk/argcomplete) (installed automatically). To enable it:
+
+```bash
+activate-global-python-argcomplete
+```
+
+Or for a single session:
+
+```bash
+eval "$(register-python-argcomplete vastai)"
+```
+
+## Contributing
+
+This [repository](https://github.com/vast-ai/vast-sdk) is open source. If you find a bug, please [open an issue](https://github.com/vast-ai/vast-sdk/issues). PRs are welcome.

{vastai-1.0.0.dev1 → vastai-1.0.0.dev2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "vastai"
-version = "1.0.0.dev1"
+version = "1.0.0.dev2"
 description = "SDK for Vast.ai GPU Cloud Service"
 readme = "README.md"
 authors = [

vastai-1.0.0.dev1/README.md

@@ -1,57 +0,0 @@
-# Vast.ai Python SDK
-[![PyPI version](https://badge.fury.io/py/vastai-sdk.svg)](https://badge.fury.io/py/vastai-sdk)
-
-The official Vast.ai SDK pip package.
-
-## Install
-```bash
-pip install vastai-sdk
-```
-## Examples
-
-NOTE: Ensure your Vast.ai API key is set in your working environment as `VAST_API_KEY`. Alternatively, you may pass the API key in as a parameter to either client.
-
-### Using the VastAI CLI client
-
-1. Create the client
-```python
-from vastai import VastAI
-vastai = VastAI() # or, VastAI("YOUR_API_KEY")
-```
-2. Run commands
-```python
-vastai.search_offers()
-```
-3. Get help
-```python
-help(v.create_instances)
-```
-
-### Using the Serverless client
-
-1. Create the client
-```python
-from vastai import Serverless
-serverless = Serverless() # or, Serverless("YOUR_API_KEY")
-```
-2. Get an endpoint
-```python
-endpoint = await serverless.get_endpoint("my-endpoint")
-```
-3. Make a request
-```python
-request_body = {
-    "model": "Qwen/Qwen3-8B",
-    "prompt" : "Who are you?",
-    "max_tokens" : 100,
-    "temperature" : 0.7
-}
-response = await serverless.request("/v1/completions", request_body)
-```
-4. Read the response
-```python
-text = response["response"]["choices"][0]["text"]
-print(text)
-```
-
-Find more examples in the `examples` directory