Metadata-Version: 2.4
Name: qryptex
Version: 0.0.9
Summary: Qryptex – Securely encrypt your recovery codes and text into encrypted QR codes.
Project-URL: Homepage, https://github.com/mboss7/Qryptex
Project-URL: Issues, https://github.com/mboss7/Qryptex/issues
Author-email: mboss7 <contact@qryptex.eu>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: cffi==2.0.0
Requires-Dist: charset-normalizer==3.4.7
Requires-Dist: colorama==0.4.6
Requires-Dist: cryptography==49.0.0
Requires-Dist: iniconfig==2.3.0
Requires-Dist: numpy==2.5.0
Requires-Dist: opencv-python==4.13.0.92
Requires-Dist: packaging==26.2
Requires-Dist: pillow==12.2.0
Requires-Dist: pluggy==1.6.0
Requires-Dist: pycparser==3.0
Requires-Dist: pygments==2.20.0
Requires-Dist: pypdf==6.14.1
Requires-Dist: pytest==9.1.1
Requires-Dist: pyzbar==0.1.9
Requires-Dist: qrcode==8.2
Requires-Dist: reportlab==5.0.0
Description-Content-Type: text/markdown

# Qryptex
Qryptex – Securely encrypt your recovery codes and text into encrypted QR codes.

![logo_qryptex](img/logo/logo_qryptex.jpeg "logo_qryptex")


# CLI APP

```shell 
# Clone repos: 
git clone https://github.com/mboss7/Qryptex.git

# Install dependencies:
pip install -r ./Qryptex/requirements.txt

# Test app: 
cd ./Qryptex/
pytest

# run CLI APP:
python ./Qryptex/src/qryptex/main.py
```

![cli_qryptex](img/cli_qryptex.png "cli_qryptex")



# Python module 

## Installation 
```shell
pip install qryptex
```

## Import and object creation 
```python 
import qryptex 

qtx = qryptex.Qryptex()
```
## Functions 
```python
# Write encrypted QR : 
qtx.write_qr(<your_secret>, <your_password>)  

# Read encrypted QR : 
qtx.read_qr(<your_password>, <your_qr_path>)
```

# To test wife security good practices : 

Use docker, with temporary container (It a good practice for everything you test and you want to isolate) : 
```shell
    docker run --rm -it python:3.11-slim bash  # isolated python env in docker
	
	# or 
	
	docker run --rm -it ubuntu:latest bash   # isolated ubuntu env in docker 

```


# Feature in the roadmap : 

0) Security advises. 

1) Web API in order to do that every where you have an internet connection. 

2) Add TOTP and 2FA support. 

3) Docker support and container ready tu use.