Skip to content

Commit 5bfc25f

Browse files
Add README.md for strings module
1 parent 7f82e9e commit 5bfc25f

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

encryption_helper/common/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<p align="center">
2+
<img src="https://www.hsbc.com/-/files/hsbc/header/hsbc-logo-200x25.svg" alt="HSBC Logo" width="200" title="HSBC Logo">
3+
</p>
4+
5+
<h1 align="center">Encryption Helper Python - Strings Module</h1>
6+
7+
<p align="center">
8+
<img src="../../assets/banner.jpg" alt="Encryption Helper Banner">
9+
</p>
10+
11+
<p align="center">
12+
<strong>Strings module for the encryption_helper package.</strong>
13+
</p>
14+
15+
<p align="center">
16+
<a href="#attributes">Attributes</a> •
17+
<a href="#usage">Usage</a> •
18+
<a href="#license">License</a>
19+
</p>
20+
21+
## Attributes
22+
23+
The `strings.py` module provides a collection of string constants used throughout the `encryption_helper` package. These constants include file suffixes for various key and encrypted file types.
24+
25+
- **private_key_suffix**: The file suffix for private key files.
26+
- **public_key_suffix**: The file suffix for public key files.
27+
- **encrypted_file_suffix**: The file suffix for encrypted files.
28+
29+
## Usage
30+
31+
This module defines string constants for use in the `encryption_helper` package. These constants help standardize file naming conventions across the package.
32+
33+
### Example
34+
35+
```python
36+
from encryption_helper.common.strings import private_key_suffix, public_key_suffix, encrypted_file_suffix
37+
38+
print(private_key_suffix) # Output: private-key.pem
39+
print(public_key_suffix) # Output: public_key.pem
40+
print(encrypted_file_suffix) # Output: .bin
41+
```
42+
43+
## License
44+
45+
This project is licensed under the MIT License. See the [LICENSE](../LICENSE) file for details.

0 commit comments

Comments
 (0)