Skip to content

Commit 9d6b164

Browse files
authored
Merge pull request #1 from anj20/docs/keyring
updated the docs
2 parents b111828 + 4aad38c commit 9d6b164

File tree

1 file changed

+30
-12
lines changed

1 file changed

+30
-12
lines changed

docs/development.rst

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -398,13 +398,13 @@ Common resources that a test might need,
398398
like e.g. a running MSColab server or a QApplication instance for GUI tests,
399399
are collected in :mod:`tests.fixtures` in the form of pytest fixtures that can be requested as needed in tests.
400400

401-
Testing Keyring Features
402-
=========================
401+
Keyring Features
402+
-----------------
403403

404-
This document outlines step-by-step instructions for testing keyring features using the command line.
404+
This document outlines step-by-step instructions for using the keyring features using the command line.
405405

406406
Prerequisites
407-
-------------
407+
..............
408408

409409
1. **Confirm the Default Keyring Backend**
410410

@@ -415,23 +415,29 @@ Prerequisites
415415
keyring --list-backends
416416
417417
Command-Line Commands for Keyring
418-
-----------------------------------
418+
..................................
419419

420420
1. **Set a Password**
421421

422422
Store a password for a specific service and user:
423-
423+
424424
.. code-block:: bash
425425
426426
keyring set SERVICE_NAME USERNAME
427427
428428
**Example:**
429429

430+
- Case 1: Standard Service Name
430431
.. code-block:: bash
431432
432-
keyring set MSCOLAB_AUTH_{url} [email protected]
433+
keyring set http://localhost:8083 myname@mydomain
433434
434-
- The command will securely prompt you to input a password (e.g., `example_password`).
435+
- Case 2: Custom Authentication Service
436+
.. code-block:: bash
437+
438+
keyring set MSCOLAB_AUTH_http://localhost:8083 mscolab
439+
440+
- The command will securely prompt you to input a password (e.g., `example_password`).
435441

436442
2. **Get a Password**
437443

@@ -443,9 +449,15 @@ Command-Line Commands for Keyring
443449
444450
**Example:**
445451

452+
- Case 1: Standard Service Name
453+
.. code-block:: bash
454+
455+
keyring get http://localhost:8083 myname@mydomain
456+
457+
- Case 2: Custom Authentication Service
446458
.. code-block:: bash
447459
448-
keyring get MSCOLAB_AUTH_{url} [email protected]
460+
keyring get MSCOLAB_AUTH_http://localhost:8083 mscolab
449461
450462
**Output:**
451463

@@ -463,16 +475,22 @@ Command-Line Commands for Keyring
463475
464476
**Example:**
465477

478+
- Case 1: Standard Service Name
466479
.. code-block:: bash
467480
468-
keyring delete MSCOLAB_AUTH_{url} [email protected]
481+
keyring delete http://localhost:8083 myname@mydomain
482+
483+
- Case 2: Custom Authentication Service
484+
.. code-block:: bash
485+
486+
keyring delete MSCOLAB_AUTH_http://localhost:8083 mscolab
469487
470488
To confirm the deletion, attempt to retrieve the password:
471489

472490
.. code-block:: bash
473491
474-
keyring get MSCOLAB_AUTH_{url} [email protected]
475-
492+
keyring get MSCOLAB_AUTH_http://localhost:8083 mscolab
493+
476494
477495
Changing the database model
478496
---------------------------

0 commit comments

Comments
 (0)