das-cli 1.2.24__tar.gz → 1.2.26__tar.gz

{das_cli-1.2.24/das_cli.egg-info → das_cli-1.2.26}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: das-cli
-Version: 1.2.24
+Version: 1.2.26
 Summary: DAS api client.
 Author: Royal Netherlands Institute for Sea Research
 License-Expression: MIT
@@ -74,6 +74,14 @@ cd das-cli
 pip install -e .
 ```
 
+### Upgrade
+
+To upgrade to the latest version of das-cli:
+
+```bash
+pip install --upgrade das-cli
+```
+
 ## CLI Usage
 
 The package installs a `das` executable for interacting with the DAS API.
@@ -261,6 +269,41 @@ das ai logout [--force]
 
 The DAS CLI provides three layers of interaction: CLI commands, Manager layer, and Service layer. Below are examples for each command showing usage at all three layers.
 
+### Login
+
+Before using the Python API (e.g. `EntryManager`, `SearchManager`, `DownloadManager`), you must authenticate. The managers read the API URL and token from the stored configuration.
+
+**Option 1 – Login via CLI first (recommended):**
+
+```bash
+das login --api-url https://your-das-instance/api --username your_username --password your_password
+# Or omit --username/--password to be prompted securely
+```
+
+Then in Python:
+
+```python
+from das.managers.entries_manager import EntryManager
+
+entry_manager = EntryManager()
+entry = entry_manager.get(code="7b.b.4c")
+```
+
+**Option 2 – Login programmatically with `Das`:**
+
+```python
+from das.app import Das
+from das.managers.entries_manager import EntryManager
+
+# Authenticate and store credentials
+client = Das("https://your-das-instance/api")
+client.authenticate("your_username", "your_password")
+
+# Now EntryManager (and other managers) can use the stored config
+entry_manager = EntryManager()
+entry = entry_manager.get(code="7b.b.4c")
+```
+
 ### Entries
 
 #### Get Entry
@@ -960,6 +1003,47 @@ das config ssl-verify false
 das config ssl-status
 ```
 
+### Environment variables
+
+You can use a `.env` file in the project root (or current directory) for local configuration. Copy `.env.example` to `.env` and fill in the values:
+
+```bash
+cp .env.example .env
+```
+
+Example `.env` (based on `.env.example`):
+
+```env
+# DAS API credentials (used by tests and scripts; CLI uses `das login` for interactive use)
+USER_NAME=
+USER_PASSWORD=
+
+# DAS API base URL (e.g. https://api.das-dev.nioz.nl or https://localhost:44301)
+API_URL=
+
+# PyPI/Twine credentials for publishing packages (deploy.ps1, etc.)
+TWINE_USERNAME=__token__
+TWINE_PASSWORD=
+
+# Enable or disable SSL certificate verification (True/False). Overrides config when set.
+VERIFY_SSL=
+
+# OpenAI model ID for the AI feature (e.g. gpt-4, gpt-4o-mini). Used by `das ai enable`.
+OPEN_AI_MODEL_ID=
+```
+
+| Variable | Description |
+|----------|-------------|
+| `USER_NAME` | DAS username. Used by tests and scripts for authentication. The CLI typically uses `das login` instead. |
+| `USER_PASSWORD` | DAS password. Used by tests and scripts. Never commit this to version control. |
+| `API_URL` | DAS API base URL (e.g. `https://api.das-dev.nioz.nl` or `https://localhost:44301`). Used by tests, scripts, and when no URL is stored via `das login`. |
+| `TWINE_USERNAME` | PyPI/Twine username. Use `__token__` when publishing with an API token. |
+| `TWINE_PASSWORD` | PyPI/Twine password or API token. Used by `deploy.ps1` when publishing packages. |
+| `VERIFY_SSL` | Set to `True` or `False` to control SSL certificate verification. Overrides the value from `das config ssl-verify` when set. |
+| `OPEN_AI_MODEL_ID` | OpenAI model ID (e.g. `gpt-4`, `gpt-4o-mini`). Used by the AI feature (`das ai enable`). |
+
+**Note:** The `.env` file is gitignored. Do not commit credentials.
+
 ## Downloads
 
 ```bash

{das_cli-1.2.24 → das_cli-1.2.26}/README.md

@@ -51,6 +51,14 @@ cd das-cli
 pip install -e .
 ```
 
+### Upgrade
+
+To upgrade to the latest version of das-cli:
+
+```bash
+pip install --upgrade das-cli
+```
+
 ## CLI Usage
 
 The package installs a `das` executable for interacting with the DAS API.
@@ -238,6 +246,41 @@ das ai logout [--force]
 
 The DAS CLI provides three layers of interaction: CLI commands, Manager layer, and Service layer. Below are examples for each command showing usage at all three layers.
 
+### Login
+
+Before using the Python API (e.g. `EntryManager`, `SearchManager`, `DownloadManager`), you must authenticate. The managers read the API URL and token from the stored configuration.
+
+**Option 1 – Login via CLI first (recommended):**
+
+```bash
+das login --api-url https://your-das-instance/api --username your_username --password your_password
+# Or omit --username/--password to be prompted securely
+```
+
+Then in Python:
+
+```python
+from das.managers.entries_manager import EntryManager
+
+entry_manager = EntryManager()
+entry = entry_manager.get(code="7b.b.4c")
+```
+
+**Option 2 – Login programmatically with `Das`:**
+
+```python
+from das.app import Das
+from das.managers.entries_manager import EntryManager
+
+# Authenticate and store credentials
+client = Das("https://your-das-instance/api")
+client.authenticate("your_username", "your_password")
+
+# Now EntryManager (and other managers) can use the stored config
+entry_manager = EntryManager()
+entry = entry_manager.get(code="7b.b.4c")
+```
+
 ### Entries
 
 #### Get Entry
@@ -937,6 +980,47 @@ das config ssl-verify false
 das config ssl-status
 ```
 
+### Environment variables
+
+You can use a `.env` file in the project root (or current directory) for local configuration. Copy `.env.example` to `.env` and fill in the values:
+
+```bash
+cp .env.example .env
+```
+
+Example `.env` (based on `.env.example`):
+
+```env
+# DAS API credentials (used by tests and scripts; CLI uses `das login` for interactive use)
+USER_NAME=
+USER_PASSWORD=
+
+# DAS API base URL (e.g. https://api.das-dev.nioz.nl or https://localhost:44301)
+API_URL=
+
+# PyPI/Twine credentials for publishing packages (deploy.ps1, etc.)
+TWINE_USERNAME=__token__
+TWINE_PASSWORD=
+
+# Enable or disable SSL certificate verification (True/False). Overrides config when set.
+VERIFY_SSL=
+
+# OpenAI model ID for the AI feature (e.g. gpt-4, gpt-4o-mini). Used by `das ai enable`.
+OPEN_AI_MODEL_ID=
+```
+
+| Variable | Description |
+|----------|-------------|
+| `USER_NAME` | DAS username. Used by tests and scripts for authentication. The CLI typically uses `das login` instead. |
+| `USER_PASSWORD` | DAS password. Used by tests and scripts. Never commit this to version control. |
+| `API_URL` | DAS API base URL (e.g. `https://api.das-dev.nioz.nl` or `https://localhost:44301`). Used by tests, scripts, and when no URL is stored via `das login`. |
+| `TWINE_USERNAME` | PyPI/Twine username. Use `__token__` when publishing with an API token. |
+| `TWINE_PASSWORD` | PyPI/Twine password or API token. Used by `deploy.ps1` when publishing packages. |
+| `VERIFY_SSL` | Set to `True` or `False` to control SSL certificate verification. Overrides the value from `das config ssl-verify` when set. |
+| `OPEN_AI_MODEL_ID` | OpenAI model ID (e.g. `gpt-4`, `gpt-4o-mini`). Used by the AI feature (`das ai enable`). |
+
+**Note:** The `.env` file is gitignored. Do not commit credentials.
+
 ## Downloads
 
 ```bash

{das_cli-1.2.24 → das_cli-1.2.26/das_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: das-cli
-Version: 1.2.24
+Version: 1.2.26
 Summary: DAS api client.
 Author: Royal Netherlands Institute for Sea Research
 License-Expression: MIT
@@ -74,6 +74,14 @@ cd das-cli
 pip install -e .
 ```
 
+### Upgrade
+
+To upgrade to the latest version of das-cli:
+
+```bash
+pip install --upgrade das-cli
+```
+
 ## CLI Usage
 
 The package installs a `das` executable for interacting with the DAS API.
@@ -261,6 +269,41 @@ das ai logout [--force]
 
 The DAS CLI provides three layers of interaction: CLI commands, Manager layer, and Service layer. Below are examples for each command showing usage at all three layers.
 
+### Login
+
+Before using the Python API (e.g. `EntryManager`, `SearchManager`, `DownloadManager`), you must authenticate. The managers read the API URL and token from the stored configuration.
+
+**Option 1 – Login via CLI first (recommended):**
+
+```bash
+das login --api-url https://your-das-instance/api --username your_username --password your_password
+# Or omit --username/--password to be prompted securely
+```
+
+Then in Python:
+
+```python
+from das.managers.entries_manager import EntryManager
+
+entry_manager = EntryManager()
+entry = entry_manager.get(code="7b.b.4c")
+```
+
+**Option 2 – Login programmatically with `Das`:**
+
+```python
+from das.app import Das
+from das.managers.entries_manager import EntryManager
+
+# Authenticate and store credentials
+client = Das("https://your-das-instance/api")
+client.authenticate("your_username", "your_password")
+
+# Now EntryManager (and other managers) can use the stored config
+entry_manager = EntryManager()
+entry = entry_manager.get(code="7b.b.4c")
+```
+
 ### Entries
 
 #### Get Entry
@@ -960,6 +1003,47 @@ das config ssl-verify false
 das config ssl-status
 ```
 
+### Environment variables
+
+You can use a `.env` file in the project root (or current directory) for local configuration. Copy `.env.example` to `.env` and fill in the values:
+
+```bash
+cp .env.example .env
+```
+
+Example `.env` (based on `.env.example`):
+
+```env
+# DAS API credentials (used by tests and scripts; CLI uses `das login` for interactive use)
+USER_NAME=
+USER_PASSWORD=
+
+# DAS API base URL (e.g. https://api.das-dev.nioz.nl or https://localhost:44301)
+API_URL=
+
+# PyPI/Twine credentials for publishing packages (deploy.ps1, etc.)
+TWINE_USERNAME=__token__
+TWINE_PASSWORD=
+
+# Enable or disable SSL certificate verification (True/False). Overrides config when set.
+VERIFY_SSL=
+
+# OpenAI model ID for the AI feature (e.g. gpt-4, gpt-4o-mini). Used by `das ai enable`.
+OPEN_AI_MODEL_ID=
+```
+
+| Variable | Description |
+|----------|-------------|
+| `USER_NAME` | DAS username. Used by tests and scripts for authentication. The CLI typically uses `das login` instead. |
+| `USER_PASSWORD` | DAS password. Used by tests and scripts. Never commit this to version control. |
+| `API_URL` | DAS API base URL (e.g. `https://api.das-dev.nioz.nl` or `https://localhost:44301`). Used by tests, scripts, and when no URL is stored via `das login`. |
+| `TWINE_USERNAME` | PyPI/Twine username. Use `__token__` when publishing with an API token. |
+| `TWINE_PASSWORD` | PyPI/Twine password or API token. Used by `deploy.ps1` when publishing packages. |
+| `VERIFY_SSL` | Set to `True` or `False` to control SSL certificate verification. Overrides the value from `das config ssl-verify` when set. |
+| `OPEN_AI_MODEL_ID` | OpenAI model ID (e.g. `gpt-4`, `gpt-4o-mini`). Used by the AI feature (`das ai enable`). |
+
+**Note:** The `.env` file is gitignored. Do not commit credentials.
+
 ## Downloads
 
 ```bash

{das_cli-1.2.24 → das_cli-1.2.26}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "das-cli"
-version = "1.2.24"
+version = "1.2.26"
 authors = [
   { name="Royal Netherlands Institute for Sea Research" },
 ]