From d8de89de369818fe8e07a337a6942f4c80aaf2b2 Mon Sep 17 00:00:00 2001 From: scito Date: Fri, 30 Dec 2022 02:20:19 +0100 Subject: [PATCH] improve README, add docker ci badge --- .github/workflows/ci_docker.yml | 2 +- README.md | 14 +++++++++----- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/.github/workflows/ci_docker.yml b/.github/workflows/ci_docker.yml index e0b7e00..b5c58fe 100644 --- a/.github/workflows/ci_docker.yml +++ b/.github/workflows/ci_docker.yml @@ -1,4 +1,4 @@ -name: "Docker: build and publish" +name: docker # How to setup: https://event-driven.io/en/how_to_buid_and_push_docker_image_with_github_actions/ # How to run: https://aschmelyun.com/blog/using-docker-run-inside-of-github-actions/ diff --git a/README.md b/README.md index 5b5aa86..770364a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![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) ![coverage](https://img.shields.io/badge/coverage-95%25-brightgreen) +[![docker](https://github.com/scito/extract_otp_secret_keys/actions/workflows/ci_docker.yml/badge.svg)](https://github.com/scito/extract_otp_secret_keys/actions/workflows/ci_docker.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)](https://github.com/scito/extract_otp_secret_keys/blob/master/Pipfile.lock) ![protobuf version](https://img.shields.io/badge/protobuf-4.21.12-informational) @@ -159,17 +160,16 @@ The zbar DLLs are included with the Windows Python wheels. On other operating sy * Free and open source * Supports Google Authenticator exports (and compatible apps like Aegis Authenticator) -* All functionality in one Python script: extract_otp_secret_keys.py (except protobuf generated code in protobuf_generated_python) +* Captures the the QR codes directly from the camera using QR code detection (based on OpenCV) * Supports TOTP and HOTP * Generates QR codes -* Reads QR Code images * Exports to various formats: * CSV * JSON * Dedicated CSV for KeePass * QR code images * Supports reading from stdin and writing to stdout -* Reads from various import image formats containing export QR codes: (See [OpenCV docu](https://docs.opencv.org/3.4/d4/da8/group__imgcodecs.html#ga288b8b3da0892bd651fce07b3bbd3a56)) +* Reads QR codes images: (See [OpenCV docu](https://docs.opencv.org/3.4/d4/da8/group__imgcodecs.html#ga288b8b3da0892bd651fce07b3bbd3a56)) * Portable Network Graphics - *.png * WebP - *.webp * JPEG files - *.jpeg, *.jpg, *.jpe @@ -185,15 +185,19 @@ The zbar DLLs are included with the Windows Python wheels. On other operating sy * Many ways to run the script: * Native Python * pipenv + * pip * venv * Docker * VSCode devcontainer * devbox - * pip -* Compatible with multiple platforms (tested by CI): +* Compatible with major platforms: * Linux * macOS * Windows +* Uses UTF-8 on all platforms +* Supports Python >= 3.7 +* All these features are backed by tests ran nightly +* All functionality in one Python script: extract_otp_secret_keys.py (except protobuf generated code in protobuf_generated_python) ## KeePass