Metadata-Version: 2.1
Name: pycryptobox
Version: 1.0.1
Summary: A package for encrypting and decrypting files
Home-page: https://github.com/LpCodes/pycryptobox
Author: Lpcodes
Author-email: lovelesh_p@outlook.com
Keywords: encryption decryption file-security cryptography
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: System :: Archiving :: Compression

pyCryptobox
===========

pyCryptobox is a Python package that provides a simple way to encrypt
and decrypt files and directories using the AES encryption algorithm..

Installation
------------

Use the package manager `pip` to install pycryptobox.

.. code:: bash

   pip install pycryptobox

Usage
-----

Encryption
~~~~~~~~~~

To encrypt a single file, use the ``encrypt_file()`` function:

.. code:: python

   from pycryptobox import encrypt_file

   file_path = r"/path/to/file.txt"
   encrypt_file(file_path)

To encrypt all files in a directory, use the ``encrypt_dir()`` function

.. code:: python

   from pycryptobox import encrypt_dir

   dir_path = "/path/to/directory"
   encrypt_dir(dir_path)

Decryption
~~~~~~~~~~

To decrypt a single file, use the decrypt_file() function:

::

   from pycryptobox import decrypt_file

   file_path = "/path/to/file.txt.locked"
   decrypt_file(file_path)

To decrypt all files in a directory, use the decrypt_dir() function:

::

   from pycryptobox import decrypt_dir

   dir_path = "/path/to/directory"
   decrypt_dir(dir_path)

Contributing
------------

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
