Decorators for encrypting/decrypting passed arguments
Project description
decorators-cryptography
decorators-cryptography is a Python library that provides decorators for encrypting and decrypting passed arguments using the cryptography package.
Contents:
Installing Poetry and running the virtual environment
Install Poetry
For Linux, macOS, Windows (WSL):
curl -sSL https://install.python-poetry.org | python3 -
For Windows (Powershell):
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
On macOS and Windows, the installation script will prompt you to add the Poetry executable folder to the PATH variable. Do this by running the following command (don't forget to change {USERNAME} to your username):
macOS
export PATH="/Users/{USERNAME}/.local/bin:$PATH"
Windows
$Env:Path += ";C:\Users\{USERNAME}\AppData\Roaming\Python\Scripts"; setx PATH "$Env:Path"
Check installation:
poetry --version
Installing bash completions (optional):
poetry completions bash >> ~/.bash_completion
Start virtual environment
🔖 Setting up the Poetry environment for PyCharm
Creating a virtual environment:
poetry env use python3.10
Installing dependencies:
poetry install
Launching the shell and activating the virtual environment (from the project folder):
poetry shell
Checking virtual environment activation:
poetry env list
Install pre-commit hooks
In order for pre-commit checks to be performed with each commit, you must:
Install pre-commit
The pre-commit module has already been added to the requirements and should be installed automatically with the virtual environment.
You can check the presence of pre-commit with the command (with the virtual environment activated):
pre-commit --version
# >> pre-commit 2.21.0
If this does not happen, then you need to install pre-commit according to the official instructions:
- install via brew package manager:
brew install pre-commit
- installation via poetry:
poetry add pre-commit
- pip install:
pip install pre-commit
Install hooks
Installing hooks:
pre-commit install --all
In the future, when executing the git commit
command, the checks listed in the .pre-commit-config.yaml
file will be performed.
If it is not clear which error is preventing the commit from being executed, you can run the hooks manually with the command:
pre-commit run --all-files
Example Usage
To use the decorators provided by decorators-cryptography, follow the examples below.
from decorators_cryptography import encrypt, decrypt
@encrypt(key="encryption_key")
def sensitive_function(arg1, arg2):
# Your function implementation
pass
@decrypt(key="decryption_key")
def sensitive_function(arg1, arg2):
# Your function implementation
pass
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for decorators_cryptography-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15be1d0d500ff97010875e0cc2ae790dfd23b5339877b7190a3ab39717d9b605 |
|
MD5 | f02c2988d7ec681fbbc5cf39282cb9c4 |
|
BLAKE2b-256 | 6ab439f2d39ebc8f521ade09cdc787a2a341dddb9aebe91e56122cd0b91c3245 |
Hashes for decorators_cryptography-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1112a0a7b0e2f75688b003df673dbf01ffc853d1d347463d14e88dc10e85acf |
|
MD5 | 4e1886bb65c165d9abc4b47132a32cb2 |
|
BLAKE2b-256 | 840c877cd6371630813973babb38779285bf5cf4d3c7b14a0676a356d86c6677 |