From cf91108c3f4ad3894a168ec40410c2f394e9ad65 Mon Sep 17 00:00:00 2001 From: scito Date: Sat, 3 Sep 2022 18:53:23 +0200 Subject: [PATCH] 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 --- .../{extract_otp_secret_keys.yml => ci.yml} | 0 README.md | 33 ++++++++++--------- 2 files changed, 18 insertions(+), 15 deletions(-) rename .github/workflows/{extract_otp_secret_keys.yml => ci.yml} (100%) diff --git a/.github/workflows/extract_otp_secret_keys.yml b/.github/workflows/ci.yml similarity index 100% rename from .github/workflows/extract_otp_secret_keys.yml rename to .github/workflows/ci.yml diff --git a/README.md b/README.md index 58bf331..1ae0864 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # Extract TOTP/HOTP secret keys from Google Authenticator -Extract two-factor authentication (2FA, TFA) secret keys from export QR codes of "Google Authenticator" app +[![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) -## 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) +Extract two-factor authentication (2FA, TFA) secret keys from export QR codes of "Google Authenticator" app ## Usage @@ -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 +```