Release v1.0.1 (What’s new?).

Documentation Status https://github.com/MacHu-GWU/windtalker-project/workflows/CI/badge.svg https://codecov.io/gh/MacHu-GWU/windtalker-project/branch/master/graph/badge.svg https://img.shields.io/pypi/v/windtalker.svg https://img.shields.io/pypi/l/windtalker.svg https://img.shields.io/pypi/pyversions/windtalker.svg https://img.shields.io/badge/Release_History!--None.svg?style=social https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Document-blue.svg https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to windtalker Documentation#

https://windtalker.readthedocs.io/_static/windtalker-logo.png

In World War II, US Marine specially recruited a lots of bilingual Navajo speakers to serve in their standard communications units in the Pacific Theater. These Navajo transmitted tactical messages over military telephone or radio communications nets using formal or informally developed codes built upon their native languages. These people, we call them — Wind Talker

windtalker is a utility tools built on top of cryptography and rsa. With this, you can encrypt/decrypt binary data, text, files or even a entire directory in single line of code! It support both symmetry and asymmetry encryption algorithm. For usage, you should start from HERE

Example (SymmtricCipher):

>>> from windtalker import SymmetricCipher
>>> c = SymmetricCipher(password="password") # Fernet encrypter
>>> c.encrypt_text("Hello")
Z0FBQUFBQlo0VHpVVjdWR0xCb0VEc0dMVUxib25jZEwzTWZ1UC1raFVmWndwNERrTmZVR1hNdzE3ZS05RWkwWXBrTi1adUhRWTNWYkxUT1Vkekh3MlVVcHZXLWxaMWMyOEE9PQ==

>>> c.encrypt_file(r"C:\test.py") # c.decrypt_file(xxx) for decryption
C:\test-encrypted.py

>>> c.encrypt_dir(r"C:\User\Admin\Document") # c.decrypt_dir(xxx) for decryption
C:\User\Admin\Document-encrypted.py

HARDCODE YOUR PASSWORD IN YOUR CODE IS DANGEROUS!:

You can create a .windtalker text file in your ${HOME} directory. and put your secret password in it. windtalker.SymmetricCipher can automatically read password from it.

${HOME} directory:

  • Windows: C:\Users\<username>

  • MacOS: /Users/<username>

  • Linux: /home/<username>

For more features and how to use RSA to encrypt your file or directory, please read THIS

Install#

windtalker is released on PyPI, so all you need is to:

$ pip install windtalker

To upgrade to latest version:

$ pip install --upgrade windtalker

Table of Content#

About the Author#

(\ (\
( -.-)o
o_(")(")

Sanhe Hu is a seasoned software engineer with a deep passion for Python development since 2010. As an author and maintainer of 20+ open-source projects, I bring a wealth of experience to the table. As a Senior Solution Architect and Subject Matter Expert in Amazon Web Services, Cloud Engineering, DevOps, Big Data, and Machine Learning, I thrive on helping clients with platform design, enterprise architecture, and strategic roadmaps.

Talk is cheap, show me the code:

API Document#