Skip to content

Commit

Permalink
Merge pull request #1 from anj20/docs/keyring
Browse files Browse the repository at this point in the history
updated the docs
  • Loading branch information
anj20 authored Feb 11, 2025
2 parents b111828 + 4aad38c commit 9d6b164
Showing 1 changed file with 30 additions and 12 deletions.
42 changes: 30 additions & 12 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -398,13 +398,13 @@ Common resources that a test might need,
like e.g. a running MSColab server or a QApplication instance for GUI tests,
are collected in :mod:`tests.fixtures` in the form of pytest fixtures that can be requested as needed in tests.

Testing Keyring Features
=========================
Keyring Features
-----------------

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

Prerequisites
-------------
..............

1. **Confirm the Default Keyring Backend**

Expand All @@ -415,23 +415,29 @@ Prerequisites
keyring --list-backends
Command-Line Commands for Keyring
-----------------------------------
..................................

1. **Set a Password**

Store a password for a specific service and user:

.. code-block:: bash
keyring set SERVICE_NAME USERNAME
**Example:**

- Case 1: Standard Service Name
.. code-block:: bash
keyring set MSCOLAB_AUTH_{url} [email protected]
keyring set http://localhost:8083 myname@mydomain
- The command will securely prompt you to input a password (e.g., `example_password`).
- Case 2: Custom Authentication Service
.. code-block:: bash
keyring set MSCOLAB_AUTH_http://localhost:8083 mscolab
- The command will securely prompt you to input a password (e.g., `example_password`).

2. **Get a Password**

Expand All @@ -443,9 +449,15 @@ Command-Line Commands for Keyring
**Example:**

- Case 1: Standard Service Name
.. code-block:: bash
keyring get http://localhost:8083 myname@mydomain
- Case 2: Custom Authentication Service
.. code-block:: bash
keyring get MSCOLAB_AUTH_{url} [email protected]
keyring get MSCOLAB_AUTH_http://localhost:8083 mscolab
**Output:**

Expand All @@ -463,16 +475,22 @@ Command-Line Commands for Keyring
**Example:**

- Case 1: Standard Service Name
.. code-block:: bash
keyring delete MSCOLAB_AUTH_{url} [email protected]
keyring delete http://localhost:8083 myname@mydomain
- Case 2: Custom Authentication Service
.. code-block:: bash
keyring delete MSCOLAB_AUTH_http://localhost:8083 mscolab
To confirm the deletion, attempt to retrieve the password:

.. code-block:: bash
keyring get MSCOLAB_AUTH_{url} [email protected]
keyring get MSCOLAB_AUTH_http://localhost:8083 mscolab
Changing the database model
---------------------------
Expand Down

0 comments on commit 9d6b164

Please sign in to comment.