smokephil/extract_otp_secret_keys
1
0
Fork 0
mirror of https://github.com/scito/extract_otp_secret_keys.git synced 2025-12-06 06:44:57 +01:00
Code Issues Projects Releases Wiki Activity

add badges to README, rename CI file to ci.yml

Browse source 
- add python and license badge to README
- rename GitHub Workflow actions file to ci.yml
This commit is contained in:
scito 2022-09-03 18:53:23 +02:00 • committed by Roland Kurmann
parent fef46dcfba
commit cf91108c3f
2 changed files with 19 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,11 +1,14 @@
# Extract TOTP/HOTP secret keys from Google Authenticator
[![CI Status](https://github.com/scito/extract_otp_secret_keys/actions/workflows/ci.yml/badge.svg)](https://github.com/scito/extract_otp_secret_keys/actions/workflows/ci.yml)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/protobuf)
![GitHub Pipenv locked Python version](https://img.shields.io/github/pipenv/locked/python-version/scito/extract_otp_secret_keys)
![License](https://img.shields.io/github/license/scito/extract_otp_secret_keys)
---
Extract two-factor authentication (2FA, TFA) secret keys from export QR codes of "Google Authenticator" app
## Testing Status
[![extract_otp_secret_keys](https://github.com/scito/extract_otp_secret_keys/actions/workflows/extract_otp_secret_keys.yml/badge.svg)](https://github.com/scito/extract_otp_secret_keys/actions/workflows/extract_otp_secret_keys.yml)
## Usage
1. Export the QR codes from "Google Authenticator" app
@ -79,21 +82,11 @@ devbox shell
## Tests
### unittest
There are basic unit tests, see `unittest_extract_otp_secret_keys.py`.
Run unit tests:
```
python -m unittest
```
### 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
@ -103,3 +96,13 @@ or
```
python -m pytest
```
### unittest
There are basic unit tests, see `test_extract_otp_secret_keys_unittest.py`.
Run unit tests:
```
python -m unittest
```