Skip to content
This repository has been archived by the owner on Jan 15, 2025. It is now read-only.

Latest commit

 

History

History
57 lines (35 loc) · 2.15 KB

README.md

File metadata and controls

57 lines (35 loc) · 2.15 KB


KEELib

An unoffical KEE library.

Topics

  1. About
  2. Installation
  3. Usage
  4. License

About

"KEE is a joke turned real project. Originally I wanted to have my own cipher system (similar to a caesar cipher) for some of my friends, but then I moved on to ciphering on a binary level, and it became more of an encryption system. After a bit of back-and-forth messaging, I decided to actually make an encryption system and language." - JaegerwaldDev

KEELib is an unoffical KEE library. The original project is here.

Please show Jae some support and star the KEE repo if you like it.

Installation

To install KEELib, simply run pip install keelib.

It has only been tested on Python 3.11 and 3.12 at the time of writing.

Usage

This section will explain every feature of KEE and XKEE, if you want to skip to certain parts, look here!

This section will only explain how to use the library. To learn how to use XKEE and KEE, please refer to KEE.

Encrypting/Decrypting files with a key

Encrypting/Decrypting files with a key is simple. First set up an encryptor with your KEE file.

from keelib import Encryptor
encryptor = Encryptor(key_path)

Then you can encrypt/decrypt files with the encryptor.

encryptor.encrypt_file(input_file_path, output_file_path)
encryptor.decrypt_file(input_file_path, output_file_path)

License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

CC BY-NC-SA 4.0