Fix typos

CHANGELOG.md

@@ -76,7 +76,7 @@ This is the last expected release before `v2.0.0`.
 ### 🐛 Bug Fixes
 
 - Allow for reading deleted secret versions (kv2) without an exception ([GH-907](https://github.com/hvac/hvac/pull/907))
-- fix vault client certificates loaded from envirnoment variables ([GH-943](https://github.com/hvac/hvac/pull/943))
+- fix vault client certificates loaded from environment variables ([GH-943](https://github.com/hvac/hvac/pull/943))
 - approle - fix metadata for generated secret IDs, re-add `wrap_ttl` ([GH-782](https://github.com/hvac/hvac/pull/782))
 - AWS secret engine - fix `generate_credentials` for STS endpoint ([GH-934](https://github.com/hvac/hvac/pull/934))
 - Propagate client's adapter to API categories ([GH-939](https://github.com/hvac/hvac/pull/939))
@@ -93,7 +93,7 @@ This is the last expected release before `v2.0.0`.
 - Update Azure guideline with proper client variable ([GH-935](https://github.com/hvac/hvac/pull/935))
 - Update wrapping.rst - example for unauthenticated unwrap ([GH-789](https://github.com/hvac/hvac/pull/789))
 - Fix typo in the AWS auth method docs ([GH-911](https://github.com/hvac/hvac/pull/911))
-- Replace Azure docs occurence to Kubernetes ([GH-904](https://github.com/hvac/hvac/pull/904))
+- Replace Azure docs occurrence to Kubernetes ([GH-904](https://github.com/hvac/hvac/pull/904))
 
 ### 🧰 Miscellaneous
 
@@ -180,7 +180,7 @@ Breakfix release to revert some unintended post-1.0 requirements changes.
 
 - **Note**: This is _actually and truly_ (😝)  intended to by the last hvac release supporting Python 2.7.
 
-  **Starting with hvac version `1.0.0`, Python versions `>=3.6` will be the only explictly supported versions.**
+  **Starting with hvac version `1.0.0`, Python versions `>=3.6` will be the only explicitly supported versions.**
 - Requirements - Cleanup & Upgrades (`install_requires` => `requests>=2.25.1` ). GH-741
 
 ### 🚀 Features
@@ -204,7 +204,7 @@ Thanks to @Tylerlhess, @anhdat, @ayav09, @bobmshannon, @bpatterson971, @briantis
 
 - **Note**: This is intended to by the last hvac release supporting Python 2.7.
 
-  **Starting with hvac version `1.0.0`, Python versions `>=3.6` will be the only explictly supported versions.**
+  **Starting with hvac version `1.0.0`, Python versions `>=3.6` will be the only explicitly supported versions.**
 - Userpass: Add `use_token` param on `login()`, Accept passthrough `**kwargs` on create user . GH-733
 
 ### 🚀 Features
@@ -668,7 +668,7 @@ IMPROVEMENTS:
 
 BUG FIXES:
 
-* Fix for comparision `recovery_threshold` and `recovery_shares` during initialization. [GH-398](https://github.com/hvac/hvac/pull/398)
+* Fix for comparison `recovery_threshold` and `recovery_shares` during initialization. [GH-398](https://github.com/hvac/hvac/pull/398)
 * Fix request method for AWS secrets engine `generate_credentials()` method. [GH-403](https://github.com/hvac/hvac/pull/403)
 * Fix request parameter (`n_bytes` -> `bytes`) for Transit secrets engine `generate_random_bytes()` method. [GH-377](https://github.com/hvac/hvac/pull/377)
 
@@ -780,7 +780,7 @@ Thanks to @otakup0pe, @FabianFrank, @andrewheald for their lovely contributions.
 
 BACKWARDS COMPATIBILITY NOTICE:
 
-* With the newly added `hvac.adapters.Request` class, request kwargs can no longer be directly modified via the `_kwargs` attribute on the `Client` class. If runtime modifications to this dictionary are required, callers either need to explicitly pass in a new `adapter` instance with the desired settings via the `adapter` propery on the `Client` class *or* access the `_kwargs` property via the `adapter` property on the `Client` class.
+* With the newly added `hvac.adapters.Request` class, request kwargs can no longer be directly modified via the `_kwargs` attribute on the `Client` class. If runtime modifications to this dictionary are required, callers either need to explicitly pass in a new `adapter` instance with the desired settings via the `adapter` property on the `Client` class *or* access the `_kwargs` property via the `adapter` property on the `Client` class.
 
 See the [Advanced Usage](https://hvac.readthedocs.io/en/latest/advanced_usage.html#custom-requests-http-adapter) section of this module's documentation for additional details.
 

docs/advanced_usage.rst

@@ -32,7 +32,7 @@ You then use hvac's Client.session and requests.Session() to pass the new CA bun
 		Instantiates a hvac / vault client.
 		:param vault_url: string, protocol + address + port for the vault service
 		:param certs: tuple, Optional tuple of self-signed certs to use for verification
-			with hvac's requests adapater.
+			with hvac's requests adapter.
 		:return: hvac.Client
 		"""
 		logger.debug('Retrieving a vault (hvac) client...')
@@ -59,7 +59,7 @@ You then use hvac's Client.session and requests.Session() to pass the new CA bun
 
 If only using the certificate authority for trust, not authentication, SSL verification can be set using the `verify` parameter.
 
-This configures the client to trust the connection only if the certificate recieved is signed by a CA in that bundle:
+This configures the client to trust the connection only if the certificate received is signed by a CA in that bundle:
 
 .. code:: python
 

docs/usage/auth_methods/aws.rst

@@ -228,7 +228,7 @@ Authentication using EC2 instance role credentials and the EC2 metadata service
         Helper method to authenticate to vault using the "auth_ec2" backend.
         :param vault_client: hvac.Client
         :param pkcs7: pkcs7-encoded identity document from the EC2 metadata service
-        :param nonce: string, the nonce retruned from the initial AWS EC2 auth request (if applicable)
+        :param nonce: string, the nonce returned from the initial AWS EC2 auth request (if applicable)
         :param role: string, the role/policy to request. Defaults to the current instance's AMI ID if not provided.
         :param mount_point: string, the path underwhich the AWS EC2 auth backend is provided
         :param store_nonce: bool, if True, store the nonce received in the auth_ec2 response on disk for later use.

docs/usage/secrets_engines/gcp.rst

@@ -11,7 +11,7 @@ GCP
 
     client.sys.enable_secrets_engine('gcp')
 
-    # mock out external calls that are diffcult to support in test environments
+    # mock out external calls that are difficult to support in test environments
     mock_urls = {
         'https://127.0.0.1:8200/v1/gcp/rolesets': 'LIST',
         'https://127.0.0.1:8200/v1/gcp/roleset/hvac-doctest': ANY,

docs/usage/secrets_engines/identity.rst

@@ -20,7 +20,7 @@ Create Or Update Entity
 
 	create_response = client.secrets.identity.create_or_update_entity(
 			name='hvac-entity',
-			metadata=dict(extra_datas='yup'),
+			metadata=dict(extra_data='yup'),
 		)
 	entity_id = create_response['data']['id']
 	print('Entity ID for "hvac-entity" is: {id}'.format(id=entity_id))
@@ -38,7 +38,7 @@ Create Or Update Entity By Name
 
 	client.secrets.identity.create_or_update_entity_by_name(
 		name='hvac-entity',
-		metadata=dict(new_datas='uhuh'),
+		metadata=dict(new_data='uhuh'),
 	)
 
 
@@ -273,7 +273,7 @@ Create Or Update Group
 
 	create_response = client.secrets.identity.create_or_update_group(
 		name='hvac-group',
-		metadata=dict(extra_datas='we gots em'),
+		metadata=dict(extra_data='we gots em'),
 	)
 	group_id = create_response['data']['id']
 	print('Group ID for "hvac-group" is: {id}'.format(id=group_id))
@@ -373,7 +373,7 @@ Create Or Update Group By Name
 
 	client.secrets.identity.create_or_update_group_by_name(
 		name='hvac-group',
-		metadata=dict(new_datas='uhuh'),
+		metadata=dict(new_data='uhuh'),
 	)
 
 

hvac/adapters.py

@@ -93,7 +93,7 @@ def __init__(
         # fix for issue 991 using session verify if set
         else:
             if session.verify:
-                # need to set the variable and not assign it to self so it is propperly passed in kwargs
+                # need to set the variable and not assign it to self so it is properly passed in kwargs
                 verify = session.verify
             if session.cert:
                 cert = session.cert
@@ -214,13 +214,13 @@ def login(self, url, use_token=True, **kwargs):
         """Perform a login request.
 
         Associated request is typically to a path prefixed with "/v1/auth") and optionally stores the client token sent
-            in the resulting Vault response for use by the :py:meth:`hvac.adapters.Adapter` instance under the _adapater
+            in the resulting Vault response for use by the :py:meth:`hvac.adapters.Adapter` instance under the _adapter
             Client attribute.
 
         :param url: Path to send the authentication request to.
         :type url: str | unicode
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param kwargs: Additional keyword arguments to include in the params sent with the request.
         :type kwargs: dict

hvac/api/auth_methods/approle.py

@@ -492,7 +492,7 @@ def login(
         :param secret_id: Secret ID of the role.
         :type secret_id: str | unicode
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param mount_point: The "path" the method/backend was mounted on.
         :type mount_point: str | unicode

hvac/api/auth_methods/aws.py

@@ -738,7 +738,7 @@ def iam_login(
         :param role: Name of the role against which the login is being attempted.
         :type role: str
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param mount_point: The path the AWS auth method was mounted on.
         :type mount_point: str
@@ -786,7 +786,7 @@ def ec2_login(
         :param role: Name of the role against which the login is being attempted.
         :type role: str
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param mount_point: The path the AWS auth method was mounted on.
         :type mount_point: str

hvac/api/auth_methods/azure.py

@@ -312,7 +312,7 @@ def login(
             information can be obtained through instance metadata.
         :type vmss_name: str | unicode
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param mount_point: The "path" the azure auth method was mounted on.
         :type mount_point: str | unicode

hvac/api/auth_methods/gcp.py

@@ -442,7 +442,7 @@ def login(self, role, jwt, use_token=True, mount_point=DEFAULT_MOUNT_POINT):
         :param jwt: A signed JSON web token
         :type jwt: str | unicode
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param mount_point: The "path" the method/backend was mounted on.
         :type mount_point: str | unicode

hvac/api/auth_methods/github.py

@@ -221,7 +221,7 @@ def login(self, token, use_token=True, mount_point=DEFAULT_MOUNT_POINT):
         :param token: GitHub personal API token.
         :type token: str | unicode
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param mount_point: The "path" the method/backend was mounted on.
         :type mount_point: str | unicode

hvac/api/auth_methods/kubernetes.py

@@ -285,7 +285,7 @@ def login(self, role, jwt, use_token=True, mount_point=DEFAULT_MOUNT_POINT):
         :param jwt: Signed JSON Web Token (JWT) from Kubernetes service account.
         :type jwt: str | unicode
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param mount_point: The "path" the kubernetes auth method was mounted on.
         :type mount_point: str | unicode

hvac/api/auth_methods/ldap.py

@@ -519,7 +519,7 @@ def login(
         :param password: The password for the LDAP user
         :type password: str | unicode
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param mount_point: The "path" the method/backend was mounted on.
         :type mount_point: str | unicode

hvac/api/auth_methods/okta.py

@@ -309,7 +309,7 @@ def login(
         :param password: Password for the authenticating user.
         :type password: str | unicode
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param mount_point: The "path" the method/backend was mounted on.
         :type mount_point: str | unicode

hvac/api/auth_methods/radius.py

@@ -215,7 +215,7 @@ def login(
         :param password: The password for the RADIUS user
         :type password: str | unicode
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param mount_point: The "path" the method/backend was mounted on.
         :type mount_point: str | unicode

hvac/api/secrets_engines/ssh.py

@@ -127,7 +127,7 @@ def create_role(
         :param allowed_users: If only certain usernames are to be allowed, then this list enforces it.
         :type allowed_users: str | unicode
         :param allowed_users_template: If set, allowed_users can be specified using identity template policies.
-            (default: flase)
+            (default: false)
         :type allowed_users_template: bool
         :param allowed_domains: The list of domains for which a client can request a host certificate.
         :type allowed_domains: str | unicode

hvac/api/secrets_engines/transform.py

@@ -399,7 +399,7 @@ def create_or_update_template(
         :param name: the name of the template to create.
         :type name: str | unicode
         :param template_type: Specifies the type of pattern matching to perform.
-            The ony type currently supported by this backend is regex.
+            The only type currently supported by this backend is regex.
         :type template_type: str | unicode
         :param pattern: the pattern used to match a particular value. For regex type
             matching, capture group determines the set of character that should be matched

hvac/api/system_backend/auth.py

@@ -50,7 +50,7 @@ def enable_auth_method(
               the request data object.
             * **audit_non_hmac_response_keys**: Comma-separated list of keys that will not be HMAC'd by audit devices in
               the response data object.
-            * **listing_visibility**: Speficies whether to show this mount in the UI-specific listing endpoint.
+            * **listing_visibility**: Specifies whether to show this mount in the UI-specific listing endpoint.
             * **passthrough_request_headers**: Comma-separated list of headers to whitelist and pass from the request to
               the backend.
         :type config: dict

hvac/api/system_backend/mount.py

@@ -171,7 +171,7 @@ def tune_mount_configuration(
         :param audit_non_hmac_response_keys: Specifies the comma-separated list of keys that will not be HMAC'd by audit
             devices in the response data object.
         :type audit_non_hmac_response_keys: list
-        :param listing_visibility: Speficies whether to show this mount in the UI-specific listing endpoint. Valid
+        :param listing_visibility: Specifies whether to show this mount in the UI-specific listing endpoint. Valid
             values are "unauth" or "".
         :type listing_visibility: str
         :param passthrough_request_headers: Comma-separated list of headers to whitelist and pass from the request

hvac/v1/__init__.py

@@ -440,7 +440,7 @@ def auth_cubbyhole(self, token):
         """Perform a login request with a wrapped token.
 
         Stores the unwrapped token in the resulting Vault response for use by the :py:meth:`hvac.adapters.Adapter`
-            instance under the _adapater Client attribute.
+            instance under the _adapter Client attribute.
 
         :param token: Wrapped token
         :type token: str | unicode
@@ -454,13 +454,13 @@ def login(self, url, use_token=True, **kwargs):
         """Perform a login request.
 
         Associated request is typically to a path prefixed with "/v1/auth") and optionally stores the client token sent
-            in the resulting Vault response for use by the :py:meth:`hvac.adapters.Adapter` instance under the _adapater
+            in the resulting Vault response for use by the :py:meth:`hvac.adapters.Adapter` instance under the _adapter
             Client attribute.
 
         :param url: Path to send the authentication request to.
         :type url: str | unicode
         :param use_token: if True, uses the token in the response received from the auth request to set the "token"
-            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapater Client attribute.
+            attribute on the the :py:meth:`hvac.adapters.Adapter` instance under the _adapter Client attribute.
         :type use_token: bool
         :param kwargs: Additional keyword arguments to include in the params sent with the request.
         :type kwargs: dict

pyproject.toml

@@ -74,6 +74,7 @@ typos = "^1.16.11"
 
 [tool.typos.default.extend-words]
 Hashi = "Hashi"
+saftey = "saftey"
 
 [tool.typos.files]
 extend-exclude = ["*.csr", "tests/config_files/ssh-key"]