Metadata-Version: 2.1
Name: pycryptobox
Version: 1.0.6
Summary: A package for encrypting and decrypting files
Home-page: https://github.com/LpCodes/pycryptobox
Author: https://github.com/LpCodes
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
Description-Content-Type: text/markdown

[![PyPI version](https://badge.fury.io/py/pycryptobox.svg)](https://badge.fury.io/py/pycryptobox) [![Downloads](https://static.pepy.tech/personalized-badge/pycryptobox?period=month&units=none&left_color=black&right_color=orange&left_text=Downloads)](https://pepy.tech/project/pycryptobox)[![Publish Package](https://github.com/LpCodes/pycryptobox/actions/workflows/python-publish.yml/badge.svg)](https://github.com/LpCodes/pycryptobox/actions/workflows/python-publish.yml)

# pyCryptobox

pyCryptoBox is a Python package that allows you to encrypt and decrypt files and folders using the Fernet symmetric encryption algorithm.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.

```bash
pip install pycryptobox
```

## Usage

### Encryption

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

```python
from pycryptobox import encrypt_file

encrypt_file('/path/to/file')


```

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

```python
from pycryptobox import encrypt_files_in_directory

encrypt_files_in_directory('/path/to/directory')



```

### 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_files_in_directory

dir_path = "/path/to/directory"
decrypt_files_in_directory(dir_path)
```

## Contributing

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