Sean 2 лет назад
Родитель
Сommit
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
   - .drone.yml
 dictionaryDefinitions: []
 dictionaryDefinitions: []
 ignoreWords:
 ignoreWords:
-  - cifs
-  - xvzf
-  - pyproject
+  - Aelon
   - ansi
   - ansi
+  - cifs
+  - fhnw
+  - FHNW
+  - fromb
+  - idDiv_SAOTCAS_Title
+  - loginfmt
+  - NBSWY3DPEB3W64TMMQ
   - ocma
   - ocma
+  - OCMA
+  - otpauth
   - otppy
   - otppy
-  - loginfmt
+  - pipx
+  - pyproject
   - SAOTCC
   - SAOTCC
-  - OCMA
-  - fromb
-  - TOTP
   - totp
   - totp
-  - otpauth
-  - FHNW
-  - fhnw
-  - NBSWY3DPEB3W64TMMQ
-  - idDiv_SAOTCAS_Title
-  - Aelon
+  - TOTP
+  - xvzf
 dictionaries: []
 dictionaries: []
 words: []
 words: []
 import:
 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
 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.
 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
 install the package globally. Then the "ocma" command should be available. Try it out by
 typing `ocma -h`.
 typing `ocma -h`.
 
 
+To upgrade the CLI wrapper after a new release, run the following command: `pipx upgrade ocma`
+
 ## Password character limitations
 ## Password character limitations
 
 
 There are some special characters, that might make your life difficult and are best left out of your password:
 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
 ## 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
 ```python
 from ocma import connect
 from ocma import connect