Metadata-Version: 2.1
Name: pyfer
Version: 4.1.2
Summary: Simple String Encryption Toolkit
Home-page: https://github.com/celerygemini/pyfer
Author: celerygemini
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt

![pyfer_cover](aux/rm_cover.jpg)

-----------------

# Pyfer ~ Encrypt and Decrypt Strings

[![PyPI - Version](https://img.shields.io/pypi/v/pyfer.svg)](https://pypi.org/project/pyfer/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyfer.svg)](https://pypi.org/project/pyfer/)
[![License: MIT](https://img.shields.io/badge/license-MIT-C06524)](https://github.com/celerygemini/pyfer/blob/main/LICENSE)

## 💡 What is it?

Pyfer is a simple encryption and decryption tool built in Python. 

### Features

With this little library you can do the following:

 - Encrypt and decrypt strings
 - Use one of three available encryption modes, each using a different ciphertext alphabet
 - Generate random digit keys

## 🛠️ Setup 

Install it from **PyPI** by running `pip install pyfer`.

### Dependencies 

The only dependency is [NumPy](https://numpy.org).

## 🚀 Execution

### App

If running in a virtual environment using `pyenv`/`virtualenv`, ensure the Python version is configured for `tkinter` by following the instructions [here](https://github.com/celerygemini/resources/blob/main/pyenv_tkinter.md).

To run the app, simply open a terminal window to the project folder and run:
```
python app.py
```

### Command Line

Alternatively, Pyfer can be run from the command line:
```
python main.py <key> <input_string>
```

For more information, have a look at the demo [here](https://github.com/elbydata/pyfer/blob/master/demos/demo.ipynb)!

## 📝 Documentation

Documentation is currently available in the form of docstrings.
 
## ⚖️ License

The project is licensed under the MIT license.
