add badges to README, rename CI file to ci.yml
- add python and license badge to README - rename GitHub Workflow actions file to ci.yml
This commit is contained in:
35
README.md
35
README.md
@@ -1,11 +1,14 @@
|
|||||||
# Extract TOTP/HOTP secret keys from Google Authenticator
|
# Extract TOTP/HOTP secret keys from Google Authenticator
|
||||||
|
|
||||||
|
[](https://github.com/scito/extract_otp_secret_keys/actions/workflows/ci.yml)
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
Extract two-factor authentication (2FA, TFA) secret keys from export QR codes of "Google Authenticator" app
|
Extract two-factor authentication (2FA, TFA) secret keys from export QR codes of "Google Authenticator" app
|
||||||
|
|
||||||
## Testing Status
|
|
||||||
|
|
||||||
[](https://github.com/scito/extract_otp_secret_keys/actions/workflows/extract_otp_secret_keys.yml)
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
1. Export the QR codes from "Google Authenticator" app
|
1. Export the QR codes from "Google Authenticator" app
|
||||||
@@ -79,21 +82,11 @@ devbox shell
|
|||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
|
|
||||||
### unittest
|
|
||||||
|
|
||||||
There are basic unit tests, see `unittest_extract_otp_secret_keys.py`.
|
|
||||||
|
|
||||||
Run unit tests:
|
|
||||||
|
|
||||||
```
|
|
||||||
python -m unittest
|
|
||||||
```
|
|
||||||
|
|
||||||
### PyTest
|
### PyTest
|
||||||
|
|
||||||
There are basic pytests, see `test_extract_otp_secret_keys.py`.
|
There are basic pytests, see `test_extract_otp_secret_keys_pytest.py`.
|
||||||
|
|
||||||
Run pytests:
|
Run tests:
|
||||||
|
|
||||||
```
|
```
|
||||||
pytest unittest
|
pytest unittest
|
||||||
@@ -103,3 +96,13 @@ or
|
|||||||
```
|
```
|
||||||
python -m pytest
|
python -m pytest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### unittest
|
||||||
|
|
||||||
|
There are basic unit tests, see `test_extract_otp_secret_keys_unittest.py`.
|
||||||
|
|
||||||
|
Run unit tests:
|
||||||
|
|
||||||
|
```
|
||||||
|
python -m unittest
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user