mirror of
https://github.com/scito/extract_otp_secret_keys.git
synced 2025-12-06 06:44:57 +01:00
Add python virtual env instructions
This change adds instructions on how to setup a python virtual env for this repo. In addition, the respective requirements files have been added for easy installation with pip.
This commit is contained in:
parent
5dc155f556
commit
bf96148461
4 changed files with 19 additions and 0 deletions
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -1 +1,4 @@
|
||||||
|
generated_python/__pycache__/
|
||||||
qr/
|
qr/
|
||||||
|
venv/
|
||||||
|
|
||||||
|
|
|
||||||
12
README.md
12
README.md
|
|
@ -28,6 +28,18 @@ For printing QR codes, the qrcode module is required
|
||||||
|
|
||||||
pip install qrcode[pil]
|
pip install qrcode[pil]
|
||||||
|
|
||||||
|
### Alternative installation method
|
||||||
|
|
||||||
|
Alternatively, you can use a python virtual env for the dependencies:
|
||||||
|
|
||||||
|
python -m venv venv
|
||||||
|
. venv/bin/activate
|
||||||
|
pip install -r requirements-buildenv.txt
|
||||||
|
pip install -r requirements.txt
|
||||||
|
|
||||||
|
The requirements\*.txt files contain all the dependencies (also the optional ones).
|
||||||
|
To leave the python virtual env just call `deactivate`.
|
||||||
|
|
||||||
## Technical background
|
## Technical background
|
||||||
|
|
||||||
The export QR code of "Google Authenticator" contains the URL `otpauth-migration://offline?data=...`.
|
The export QR code of "Google Authenticator" contains the URL `otpauth-migration://offline?data=...`.
|
||||||
|
|
|
||||||
1
requirements-buildenv.txt
Normal file
1
requirements-buildenv.txt
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
wheel
|
||||||
3
requirements.txt
Normal file
3
requirements.txt
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
protobuf
|
||||||
|
qrcode
|
||||||
|
Pillow
|
||||||
Loading…
Add table
Add a link
Reference in a new issue