Skip to content

Commit 41b8f56

Browse files
authored
Update README.rst
1 parent 10a2822 commit 41b8f56

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ install dbus-python as a system package.
5757
Compatibility - macOS
5858
=====================
5959

60-
macOS keychain support macOS 11 (Big Sur) and later requires Python 3.8.7
60+
macOS keychain supports macOS 11 (Big Sur) and later requires Python 3.8.7
6161
or later with the "universal2" binary. See
6262
`#525 <https://github.com/jaraco/keyring/issues/525>`_ for details.
6363

@@ -78,7 +78,7 @@ Command-line Utility
7878
Keyring supplies a ``keyring`` command which is installed with the
7979
package. After installing keyring in most environments, the
8080
command should be available for setting, getting, and deleting
81-
passwords. For more information on usage, invoke with no arguments
81+
passwords. For more usage information, invoke with no arguments
8282
or with ``--help`` as so::
8383

8484
$ keyring --help
@@ -143,7 +143,7 @@ Third-Party Backends
143143
In addition to the backends provided by the core keyring package for
144144
the most common and secure use cases, there
145145
are additional keyring backend implementations available for other
146-
use-cases. Simply install them to make them available:
146+
use cases. Simply install them to make them available:
147147

148148
- `keyrings.cryptfile <https://pypi.org/project/keyrings.cryptfile>`_
149149
- Encrypted text file storage.
@@ -163,7 +163,7 @@ use-cases. Simply install them to make them available:
163163
backend which uses the ssh agent protocol's signature operation to
164164
derive the cipher key.
165165
- `keyrings.osx_keychain_keys <https://pypi.org/project/keyrings.osx-keychain-keys>`_
166-
- OSX keychain key-management, for private, public and symmetric keys.
166+
- OSX keychain key-management, for private, public, and symmetric keys.
167167

168168

169169
Write your own keyring backend
@@ -183,7 +183,7 @@ creating new backends are encouraged to create new, third-party packages
183183
in the ``keyrings`` namespace, in a manner modeled by the `keyrings.alt
184184
package <https://github.com/jaraco/keyrings.alt>`_. See the
185185
``setup.cfg`` file
186-
in that project for a hints on how to create the requisite entry points.
186+
in that project for hints on how to create the requisite entry points.
187187
Backends that prove essential may be considered for inclusion in the core
188188
library, although the ease of installing these third-party packages should
189189
mean that extensions may be readily available.
@@ -204,7 +204,7 @@ To invoke ``set_keyring``::
204204
import keyring.backend
205205

206206
class TestKeyring(keyring.backend.KeyringBackend):
207-
"""A test keyring which always outputs same password
207+
"""A test keyring which always outputs the same password
208208
"""
209209
priority = 1
210210

@@ -245,7 +245,7 @@ There are several mechanisms to disable keyring:
245245
- Uninstall keyring. Most applications are tolerant to keyring
246246
not being installed. Uninstalling keyring should cause those
247247
applications to fall back to the behavior without keyring.
248-
This approach affects that Python environment where keyring
248+
This approach affects the Python environment where keyring
249249
would otherwise have been installed.
250250

251251
- Configure the Null keyring in the environment. Set
@@ -316,7 +316,7 @@ X11 server available (only D-Bus is required). In this case:
316316

317317
When that command is started, enter a password into stdin and
318318
press Ctrl+D (end of data). After that, the daemon will fork into
319-
background (use ``--foreground`` option to block).
319+
the background (use ``--foreground`` option to block).
320320
* Now you can use the SecretService backend of Keyring. Remember to
321321
run your application in the same D-Bus session as the daemon.
322322

@@ -377,11 +377,11 @@ should be Unicode text.
377377
Exceptions
378378
----------
379379

380-
The keyring lib raises following exceptions:
380+
The keyring lib raises the following exceptions:
381381

382382
* ``keyring.errors.KeyringError``: Base Error class for all exceptions in keyring lib.
383383
* ``keyring.errors.InitError``: Raised when the keyring cannot be initialized.
384-
* ``keyring.errors.PasswordSetError``: Raised when password cannot be set in the keyring.
384+
* ``keyring.errors.PasswordSetError``: Raised when the password cannot be set in the keyring.
385385
* ``keyring.errors.PasswordDeleteError``: Raised when the password cannot be deleted in the keyring.
386386

387387
Get Involved
@@ -413,7 +413,7 @@ Tidelift will coordinate the fix and disclosure.
413413
Security Considerations
414414
=======================
415415

416-
Each builtin backend may have security considerations to understand
416+
Each built-in backend may have security considerations to understand
417417
before using this library. Authors of tools or libraries utilizing
418418
``keyring`` are encouraged to consider these concerns.
419419

@@ -441,7 +441,7 @@ Additional issues can be added as needed.
441441
Making Releases
442442
===============
443443

444-
This project makes use of automated releases continuous
444+
This project makes use of automated releases and continuous
445445
integration. The
446446
simple workflow is to tag a commit and push it to Github. If it
447447
passes tests in CI, it will be automatically deployed to PyPI.

0 commit comments

Comments
 (0)