Эх сурвалжийг харах

chore: Install using pipx

Sean 2 жил өмнө
parent
commit
4b7b623ef7
2 өөрчлөгдсөн 19 нэмэгдсэн , 16 устгасан
  1. 14 13
      cspell.config.yaml
  2. 5 3
      readme.md

+ 14 - 13
cspell.config.yaml

@@ -13,24 +13,25 @@ ignorePaths:
   - .drone.yml
 dictionaryDefinitions: []
 ignoreWords:
-  - cifs
-  - xvzf
-  - pyproject
+  - Aelon
   - ansi
+  - cifs
+  - fhnw
+  - FHNW
+  - fromb
+  - idDiv_SAOTCAS_Title
+  - loginfmt
+  - NBSWY3DPEB3W64TMMQ
   - ocma
+  - OCMA
+  - otpauth
   - otppy
-  - loginfmt
+  - pipx
+  - pyproject
   - SAOTCC
-  - OCMA
-  - fromb
-  - TOTP
   - totp
-  - otpauth
-  - FHNW
-  - fhnw
-  - NBSWY3DPEB3W64TMMQ
-  - idDiv_SAOTCAS_Title
-  - Aelon
+  - TOTP
+  - xvzf
 dictionaries: []
 words: []
 import:

+ 5 - 3
readme.md

@@ -6,12 +6,14 @@ openconnect VPN client.
 It uses selenium to open the login webpage and fill in the form details. At the end, it
 fetches the correct VPN HOST and the Cisco AnyConnect `webvpn` cookie.
 
-## Installation for CLI usage
+## Installing for CLI usage
 
-Simply run `pip install --upgrade git+https://git.snas.black-burn.ch/FHNW/openconnect-ms-auth` to
+Simply run `pipx install git+https://git.snas.black-burn.ch/FHNW/openconnect-ms-auth` to
 install the package globally. Then the "ocma" command should be available. Try it out by
 typing `ocma -h`.
 
+To upgrade the CLI wrapper after a new release, run the following command: `pipx upgrade ocma`
+
 ## Password character limitations
 
 There are some special characters, that might make your life difficult and are best left out of your password:
@@ -34,7 +36,7 @@ eval $( ocma -u [username] -p [password] -m [mfa_secret] --print-to-stdout );
 
 ## Example usage in a Python project
 
-Add with poetry: `poetry add git+https://git.snas.black-burn.ch/FHNW/openconnect-ms-auth`
+Add with poetry (or pip, ...): `poetry add git+https://git.snas.black-burn.ch/FHNW/openconnect-ms-auth`
 
 ```python
 from ocma import connect