| Name | inuxnetutil JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | https://newgit.inuxnet.org/devel/inuxnetutil.git |
| Summary | Set of common handy functions and tools. |
| upload_time | 2024-12-02 06:30:55 |
| maintainer | None |
| docs_url | None |
| author | Jess Williams |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Jess Williams Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
validation
encrypt
decrypt
inuxnet
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# inuxnetutil
This library and set of tools are common functions and tools used in various Inuxnet
projects.
## Installing
This module requires cryptography. It is advisable to install this inside a virtual
environment.
### Setting up and activating the Python Virtual Environment
It is recommended to install within a Python Virtual Environment, please review your
specific OS instructions to install VirtualEnv on your system.
From the directory of the repository:
```
python3 -m venv venv
```
Activating the Virtual Environment:
```
. venv/bin/activate
```
To exit the Virtual Environment:
```
deactivate
```
### Installing using the setup.py
All commands should be run from the root directory of the repository.
```
pip install -r requirements.txt
python3 setup.py install
```
### Installing from [PyPi](https://pypi.org/project/inuxnetutil/0.1.0/)
```
pip install inuxnetutil
```
## Pythonic Usage
### validate_argument
Python is not strictly typed and will allow any type to be input
as arguments for functions and methods. Used to validate input
parameters for functions and methods to ensure the proper data
is being input as arguments.
```
Help on function validate_argument in module inuxnetutil.inuxnetutil:
validate_argument(argument: object, arg_types: type, arg_name: str = 'argument', nullable: bool = False, message: str = "Parameter {arg_name} '{argument}' must be of type {' or '.join([ f'{x}' for x in arg_types ])}.") -> object
Validates argument, raises TypeError or returns argument
:param argument: <class 'any'>
- This can be any type that needs to match
:param arg_types: <class 'list'> or <class 'tuple'> or <class 'type'>
- A list/tuple of <class 'type'> to match
:param arg_name: <class 'str'>
- The name of the argument being passed in. Defaults to "argument"
:param nullable: <class 'bool'>
- If None is allowed as an input parameter
:param message: <class 'str'>
- Custom error message, defaults to:
f"Parameter {arg_name} '{argument}' must be of type {' or '.join([ f'{x}' for x in arg_types ])}"
:return: <class 'object'>
- returns the argument object
Example:
>>> arg = validate_argument("123", int)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "inuxnetutil.py", line 74, in validate_argument
raise TypeError(msg)
TypeError: Parameter argument '123' must be of type <class 'int'>.
>>> arg = 123
>>> validate_argument(arg, [str,float], "parameter_name")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "inuxnetutil.py", line 74, in validate_argument
raise TypeError(msg)
TypeError: Parameter parameter_name '123' must be of type <class 'str'> or <class 'float'>.
>>> validate_argument(arg, [int,float], "people_count")
123
>>> arg = None
>>> validate_argument(arg, [int,float], "people_count", True)
```
### is_empty_string
This is an extension of validate_argument and will ensure that the
string data is not empty.
```
Help on function is_empty_string in module inuxnetutil.inuxnetutil:
is_empty_string(arg: str, arg_name: str = None, nullable: bool = False) -> str
Validates arguments and ensures no empty string if not nullable
:param arg: <class 'str'>
- Since it is validating an empty string, must be a string
:param arg_name: <class 'str'>
- The argument name, defaults to 'argument'
:param nullable: <class 'bool'>
- If None is allowed as an input parameter
:return: <class 'str'>
- Returns the string passed in.
Examples:
>>> data = ''
>>> is_empty_string(data, "data")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "inuxnetutil.py", line 92, in is_empty_string
raise ValueError(f"{arg_name} '{arg}' must have a valid value, cannot be empty.")
ValueError: data '' must have a valid value, cannot be empty.
```
### validate_filepath
An extension of validate_argument that validates a file exists.
```
Help on function validate_filepath in module inuxnetutil.inuxnetutil:
validate_filepath(filepath: str)
Validates file path.
:param filepath: <class 'str'>
- The filepath to validate
Examples:
>>> validate_filepath("some_non_existent_file.txt")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "inuxnetutil.py", line 106, in validate_filepath
raise ValueError(f"{filepath} is invalid. Either invalid path or permissions.")
ValueError: some_non_existent_file.txt is invalid. Either invalid path or permissions.
>>> print(validate_filepath("inuxnetutil/inuxnetutil.py")) # Valid Path
None
```
### derive_key
Derives a byte encoded key from passphrase, used for encrypting/decrypting.
```
Help on function derive_key in module inuxnetutil.inuxnetutil:
derive_key(passphrase: str, salt: bytes) -> bytes
Derives a key from passphrase and salt.
:param passphrase: <class 'str'>
- The passphrase to derive key from.
:param salt: <class 'bytes'>
- The salt to spice the key.
:return: <class 'bytes'>
Examples:
>>> salt = os.urandom(16)
>>> key = derive_key("SecretPassphrase", salt)
>>> print(key.decode('utf-8'))
zLXClPOw_ZPUm0wucc9GRFMu2p8ScsbHNZh1zuJsR2s=
```
### encrypt
Encrypts bytes with passphrase and salt.
```
Help on function encrypt in module inuxnetutil.inuxnetutil:
encrypt(data: bytes, passphrase: str, salt: bytes = None) -> bytes
Encrypts a list of bytes, returns encrypted bytes
:param data: <class 'bytes'>
- The unencrypted bytes.
:param passphrase: <class 'str'>
- The passphrase to encrypt with.
:param salt: <class 'bytes'>
- Season the encryption, defaults to None and generates random salt
:return: <class 'bytes'>
- Encrypted bytes
Examples:
>>> text = "Secret to encrypt"
>>> encrypted_text = encrypt(text.encode('utf-8'), "SecretPassphrase")
>>> print(base64.b64encode(encrypted_text).decode('utf-8'))
zuwUtqziG65qxvqBtGCJHWdBQUFBQUJuVExkSk16WWc3MkIxV1dHX29HYnQ2MTluR1BQMW1yb0pkdC11Z2x3SG1nU0RMcGhwNlJyNlo2bkEyTkVQeHEyLTF6VHdzQnJyZzhBWXJkZENXRFFIdlR1UVo0a3pIS24zajJncEhTZDVkdEYwdEl3PQ==
```
### encrypt_file
Encrypts file with passphrase and outputs to encrypted file.
```
Help on function encrypt_file in module inuxnetutil.inuxnetutil:
encrypt_file(file_path: str, passphrase: str, output_path: str)
Encrypts file
:param file_path: <class 'str'>
- The file path of the file to encrypt.
:param passphrase: <class 'str'>
- The passphrase to encrypt the file with.
:param output_path: <class 'str'>
- The file path of the output encrypted file.
Examples:
>>> encrypt_file("inuxnetutil/inuxnetutil.py","SecretPassphrase","./inuxnet.py.encrypted")
```
### decrypt
Decrypts bytes with passphrase.
```
Help on function decrypt in module inuxnetutil.inuxnetutil:
decrypt(data: bytes, passphrase: str) -> bytes
Decrypts bytes of data with passphrase, returns string
:param data: <class 'bytes'>
- Encrypted bytes
:param passphrase:
- Passphrase to decrypt
:return: <class 'bytes'>
- Decrypted data
Examples:
>>> encrypted_string = "zuwUtqziG65qxvqBtGCJHWdBQUFBQUJuVExkSk16WWc3MkIxV1dHX29HYnQ2MTluR1BQMW1yb0pkdC11Z2x3SG1nU0RMcGhwNlJyNlo2bkEyTkVQeHEyLTF6VHdzQnJyZzhBWXJkZENXRFFIdlR1UVo0a3pIS24zajJncEhTZDVkdEYwdEl3PQ=="
>>> # This string is base64 Encoded so it will need to be decoded into original bytes
>>> decrypted_string = decrypt(base64.b64decode(encrypted_string),"SecretPassphrase")
>>> print(decrypted_string.decode('utf-8'))
Secret to encrypt
```
### decrypt_file
Decrypts file with passphrase and outputs to decrypted file.
```
Help on function decrypt_file in module inuxnetutil.inuxnetutil:
decrypt_file(file_path: str, passphrase: str, output_path: str)
Derives a key from bytes
:param file_path: <class 'str'>
- The file path of the encrypted file to decrypt
:param passphrase: <class 'str'>
- The passphrase the file is encrypted with.
:param output_path: <class 'str'>
- The output file path for decrypted file.
Examples:
>>> decrypt_file("./inuxnet.py.encrypted","SecretPassphrase","./inuxnet.py.decrypted")
```
### validate_password
Validates Password complexity and input.
```
Help on function validate_password in module inuxnetutil.inuxnetutil:
validate_password(password: str, display_help: bool = True) -> bool
Validates password
:param password: <class 'str'>
:param display_help: <class 'bool'>
- Displays Help if password is invalid, defaults to True
:return: <class 'bool'>
Example:
>>> validate_password("abc123")
Invalid Password (Invalid Length):
* Must contain at least one Uppercase Letter
* Must Contain at least 1 Lowercase Letter
* Must Contain at least 1 Number
* Must Contain at least one of the following
special characters ~!@#$%^&*()_-+`{}|[]\:";<>?,/.
* Must *NOT* Contain spaces or apostrophes
* Must be at least 8 characters in length.
False
>>> validate_password("abc123", display_help=False)
False
>>> validate_password("Pq1@yuguytfyt")
True
```
### printpasswordhelp
Prints help output for password.
```
Help on function printpasswordhelp in module inuxnetutil.inuxnetutil:
printpasswordhelp(msg: str)
Prints Password requirments
:param msg: <class 'str'>
- The specific message
Examples:
>>> printpasswordhelp("Your Password is not complex enough")
Invalid Password (Your Password is not complex enough):
* Must contain at least one Uppercase Letter
* Must Contain at least 1 Lowercase Letter
* Must Contain at least 1 Number
* Must Contain at least one of the following
special characters ~!@#$%^&*()_-+`{}|[]\:";<>?,/.
* Must *NOT* Contain spaces or apostrophes
* Must be at least 8 characters in length.
```
### get_valid_password
Gets a valid password from standard input. Does not echo to console.
```
Help on function get_valid_password in module inuxnetutil.inuxnetutil:
get_valid_password(validate: bool = True, complexity: bool = True) -> str
Returns a valid password
:param validate: <class 'bool'>
- Must enter the password twice if True, defaults to True
:param complexity: <class 'bool'>
- Password must be reasonably complex, defaults to True
:return: <class 'str'>
- The valid password entered
Examples:
>>> password = get_valid_password()
Enter your passphrase:
ReEnter your passphrase:
>>> print(password)
Pq1@yuguytfyt
>>> password = get_valid_password(validate=False)
Enter your passphrase:
>>> print(password)
Pq1@yuguytfyt
>>> password = get_valid_password(validate=False) # Attempted password is abc123
Enter your passphrase:
Invalid Password (Invalid Length):
* Must contain at least one Uppercase Letter
* Must Contain at least 1 Lowercase Letter
* Must Contain at least 1 Number
* Must Contain at least one of the following
special characters ~!@#$%^&*()_-+`{}|[]\:";<>?,/.
* Must *NOT* Contain spaces or apostrophes
* Must be at least 8 characters in length.
Enter your passphrase:
>>> print(password)
Pq1@yuguytfyt
>>> password = get_valid_password(validate=False, complexity=False) # Password is abc123
Enter your passphrase:
>>> print(password)
abc123
```
### send_mail
Simple function that can send email.
```
Help on function send_mail in module inuxnetutil.inuxnetutil:
send_mail(to_address: str, subject: str, body: str, from_address: str, relay_host: str, relay_port=25, html_body: str = None, attachment_path: str = None)
Sends an email using a mail relay.
:param to_address: <class 'str'>
- Recipient email address.
:param subject: <class 'str'>
- Subject of the email.
:param body: <class 'str'>
- Body of the email.
:param from_address: <class 'str'>
- Sender email address.
:param relay_host: <class 'str'>
- Mail relay host.
:param relay_port: <class 'int'>
- Port of the mail relay (default is 25).
:param html_body: <class 'str'>
- (Optional) HTML body of the email.
:param attachment_path: <class 'str'>
- Path to an optional attachment file.
Example:
>>> from_address = "bob@example.org"
>>> to = "sarah@example.org"
>>> subject = "Testing send_mail"
>>> body="This is the plain text version of the email."
>>> html_body="<html><body><h1>This is an HTML Email</h1><p>HTML content here.</p></body></html>",
>>> attachment = "./README.md"
>>> relay_host = "mailrelay.example.org"
>>> send_mail(to_address=to, from_address=from_address, subject=subject, relay_host=relay_host, body=body, html_body=html_body, attachment_path=attachment)
Email sent successfully to sarah@example.org
```
## Commandline Usage
### encrypt
Encrypt piped/argument data to standard output.
#### Usage:
```
usage: encrypt [-h] [-d DATA] [-p PASSPHRASE] [--nocomplexity] [--novalidate]
Encrypts a string with passphrase.
options:
-h, --help show this help message and exit
-d DATA, --data DATA The string data to encrypt.
-p PASSPHRASE, --passphrase PASSPHRASE
(Optional) Passphrase to encrypt the info, if omitted will query user.
--nocomplexity (Optional) Do not require complexity for passphrase, defaults to True
--novalidate (Optional) Do not validate password input, defaults to true
Examples:
echo "Secret to encrypt" | encrypt -p 'P@ssw0rd'
encrypt "Secret to encrypt"
encrypt "Secret to encrypt" --passphrase='P@ssw0rd'
```
#### Examples:
```
$ data=$(echo -n "Secret to encrypt" | encrypt -p "Pq1@yuguytfyt")
$ echo $data
yjeIs+xIh9ByJ2cMYsZUW2dBQUFBQUJuVE1JQ1VrbzRiMkdCbC1iZTBSdkpnTklTMGxabkVIaWVZT0dXX3pVN05Ba1lxQjNiazQydzhfMW5KZlZ2dC0yZzRjb1EzallTQ1FQUHJwajN4ekpneWJZdW5UakNnVlc4X0c0bmpUV0hONTV5cEtNPQ==
$ data=$(echo -n "Secret to encrypt" | encrypt -p "abc123")
Invalid Password (Invalid Length):
* Must contain at least one Uppercase Letter
* Must Contain at least 1 Lowercase Letter
* Must Contain at least 1 Number
* Must Contain at least one of the following
special characters ~!@#$%^&*()_-+`{}|[]\:";<>?,/.
* Must *NOT* Contain spaces or apostrophes
$ data=$(echo -n "Secret to encrypt" | encrypt -p "abc123" --nocomplexity)
$ echo $data
PNHo8WZKK6r/ZY7xfxcxwmdBQUFBQUJuVE1oR1lQcDRuSWF4WXV2QjNiRjVwaGFSc0hpUmg2U3NzQ3F3VWxPQ29lMTRWNGhIaloxamxIblJUa0lneGZwbHpzaGttalhCTGNNblNfMlFBU0xaQVhReFkxbE5kRzhVY21QZldfbi00eHNwaDNZPQ==
$ data=$(echo -n "Secret to encrypt" | encrypt) # Entered Pq1@yuguytfyt
Enter your passphrase:
ReEnter your passphrase:
$ echo $data
m1hMHna+o774ZTMrnojH32dBQUFBQUJuVE1rUnk3SmFWeE9ycng0WUxGb3ZiOGFlOGdubHFZWVdyaF9EY1VvYmhVWVNlMmpMbExiVTFOZDdWdEpqVm1BQXpEMk9WQ3NNZkhGU0dPa2FjUk01U3dXQjFObnBMc1M4V2tqRHUyanRIYUpQMHFJPQ==
$ data=$(echo -n "Secret to encrypt" | encrypt --novalidate) # Entered Pq1@yuguytfyt
Enter your passphrase:
$ echo $data
wxQD3AayG4gpoyc6SS/4AWdBQUFBQUJuVE1tcjd2OVpnZnBTZVVMR3kwT25Xcm1BQnNJVkZFVThxYU92SG5rZEhJOXQyRE9qQTMyT0dIdWxNYXhfeXRpazd4NVQ0c194TVVfalJpNUZTd1E5clBBNkhhdTBva1JyVHZPN1dBcG5YLUhjcUpvPQ==
```
### decrypt
Decrypt piped/argument data to standard output.
#### Usage:
```
usage: decrypt [-h] [-d DATA] [-p PASSPHRASE]
Encrypts a string with passphrase.
options:
-h, --help show this help message and exit
-d DATA, --data DATA The string data to encrypt.
-p PASSPHRASE, --passphrase PASSPHRASE
(Optional) Passphrase to encrypt the info, if omitted will query user.
Examples:
cat encrypted_file.txt | decrypt -p 'P@ssw0rd'
decrypt "hd78hgdf832f7g78=="
decrypt "hd78hgdf832f7g78==" --passphrase='P@ssw0rd'
```
#### Examples:
```
$ decrypted_data=$(echo -n $data | decrypt -p 'Pq1@yuguytfyt')
$ echo $decrypted_data
Secret to encrypt
$ decrypted_data=$(echo -n $data | decrypt)
Enter your passphrase:
$ echo $decrypted_data
Secret to encrypt
```
### encryptfile
Encrypts a file to output file.
#### Usage:
```
usage: encryptfile [-h] [--nocomplexity] [--novalidate] [-p PASSPHRASE] [-k KEYFILE] [-f OUTFILE]
Encrypts a file with passphrase.
options:
-h, --help show this help message and exit
--nocomplexity (Optional) Do not require complexity for passphrase, defaults to True
--novalidate (Optional) Do not validate password input, defaults to true
-p PASSPHRASE, --passphrase PASSPHRASE
(Optional) Passphrase to encrypt the info, if omitted will query user.
-k KEYFILE, --keyfile KEYFILE
The file that needs to be encrypted or decrypted.
-f OUTFILE, --outfile OUTFILE
The resulting output file.
Examples:
encryptfile -p 'P@ssw0rd' -k ./id_rsa -f /tmp/id_rsa.enc
encryptfile --passphrase='P@ssw0rd' --keyfile=./id_rsa --outfile=/tmp/id_rsa.enc
encryptfile -k ./id_rsa -f /tmp/id_rsa.enc
```
#### Examples:
```
$ encryptfile -p "abc123" --nocomplexity -k "inuxnetutil/inuxnetutil.py" -f "./inuxnet.py.enc"
$ encryptfile -p "abc123" -k "inuxnetutil/inuxnetutil.py" -f "./inuxnet.py.enc"
Invalid Password (Invalid Length):
* Must contain at least one Uppercase Letter
* Must Contain at least 1 Lowercase Letter
* Must Contain at least 1 Number
* Must Contain at least one of the following
special characters ~!@#$%^&*()_-+`{}|[]\:";<>?,/.
* Must *NOT* Contain spaces or apostrophes
* Must be at least 8 characters in length.
$ encryptfile -k "inuxnetutil/inuxnetutil.py" -f "./inuxnet.py2.enc" # Entered Pq1@yuguytfyt
Enter your passphrase:
ReEnter your passphrase:
```
## decryptfile
Decrypts an encrypted file to output file.
#### Usage:
```
usage: decryptfile [-h] [-p PASSPHRASE] [-k KEYFILE] [-f OUTFILE]
Decrypts a file with passphrase.
options:
-h, --help show this help message and exit
-p PASSPHRASE, --passphrase PASSPHRASE
(Optional) Passphrase to encrypt the info, if omitted will query user.
-k KEYFILE, --keyfile KEYFILE
The file that needs to be encrypted or decrypted.
-f OUTFILE, --outfile OUTFILE
The resulting output file.
Examples:
decryptfile -p 'P@ssw0rd' -k ./id_rsa.enc -f /tmp/id_rsa
decryptfile --passphrase='P@ssw0rd' --keyfile=./id_rsa.enc --outfile=/tmp/id_rsa
decryptfile -k ./id_rsa.enc -f /tmp/id_rsa
```
#### Examples:
```
$ decryptfile -p "abc123" -k "inuxnet.py.enc" -f "inuxnet.py.decrypted"
$ decryptfile -p "abc123" -k "inuxnet.py2.enc" -f "inuxnet.py2.decrypted"
Cannot Decrypt. Invalid Passphrase or Encrypted File.
$ decryptfile -k "inuxnet.py2.enc" -f "inuxnet.py2.decrypted" # Entered Pq1@yuguytfyt
Enter your passphrase:
$ ls inuxnet.py2.decrypted
inuxnet.py2.decrypted
$ diff inuxnet.py2.decrypted inuxnetutil/inuxnetutil.py
$ echo $?
0
```
### cryptfile
Both encryptfile and decryptfile wrapped in one command.
#### Usage:
```
usage: cryptfile [-h] -o {ENCRYPT,DECRYPT} [--nocomplexity] [--novalidate] [-p PASSPHRASE] [-k KEYFILE] [-f OUTFILE]
Encrypts or Decrypts a file with passphrase.
options:
-h, --help show this help message and exit
-o {ENCRYPT,DECRYPT}, --operation {ENCRYPT,DECRYPT}
Specify the operation: ENCRYPT or DECRYPT
--nocomplexity (Optional) Do not require complexity for passphrase, defaults to True
--novalidate (Optional) Do not validate password input, defaults to true
-p PASSPHRASE, --passphrase PASSPHRASE
(Optional) Passphrase to encrypt the info, if omitted will query user.
-k KEYFILE, --keyfile KEYFILE
The file that needs to be encrypted or decrypted.
-f OUTFILE, --outfile OUTFILE
The resulting output file.
Examples:
cryptfile -o ENCRYPT -p 'P@ssw0rd' -k ./id_rsa -f /tmp/id_rsa.enc
cryptfile --operation=DECRYPT --passphrase='P@ssw0rd' --keyfile=./id_rsa.enc --outfile=/tmp/id_rsa
cryptfile -o ENCRYPT -k ./id_rsa -f /tmp/id_rsa.enc
```
#### Examples:
See the examples for encryptfile and decryptfile with the exception
that the --operation, -o {ENCRYPT|DECRYPT} needs to be added.
### send_mail
Tool to send mail from the command line.
#### Usage:
```
usage: send_mail [-h] --to TO --from_address FROM_ADDRESS --subject SUBJECT --body BODY --relay_host RELAY_HOST [--relay_port RELAY_PORT] [--html_body HTML_BODY] [--attachment_path ATTACHMENT_PATH]
Sends email.
options:
-h, --help show this help message and exit
--to TO Recipient Address
--from_address FROM_ADDRESS
Sender Address
--subject SUBJECT Subject
--body BODY Body
--relay_host RELAY_HOST
SMTP Server
--relay_port RELAY_PORT
SMTP Port, Defaults to 25
--html_body HTML_BODY
(Optional) HTML Body
--attachment_path ATTACHMENT_PATH
(Optional) Attachment path
Examples:
send_email --to sarah@example.org --from bob@example.org --subject "Hello" --body "How are you?" \
--relay_host mailrelay.example.org
send_email --to sarah@example.org --from bob@example.org --subject "Hello" --body "How are you?" \
--relay_host mailrelay.example.org \
--html_body "<html><body><h1>Hello</h1><p>How are you?</p></body></html>" \
--attachment_path ./README.md
```
#### Examples:
```
$ send_mail --to sarah@example.org --from bob@example.org --subject "Test from CMD" --body "Test from command" \
--relay_host mailrelay.example.org
Email sent successfully to sarah@example.org
```
Raw data
{
"_id": null,
"home_page": "https://newgit.inuxnet.org/devel/inuxnetutil.git",
"name": "inuxnetutil",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "validation, encrypt, decrypt, inuxnet",
"author": "Jess Williams",
"author_email": "Jess Williams <devel@inuxnet.org>",
"download_url": "https://files.pythonhosted.org/packages/3b/c1/88fcd0ba6a5301df207210f0671c4f35afdd4dbf1dc9ad8eec0b93c83880/inuxnetutil-0.1.2.tar.gz",
"platform": null,
"description": "# inuxnetutil\nThis library and set of tools are common functions and tools used in various Inuxnet\nprojects.\n\n## Installing\nThis module requires cryptography. It is advisable to install this inside a virtual\nenvironment. \n\n### Setting up and activating the Python Virtual Environment\n\nIt is recommended to install within a Python Virtual Environment, please review your \nspecific OS instructions to install VirtualEnv on your system.\n\nFrom the directory of the repository:\n\n```\npython3 -m venv venv\n```\n\nActivating the Virtual Environment:\n```\n. venv/bin/activate\n```\n\nTo exit the Virtual Environment:\n\n```\ndeactivate\n```\n\n### Installing using the setup.py\n\nAll commands should be run from the root directory of the repository.\n```\npip install -r requirements.txt\npython3 setup.py install\n```\n\n### Installing from [PyPi](https://pypi.org/project/inuxnetutil/0.1.0/)\n\n```\npip install inuxnetutil\n```\n\n## Pythonic Usage\n\n### validate_argument\nPython is not strictly typed and will allow any type to be input\nas arguments for functions and methods. Used to validate input \nparameters for functions and methods to ensure the proper data \nis being input as arguments.\n```\nHelp on function validate_argument in module inuxnetutil.inuxnetutil:\n\nvalidate_argument(argument: object, arg_types: type, arg_name: str = 'argument', nullable: bool = False, message: str = \"Parameter {arg_name} '{argument}' must be of type {' or '.join([ f'{x}' for x in arg_types ])}.\") -> object\n Validates argument, raises TypeError or returns argument\n :param argument: <class 'any'>\n - This can be any type that needs to match\n :param arg_types: <class 'list'> or <class 'tuple'> or <class 'type'>\n - A list/tuple of <class 'type'> to match\n :param arg_name: <class 'str'>\n - The name of the argument being passed in. Defaults to \"argument\"\n :param nullable: <class 'bool'>\n - If None is allowed as an input parameter\n :param message: <class 'str'>\n - Custom error message, defaults to:\n f\"Parameter {arg_name} '{argument}' must be of type {' or '.join([ f'{x}' for x in arg_types ])}\"\n :return: <class 'object'>\n - returns the argument object\n \nExample:\n>>> arg = validate_argument(\"123\", int)\nTraceback (most recent call last):\n File \"<stdin>\", line 1, in <module>\n File \"inuxnetutil.py\", line 74, in validate_argument\n raise TypeError(msg)\nTypeError: Parameter argument '123' must be of type <class 'int'>.\n\n>>> arg = 123\n>>> validate_argument(arg, [str,float], \"parameter_name\")\nTraceback (most recent call last):\n File \"<stdin>\", line 1, in <module>\n File \"inuxnetutil.py\", line 74, in validate_argument\n raise TypeError(msg)\nTypeError: Parameter parameter_name '123' must be of type <class 'str'> or <class 'float'>.\n\n>>> validate_argument(arg, [int,float], \"people_count\")\n123\n\n>>> arg = None\n>>> validate_argument(arg, [int,float], \"people_count\", True)\n```\n\n### is_empty_string\nThis is an extension of validate_argument and will ensure that the\nstring data is not empty.\n```\nHelp on function is_empty_string in module inuxnetutil.inuxnetutil:\n\nis_empty_string(arg: str, arg_name: str = None, nullable: bool = False) -> str\n Validates arguments and ensures no empty string if not nullable\n :param arg: <class 'str'>\n - Since it is validating an empty string, must be a string\n :param arg_name: <class 'str'>\n - The argument name, defaults to 'argument'\n :param nullable: <class 'bool'>\n - If None is allowed as an input parameter\n :return: <class 'str'>\n - Returns the string passed in.\n \nExamples:\n\n>>> data = ''\n>>> is_empty_string(data, \"data\")\nTraceback (most recent call last):\n File \"<stdin>\", line 1, in <module>\n File \"inuxnetutil.py\", line 92, in is_empty_string\n raise ValueError(f\"{arg_name} '{arg}' must have a valid value, cannot be empty.\")\nValueError: data '' must have a valid value, cannot be empty.\n```\n\n### validate_filepath\nAn extension of validate_argument that validates a file exists.\n```\nHelp on function validate_filepath in module inuxnetutil.inuxnetutil:\n\nvalidate_filepath(filepath: str)\n Validates file path.\n :param filepath: <class 'str'>\n - The filepath to validate\n \nExamples:\n\n>>> validate_filepath(\"some_non_existent_file.txt\")\nTraceback (most recent call last):\n File \"<stdin>\", line 1, in <module>\n File \"inuxnetutil.py\", line 106, in validate_filepath\n raise ValueError(f\"{filepath} is invalid. Either invalid path or permissions.\")\nValueError: some_non_existent_file.txt is invalid. Either invalid path or permissions.\n\n>>> print(validate_filepath(\"inuxnetutil/inuxnetutil.py\")) # Valid Path\nNone\n```\n\n### derive_key\nDerives a byte encoded key from passphrase, used for encrypting/decrypting.\n```\nHelp on function derive_key in module inuxnetutil.inuxnetutil:\n\nderive_key(passphrase: str, salt: bytes) -> bytes\n Derives a key from passphrase and salt.\n :param passphrase: <class 'str'>\n - The passphrase to derive key from.\n :param salt: <class 'bytes'>\n - The salt to spice the key.\n :return: <class 'bytes'>\n \nExamples:\n>>> salt = os.urandom(16)\n>>> key = derive_key(\"SecretPassphrase\", salt)\n>>> print(key.decode('utf-8'))\nzLXClPOw_ZPUm0wucc9GRFMu2p8ScsbHNZh1zuJsR2s=\n```\n\n### encrypt\nEncrypts bytes with passphrase and salt.\n```\nHelp on function encrypt in module inuxnetutil.inuxnetutil:\n\nencrypt(data: bytes, passphrase: str, salt: bytes = None) -> bytes\n Encrypts a list of bytes, returns encrypted bytes\n :param data: <class 'bytes'>\n - The unencrypted bytes.\n :param passphrase: <class 'str'>\n - The passphrase to encrypt with.\n :param salt: <class 'bytes'>\n - Season the encryption, defaults to None and generates random salt\n :return: <class 'bytes'>\n - Encrypted bytes\n\nExamples:\n>>> text = \"Secret to encrypt\"\n>>> encrypted_text = encrypt(text.encode('utf-8'), \"SecretPassphrase\")\n>>> print(base64.b64encode(encrypted_text).decode('utf-8'))\nzuwUtqziG65qxvqBtGCJHWdBQUFBQUJuVExkSk16WWc3MkIxV1dHX29HYnQ2MTluR1BQMW1yb0pkdC11Z2x3SG1nU0RMcGhwNlJyNlo2bkEyTkVQeHEyLTF6VHdzQnJyZzhBWXJkZENXRFFIdlR1UVo0a3pIS24zajJncEhTZDVkdEYwdEl3PQ==\n```\n\n### encrypt_file\nEncrypts file with passphrase and outputs to encrypted file.\n```\nHelp on function encrypt_file in module inuxnetutil.inuxnetutil:\n\nencrypt_file(file_path: str, passphrase: str, output_path: str)\n Encrypts file\n :param file_path: <class 'str'>\n - The file path of the file to encrypt.\n :param passphrase: <class 'str'>\n - The passphrase to encrypt the file with.\n :param output_path: <class 'str'>\n - The file path of the output encrypted file.\n \nExamples:\n>>> encrypt_file(\"inuxnetutil/inuxnetutil.py\",\"SecretPassphrase\",\"./inuxnet.py.encrypted\")\n```\n\n### decrypt\nDecrypts bytes with passphrase.\n```\nHelp on function decrypt in module inuxnetutil.inuxnetutil:\n\ndecrypt(data: bytes, passphrase: str) -> bytes\n Decrypts bytes of data with passphrase, returns string\n :param data: <class 'bytes'>\n - Encrypted bytes\n :param passphrase:\n - Passphrase to decrypt\n :return: <class 'bytes'>\n - Decrypted data\n\nExamples:\n>>> encrypted_string = \"zuwUtqziG65qxvqBtGCJHWdBQUFBQUJuVExkSk16WWc3MkIxV1dHX29HYnQ2MTluR1BQMW1yb0pkdC11Z2x3SG1nU0RMcGhwNlJyNlo2bkEyTkVQeHEyLTF6VHdzQnJyZzhBWXJkZENXRFFIdlR1UVo0a3pIS24zajJncEhTZDVkdEYwdEl3PQ==\"\n>>> # This string is base64 Encoded so it will need to be decoded into original bytes\n>>> decrypted_string = decrypt(base64.b64decode(encrypted_string),\"SecretPassphrase\")\n>>> print(decrypted_string.decode('utf-8'))\nSecret to encrypt\n```\n\n### decrypt_file\nDecrypts file with passphrase and outputs to decrypted file.\n```\nHelp on function decrypt_file in module inuxnetutil.inuxnetutil:\n\ndecrypt_file(file_path: str, passphrase: str, output_path: str)\n Derives a key from bytes\n :param file_path: <class 'str'>\n - The file path of the encrypted file to decrypt\n :param passphrase: <class 'str'>\n - The passphrase the file is encrypted with.\n :param output_path: <class 'str'>\n - The output file path for decrypted file.\n\nExamples:\n>>> decrypt_file(\"./inuxnet.py.encrypted\",\"SecretPassphrase\",\"./inuxnet.py.decrypted\")\n```\n\n### validate_password\nValidates Password complexity and input.\n```\nHelp on function validate_password in module inuxnetutil.inuxnetutil:\n\nvalidate_password(password: str, display_help: bool = True) -> bool\n Validates password\n :param password: <class 'str'>\n :param display_help: <class 'bool'>\n - Displays Help if password is invalid, defaults to True \n :return: <class 'bool'>\n \nExample:\n>>> validate_password(\"abc123\")\nInvalid Password (Invalid Length):\n * Must contain at least one Uppercase Letter\n * Must Contain at least 1 Lowercase Letter\n * Must Contain at least 1 Number\n * Must Contain at least one of the following\n special characters ~!@#$%^&*()_-+`{}|[]\\:\";<>?,/.\n * Must *NOT* Contain spaces or apostrophes\n * Must be at least 8 characters in length.\nFalse\n\n>>> validate_password(\"abc123\", display_help=False)\nFalse\n\n>>> validate_password(\"Pq1@yuguytfyt\")\nTrue\n```\n\n### printpasswordhelp\nPrints help output for password.\n```\nHelp on function printpasswordhelp in module inuxnetutil.inuxnetutil:\n\nprintpasswordhelp(msg: str)\n Prints Password requirments\n :param msg: <class 'str'>\n - The specific message\n\nExamples:\n>>> printpasswordhelp(\"Your Password is not complex enough\")\nInvalid Password (Your Password is not complex enough):\n * Must contain at least one Uppercase Letter\n * Must Contain at least 1 Lowercase Letter\n * Must Contain at least 1 Number\n * Must Contain at least one of the following\n special characters ~!@#$%^&*()_-+`{}|[]\\:\";<>?,/.\n * Must *NOT* Contain spaces or apostrophes\n * Must be at least 8 characters in length.\n```\n\n### get_valid_password\nGets a valid password from standard input. Does not echo to console.\n```\nHelp on function get_valid_password in module inuxnetutil.inuxnetutil:\n\nget_valid_password(validate: bool = True, complexity: bool = True) -> str\n Returns a valid password\n :param validate: <class 'bool'>\n - Must enter the password twice if True, defaults to True\n :param complexity: <class 'bool'>\n - Password must be reasonably complex, defaults to True\n :return: <class 'str'>\n - The valid password entered\n\nExamples:\n>>> password = get_valid_password()\nEnter your passphrase: \nReEnter your passphrase: \n>>> print(password)\nPq1@yuguytfyt\n\n>>> password = get_valid_password(validate=False)\nEnter your passphrase: \n>>> print(password)\nPq1@yuguytfyt\n\n>>> password = get_valid_password(validate=False) # Attempted password is abc123\nEnter your passphrase: \nInvalid Password (Invalid Length):\n * Must contain at least one Uppercase Letter\n * Must Contain at least 1 Lowercase Letter\n * Must Contain at least 1 Number\n * Must Contain at least one of the following\n special characters ~!@#$%^&*()_-+`{}|[]\\:\";<>?,/.\n * Must *NOT* Contain spaces or apostrophes\n * Must be at least 8 characters in length.\nEnter your passphrase:\n>>> print(password)\nPq1@yuguytfyt\n\n>>> password = get_valid_password(validate=False, complexity=False) # Password is abc123\nEnter your passphrase:\n>>> print(password)\nabc123\n```\n\n### send_mail\nSimple function that can send email.\n```\nHelp on function send_mail in module inuxnetutil.inuxnetutil:\n\nsend_mail(to_address: str, subject: str, body: str, from_address: str, relay_host: str, relay_port=25, html_body: str = None, attachment_path: str = None)\n Sends an email using a mail relay.\n :param to_address: <class 'str'>\n - Recipient email address.\n :param subject: <class 'str'>\n - Subject of the email.\n :param body: <class 'str'>\n - Body of the email.\n :param from_address: <class 'str'>\n - Sender email address.\n :param relay_host: <class 'str'>\n - Mail relay host.\n :param relay_port: <class 'int'>\n - Port of the mail relay (default is 25).\n :param html_body: <class 'str'>\n - (Optional) HTML body of the email.\n :param attachment_path: <class 'str'>\n - Path to an optional attachment file.\n \nExample:\n>>> from_address = \"bob@example.org\"\n>>> to = \"sarah@example.org\"\n>>> subject = \"Testing send_mail\"\n>>> body=\"This is the plain text version of the email.\"\n>>> html_body=\"<html><body><h1>This is an HTML Email</h1><p>HTML content here.</p></body></html>\",\n>>> attachment = \"./README.md\"\n>>> relay_host = \"mailrelay.example.org\"\n>>> send_mail(to_address=to, from_address=from_address, subject=subject, relay_host=relay_host, body=body, html_body=html_body, attachment_path=attachment)\nEmail sent successfully to sarah@example.org\n```\n## Commandline Usage\n\n### encrypt\nEncrypt piped/argument data to standard output.\n\n#### Usage:\n```\nusage: encrypt [-h] [-d DATA] [-p PASSPHRASE] [--nocomplexity] [--novalidate]\n\nEncrypts a string with passphrase.\n\noptions:\n -h, --help show this help message and exit\n -d DATA, --data DATA The string data to encrypt.\n -p PASSPHRASE, --passphrase PASSPHRASE\n (Optional) Passphrase to encrypt the info, if omitted will query user.\n --nocomplexity (Optional) Do not require complexity for passphrase, defaults to True\n --novalidate (Optional) Do not validate password input, defaults to true\n\nExamples:\n echo \"Secret to encrypt\" | encrypt -p 'P@ssw0rd'\n encrypt \"Secret to encrypt\"\n encrypt \"Secret to encrypt\" --passphrase='P@ssw0rd'\n```\n\n#### Examples:\n```\n$ data=$(echo -n \"Secret to encrypt\" | encrypt -p \"Pq1@yuguytfyt\")\n$ echo $data\nyjeIs+xIh9ByJ2cMYsZUW2dBQUFBQUJuVE1JQ1VrbzRiMkdCbC1iZTBSdkpnTklTMGxabkVIaWVZT0dXX3pVN05Ba1lxQjNiazQydzhfMW5KZlZ2dC0yZzRjb1EzallTQ1FQUHJwajN4ekpneWJZdW5UakNnVlc4X0c0bmpUV0hONTV5cEtNPQ==\n\n$ data=$(echo -n \"Secret to encrypt\" | encrypt -p \"abc123\")\nInvalid Password (Invalid Length):\n * Must contain at least one Uppercase Letter\n * Must Contain at least 1 Lowercase Letter\n * Must Contain at least 1 Number\n * Must Contain at least one of the following\n special characters ~!@#$%^&*()_-+`{}|[]\\:\";<>?,/.\n * Must *NOT* Contain spaces or apostrophes\n \n$ data=$(echo -n \"Secret to encrypt\" | encrypt -p \"abc123\" --nocomplexity)\n$ echo $data\nPNHo8WZKK6r/ZY7xfxcxwmdBQUFBQUJuVE1oR1lQcDRuSWF4WXV2QjNiRjVwaGFSc0hpUmg2U3NzQ3F3VWxPQ29lMTRWNGhIaloxamxIblJUa0lneGZwbHpzaGttalhCTGNNblNfMlFBU0xaQVhReFkxbE5kRzhVY21QZldfbi00eHNwaDNZPQ==\n\n$ data=$(echo -n \"Secret to encrypt\" | encrypt) # Entered Pq1@yuguytfyt\nEnter your passphrase:\nReEnter your passphrase:\n$ echo $data\nm1hMHna+o774ZTMrnojH32dBQUFBQUJuVE1rUnk3SmFWeE9ycng0WUxGb3ZiOGFlOGdubHFZWVdyaF9EY1VvYmhVWVNlMmpMbExiVTFOZDdWdEpqVm1BQXpEMk9WQ3NNZkhGU0dPa2FjUk01U3dXQjFObnBMc1M4V2tqRHUyanRIYUpQMHFJPQ==\n\n$ data=$(echo -n \"Secret to encrypt\" | encrypt --novalidate) # Entered Pq1@yuguytfyt\nEnter your passphrase:\n$ echo $data\nwxQD3AayG4gpoyc6SS/4AWdBQUFBQUJuVE1tcjd2OVpnZnBTZVVMR3kwT25Xcm1BQnNJVkZFVThxYU92SG5rZEhJOXQyRE9qQTMyT0dIdWxNYXhfeXRpazd4NVQ0c194TVVfalJpNUZTd1E5clBBNkhhdTBva1JyVHZPN1dBcG5YLUhjcUpvPQ==\n```\n\n### decrypt\nDecrypt piped/argument data to standard output.\n\n#### Usage:\n```\nusage: decrypt [-h] [-d DATA] [-p PASSPHRASE]\n\nEncrypts a string with passphrase.\n\noptions:\n -h, --help show this help message and exit\n -d DATA, --data DATA The string data to encrypt.\n -p PASSPHRASE, --passphrase PASSPHRASE\n (Optional) Passphrase to encrypt the info, if omitted will query user.\n\nExamples:\n cat encrypted_file.txt | decrypt -p 'P@ssw0rd'\n decrypt \"hd78hgdf832f7g78==\"\n decrypt \"hd78hgdf832f7g78==\" --passphrase='P@ssw0rd'\n```\n\n#### Examples:\n```\n$ decrypted_data=$(echo -n $data | decrypt -p 'Pq1@yuguytfyt')\n$ echo $decrypted_data\nSecret to encrypt\n\n$ decrypted_data=$(echo -n $data | decrypt)\nEnter your passphrase:\n$ echo $decrypted_data\nSecret to encrypt\n```\n\n### encryptfile\nEncrypts a file to output file.\n\n#### Usage:\n```\nusage: encryptfile [-h] [--nocomplexity] [--novalidate] [-p PASSPHRASE] [-k KEYFILE] [-f OUTFILE]\n\nEncrypts a file with passphrase.\n\noptions:\n -h, --help show this help message and exit\n --nocomplexity (Optional) Do not require complexity for passphrase, defaults to True\n --novalidate (Optional) Do not validate password input, defaults to true\n -p PASSPHRASE, --passphrase PASSPHRASE\n (Optional) Passphrase to encrypt the info, if omitted will query user.\n -k KEYFILE, --keyfile KEYFILE\n The file that needs to be encrypted or decrypted.\n -f OUTFILE, --outfile OUTFILE\n The resulting output file.\n\nExamples:\n encryptfile -p 'P@ssw0rd' -k ./id_rsa -f /tmp/id_rsa.enc\n encryptfile --passphrase='P@ssw0rd' --keyfile=./id_rsa --outfile=/tmp/id_rsa.enc\n encryptfile -k ./id_rsa -f /tmp/id_rsa.enc\n```\n\n#### Examples:\n```\n$ encryptfile -p \"abc123\" --nocomplexity -k \"inuxnetutil/inuxnetutil.py\" -f \"./inuxnet.py.enc\"\n\n$ encryptfile -p \"abc123\" -k \"inuxnetutil/inuxnetutil.py\" -f \"./inuxnet.py.enc\"\nInvalid Password (Invalid Length):\n * Must contain at least one Uppercase Letter\n * Must Contain at least 1 Lowercase Letter\n * Must Contain at least 1 Number\n * Must Contain at least one of the following\n special characters ~!@#$%^&*()_-+`{}|[]\\:\";<>?,/.\n * Must *NOT* Contain spaces or apostrophes\n * Must be at least 8 characters in length.\n \n$ encryptfile -k \"inuxnetutil/inuxnetutil.py\" -f \"./inuxnet.py2.enc\" # Entered Pq1@yuguytfyt\nEnter your passphrase: \nReEnter your passphrase:\n```\n\n## decryptfile\nDecrypts an encrypted file to output file.\n\n#### Usage:\n```\nusage: decryptfile [-h] [-p PASSPHRASE] [-k KEYFILE] [-f OUTFILE]\n\nDecrypts a file with passphrase.\n\noptions:\n -h, --help show this help message and exit\n -p PASSPHRASE, --passphrase PASSPHRASE\n (Optional) Passphrase to encrypt the info, if omitted will query user.\n -k KEYFILE, --keyfile KEYFILE\n The file that needs to be encrypted or decrypted.\n -f OUTFILE, --outfile OUTFILE\n The resulting output file.\n\nExamples:\n decryptfile -p 'P@ssw0rd' -k ./id_rsa.enc -f /tmp/id_rsa\n decryptfile --passphrase='P@ssw0rd' --keyfile=./id_rsa.enc --outfile=/tmp/id_rsa\n decryptfile -k ./id_rsa.enc -f /tmp/id_rsa\n```\n\n#### Examples:\n```\n$ decryptfile -p \"abc123\" -k \"inuxnet.py.enc\" -f \"inuxnet.py.decrypted\"\n\n$ decryptfile -p \"abc123\" -k \"inuxnet.py2.enc\" -f \"inuxnet.py2.decrypted\"\nCannot Decrypt. Invalid Passphrase or Encrypted File.\n\n$ decryptfile -k \"inuxnet.py2.enc\" -f \"inuxnet.py2.decrypted\" # Entered Pq1@yuguytfyt\nEnter your passphrase:\n$ ls inuxnet.py2.decrypted\ninuxnet.py2.decrypted\n$ diff inuxnet.py2.decrypted inuxnetutil/inuxnetutil.py\n$ echo $?\n0\n```\n\n### cryptfile\nBoth encryptfile and decryptfile wrapped in one command.\n\n#### Usage:\n```\nusage: cryptfile [-h] -o {ENCRYPT,DECRYPT} [--nocomplexity] [--novalidate] [-p PASSPHRASE] [-k KEYFILE] [-f OUTFILE]\n\nEncrypts or Decrypts a file with passphrase.\n\noptions:\n -h, --help show this help message and exit\n -o {ENCRYPT,DECRYPT}, --operation {ENCRYPT,DECRYPT}\n Specify the operation: ENCRYPT or DECRYPT\n --nocomplexity (Optional) Do not require complexity for passphrase, defaults to True\n --novalidate (Optional) Do not validate password input, defaults to true\n -p PASSPHRASE, --passphrase PASSPHRASE\n (Optional) Passphrase to encrypt the info, if omitted will query user.\n -k KEYFILE, --keyfile KEYFILE\n The file that needs to be encrypted or decrypted.\n -f OUTFILE, --outfile OUTFILE\n The resulting output file.\n\nExamples:\n cryptfile -o ENCRYPT -p 'P@ssw0rd' -k ./id_rsa -f /tmp/id_rsa.enc\n cryptfile --operation=DECRYPT --passphrase='P@ssw0rd' --keyfile=./id_rsa.enc --outfile=/tmp/id_rsa\n cryptfile -o ENCRYPT -k ./id_rsa -f /tmp/id_rsa.enc\n```\n\n#### Examples:\nSee the examples for encryptfile and decryptfile with the exception\nthat the --operation, -o {ENCRYPT|DECRYPT} needs to be added.\n\n### send_mail\nTool to send mail from the command line.\n\n#### Usage:\n```\nusage: send_mail [-h] --to TO --from_address FROM_ADDRESS --subject SUBJECT --body BODY --relay_host RELAY_HOST [--relay_port RELAY_PORT] [--html_body HTML_BODY] [--attachment_path ATTACHMENT_PATH]\n\nSends email.\n\noptions:\n -h, --help show this help message and exit\n --to TO Recipient Address\n --from_address FROM_ADDRESS\n Sender Address\n --subject SUBJECT Subject\n --body BODY Body\n --relay_host RELAY_HOST\n SMTP Server\n --relay_port RELAY_PORT\n SMTP Port, Defaults to 25\n --html_body HTML_BODY\n (Optional) HTML Body\n --attachment_path ATTACHMENT_PATH\n (Optional) Attachment path\n\nExamples:\n send_email --to sarah@example.org --from bob@example.org --subject \"Hello\" --body \"How are you?\" \\\n --relay_host mailrelay.example.org\n send_email --to sarah@example.org --from bob@example.org --subject \"Hello\" --body \"How are you?\" \\\n --relay_host mailrelay.example.org \\ \n --html_body \"<html><body><h1>Hello</h1><p>How are you?</p></body></html>\" \\\n --attachment_path ./README.md\n```\n\n#### Examples:\n```\n$ send_mail --to sarah@example.org --from bob@example.org --subject \"Test from CMD\" --body \"Test from command\" \\\n --relay_host mailrelay.example.org\nEmail sent successfully to sarah@example.org\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Jess Williams Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Set of common handy functions and tools.",
"version": "0.1.2",
"project_urls": {
"Documentation": "https://newgit.inuxnet.org/devel/inuxnetutil.git",
"Homepage": "https://newgit.inuxnet.org/devel/inuxnetutil.git",
"Repository": "https://newgit.inuxnet.org/devel/inuxnetutil.git"
},
"split_keywords": [
"validation",
" encrypt",
" decrypt",
" inuxnet"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20acb6682148d00b0a057854d26b70715e2e326f61ba1915b48ea93b86aedb58",
"md5": "c88d80cb551d729ab4cbd08571bd9f64",
"sha256": "a0bb02a4e5acf05c244a77e23e6992728871f1e23f7cadd368c3dd3249230e1c"
},
"downloads": -1,
"filename": "inuxnetutil-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c88d80cb551d729ab4cbd08571bd9f64",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13480,
"upload_time": "2024-12-02T06:30:52",
"upload_time_iso_8601": "2024-12-02T06:30:52.977707Z",
"url": "https://files.pythonhosted.org/packages/20/ac/b6682148d00b0a057854d26b70715e2e326f61ba1915b48ea93b86aedb58/inuxnetutil-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bc188fcd0ba6a5301df207210f0671c4f35afdd4dbf1dc9ad8eec0b93c83880",
"md5": "23824aff7d115563a9fb43ff30a2a065",
"sha256": "14c579455c939adb1f402f6d79e65cdc6fcdab1c8e3aa58cbbff50c4249f631d"
},
"downloads": -1,
"filename": "inuxnetutil-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "23824aff7d115563a9fb43ff30a2a065",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14111,
"upload_time": "2024-12-02T06:30:55",
"upload_time_iso_8601": "2024-12-02T06:30:55.280543Z",
"url": "https://files.pythonhosted.org/packages/3b/c1/88fcd0ba6a5301df207210f0671c4f35afdd4dbf1dc9ad8eec0b93c83880/inuxnetutil-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 06:30:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "inuxnetutil"
}
