[](https://badge.fury.io/py/pycryptobox) [](https://pepy.tech/project/pycryptobox)[](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.
Raw data
{
"_id": null,
"home_page": "https://github.com/LpCodes/pycryptobox",
"name": "pycryptobox",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "encryption decryption file-security cryptography",
"author": "https://github.com/LpCodes",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/65/c2/9ecd907070f1dae7f9246b75374aebcde09fd0e30a8b9ad1829585851934/pycryptobox-1.0.7.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/pycryptobox) [](https://pepy.tech/project/pycryptobox)[](https://github.com/LpCodes/pycryptobox/actions/workflows/python-publish.yml)\r\n\r\n# pyCryptobox\r\n\r\npyCryptoBox is a Python package that allows you to encrypt and decrypt files and folders using the Fernet symmetric encryption algorithm.\r\n\r\n## Installation\r\n\r\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.\r\n\r\n```bash\r\npip install pycryptobox\r\n```\r\n\r\n## Usage\r\n\r\n### Encryption\r\n\r\nTo encrypt a single file, use the `encrypt_file()` function:\r\n\r\n```python\r\nfrom pycryptobox import encrypt_file\r\n\r\nencrypt_file('/path/to/file')\r\n\r\n\r\n```\r\n\r\nTo encrypt all files in a directory, use the `encrypt_dir()` function\r\n\r\n```python\r\nfrom pycryptobox import encrypt_files_in_directory\r\n\r\nencrypt_files_in_directory('/path/to/directory')\r\n\r\n\r\n\r\n```\r\n\r\n### Decryption\r\n\r\nTo decrypt a single file, use the decrypt_file() function:\r\n\r\n```\r\nfrom pycryptobox import decrypt_file\r\n\r\nfile_path = \"/path/to/file.txt.locked\"\r\ndecrypt_file(file_path)\r\n```\r\n\r\nTo decrypt all files in a directory, use the decrypt_dir() function:\r\n\r\n```\r\nfrom pycryptobox import decrypt_files_in_directory\r\n\r\ndir_path = \"/path/to/directory\"\r\ndecrypt_files_in_directory(dir_path)\r\n```\r\n\r\n## Contributing\r\n\r\nPull requests are welcome. For major changes, please open an issue first\r\nto discuss what you would like to change.\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A package for encrypting and decrypting files",
"version": "1.0.7",
"split_keywords": [
"encryption",
"decryption",
"file-security",
"cryptography"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "65c29ecd907070f1dae7f9246b75374aebcde09fd0e30a8b9ad1829585851934",
"md5": "ba71bd865aa01b93b87131386f22c0b0",
"sha256": "cc0ae112b0133bd4758e48b098e42ebab17a7390260f8856063be22f018475bf"
},
"downloads": -1,
"filename": "pycryptobox-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "ba71bd865aa01b93b87131386f22c0b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3604,
"upload_time": "2023-04-28T06:16:32",
"upload_time_iso_8601": "2023-04-28T06:16:32.846944Z",
"url": "https://files.pythonhosted.org/packages/65/c2/9ecd907070f1dae7f9246b75374aebcde09fd0e30a8b9ad1829585851934/pycryptobox-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-28 06:16:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "LpCodes",
"github_project": "pycryptobox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "cryptography",
"specs": [
[
"==",
"39.0.1"
]
]
},
{
"name": "keyring",
"specs": [
[
"==",
"23.13.1"
]
]
},
{
"name": "setuptools",
"specs": [
[
"==",
"67.6.0"
]
]
}
],
"lcname": "pycryptobox"
}
JSON
