Metadata-Version: 2.1
Name: chafe
Version: 1.0.0a1
Summary: Encrypts and decrypts files using a pass phrase.
Author-email: Marc Culler <culler@users.noreply.github.com>
Maintainer-email: Marc Culler <culler@users.noreply.github.com>
Project-URL: Homepage, https://github.com/culler/chacha
Project-URL: Bug Tracker, https://github.com/culler/chacha/issues
Keywords: encrypt,decrypt,chacha
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: cryptography>43.0

Encrypt and Decrypt files
=========================

This Python package provides tools for encrypting and decrypting files
with Dan Bernstein's ChaCha stream cipher, using a key derived from a
pass phrase.

Usage  
----- 
The package provides two entry points named encrypt and decrypt. That
means that if this module is in your Python path then the module can
be used as follows:

To encrypt a file named myfile:

 ``% python3 -m chacha.encrypt myfile``

You will be prompted for a password, and an encrypted file named
myfile.cha will be created.  The password will be visible until the
encryption is finished, then erased.  (So write it down first!)

To decrypt myfile.cha:

  ``% python3 -m chacha.decrypt myfile.cha``

You will be prompted for the password, and a decrypted file named myfile.
will be created.  The password will be visible until the decryption is
finished, then erased.

If you install this module with pip then the commands will simply be:

  ``% chacha-encrypt myfile``

and

  ``% chacha-decrypt myfile.cha``
