<p align="center">
<em>jaanca public libraries</em>
</p>
<p align="center">
<a href="https://pypi.org/project/jaanca-utils-os" target="_blank">
<img src="https://img.shields.io/pypi/v/jaanca-utils-os?color=blue&label=PyPI%20Package" alt="Package version">
</a>
<a href="(https://www.python.org" target="_blank">
<img src="https://img.shields.io/badge/Python-%5B%3E%3D3.8%2C%3C%3D3.11%5D-blue" alt="Python">
</a>
</p>
---
# A tool library created by jaanca
* **Python library**: A tool library created by jaanca with operating system help functions such as reading environment variables, reading/writing files, file properties, among others.
* **EnvironmentParserLoader**: A class that loads, parses, and manages system environment variables into various data types.
General Functionality
## The EnvironmentParserLoader class would be designed to:
- Read the system’s environment variables.
- Parse (convert) these variables into specific data types (such as int, float, bool, str, list, dict).
- Manage and provide centralized methods to access these environment variables in a typed and secure manner.
- If the environment variable does not exist or has a value of None and a default value is not assigned, a KeyError exception will be returned.
* **FileFolderManagement**: To write files, use the write_to_disk() method
* **FileProperties**: Functionalities to read properties of an operating system file, such as: modification date, creation, size in bytes, among others.
[Source code](https://github.com/jaanca/python-libraries/tree/main/jaanca-utils-os)
| [Package (PyPI)](https://pypi.org/project/jaanca-utils-os/)
| [Samples](https://github.com/jaanca/python-libraries/tree/main/jaanca-utils-os/samples)
---
# library installation
```console
pip install python-dotenv --upgrade
pip install jaanca_utils_os[dotenv] --upgrade
```
---
# environment_parser_loader: Example of use
### Considerations on environmental variables
- An object must be specified with the variables that you want to create.
- The attributes of these objects will be loaded with the environment variables, according to the name assigned to them.
- If the attribute is mandatory, it will only be of type str and will contain the name of the environment variable to read.
- If the environment variable is optional or may not exist, the attribute must be of type tuple or list, where the first element is the environment variable to read and the second the default value to assign.
- Example:
```Python
class Environment:
ENV_VAR_NO_EXIT = ("VARIABLE","Not Exist")
ENV_VAR_IS_MANDATORY = "VARIABLE"
```
### File with environments vars .env
```console
ENGINE_POSTGRES_CONN_HOST=psqlt
ENGINE_POSTGRES_CONN_DB=test
ENGINE_POSTGRES_CONN_PASSWORD=es3bv3v3
ENGINE_POSTGRES_CONN_PORT=5432
ENGINE_POSTGRES_CONN_USER=postgres
ENGINE_POSTGRES_CONN_SSL=false
FLOAT=3.3
LIST=[1,2,3,"4","5"]
DICT='{"one": "one", "two": 2}'
BOOL_TRUE = true
BOOL_TRUE_ONE = 1
BOOL_TRUE_TWO = "1"
BOOL_FALSE_ONE = 0
BOOL_FALSE_TWO = "0"
BOOL_FALSE_INCORRECT = "incorrect"
```
### Install prettytable for print output
```Python
pip install prettytable==3.10.0
```
### Example
```Python
from jaanca_utils_os import EnvironmentParserLoader, FileFolderManagement
from prettytable import PrettyTable
class Environment:
HOST = "ENGINE_POSTGRES_CONN_HOST"
DB_NAME = "ENGINE_POSTGRES_CONN_DB"
PASSWORD = "ENGINE_POSTGRES_CONN_PASSWORD"
PORT = "ENGINE_POSTGRES_CONN_PORT"
USER = "ENGINE_POSTGRES_CONN_USER"
SSL = "ENGINE_POSTGRES_CONN_SSL"
FLOAT = "FLOAT"
LIST = "LIST"
DICT = "DICT"
BOOL_TRUE = "BOOL_TRUE"
BOOL_TRUE_ONE = "BOOL_TRUE_ONE"
BOOL_TRUE_TWO = "BOOL_TRUE_TWO"
BOOL_FALSE_ONE = "BOOL_FALSE_ONE"
BOOL_FALSE_TWO = "BOOL_FALSE_TWO"
BOOL_FALSE_INCORRECT = "BOOL_FALSE_INCORRECT"
NO_DATA_TUPLE = ("VARIABLE","Not Exist")
NO_DATA_LIST = ["VARIABLE","Not Exist"]
NO_DATA_BOOL = ["VARIABLE","1"]
############
# select the location of the file to read
############
############
# Option 1
# Run the script from where the default environment variables .env file is located
# settings:Environment = EnvironmentParserLoader(Environment)
############
# Other Options
# Load varibles from current folder and subfolders
env_full_path = FileFolderManagement.build_full_path_from_current_folder(__file__,filename=".env",folder_list=["folder2"])
# Load varibles from disk path: c:\tmp
env_full_path = FileFolderManagement.build_full_path_to_file("c:",file_name=".env",folder_list=["tmp"])
# Load varibles from current folder
env_full_path = FileFolderManagement.build_full_path_from_current_folder(__file__,filename=".env")
settings:Environment = EnvironmentParserLoader(Environment,env_full_path=env_full_path)
def print_attributes(cls):
columns = ["Name", "Type", "Value"]
myTable = PrettyTable(columns)
for attribute_name, attribute_value in vars(cls).items():
attribute_type = type(attribute_value)
myTable.add_row([attribute_name, attribute_type.__name__, attribute_value])
print(myTable)
print_attributes(settings)
```
### Output
| Name | Type | Value |
|----------------------|-------|--------------------------|
| HOST | str | psqlt |
| DB_NAME | str | test |
| PASSWORD | str | es3bv3v3 |
| PORT | int | 5432 |
| USER | str | postgres |
| SSL | bool | False |
| FLOAT | float | 3.3 |
| LIST | list | [1, 2, 3, '4', '5'] |
| DICT | dict | {'one': 'one', 'two': 2} |
| BOOL_TRUE | bool | True |
| BOOL_TRUE_ONE | bool | True |
| BOOL_TRUE_TWO | bool | True |
| BOOL_FALSE_ONE | bool | False |
| BOOL_FALSE_TWO | bool | False |
| BOOL_FALSE_INCORRECT | bool | False |
| NO_DATA_TUPLE | str | Not Exist |
| NO_DATA_LIST | str | Not Exist |
| NO_DATA_BOOL | bool | True |
---
# write_to_disk sample
```Python
from jaanca_utils_os import FileFolderManagement
# Write file to current folder
file_name="hello.txt"
current_folder=FileFolderManagement.build_full_path_from_current_folder(__file__)
folders=FileFolderManagement.get_folder_list(current_folder)
file_name_full_path = FileFolderManagement.build_full_path_to_file("c:",file_name,folders)
text = """Hello world !
Hello world !"""
status,error_msg=FileFolderManagement(file_name_full_path).write_to_disk(text)
if(status):
print("file created successfully: "+file_name_full_path)
else:
print("error:" + error_msg)
# Write file in root path
file_name="hello.txt"
file_name_full_path = FileFolderManagement.build_full_path_to_file("c:",file_name)
text = """Hello world !
Hello world !"""
status,error_msg=FileFolderManagement(file_name_full_path).write_to_disk(text)
if(status):
print("file created successfully: "+file_name_full_path)
else:
print("error:" + error_msg)
```
---
# FileProperties sample
```Python
from jaanca_utils_os import FileProperties, FileFolderManagement
import json
file_name="hello asa s sas. as as a. as as .txt"
filename_full_path_from_current_folder=FileFolderManagement.build_full_path_from_current_folder(__file__,folder_list=["file"])
file_properties=FileProperties(filename_full_path_from_current_folder)
status = file_properties.get_attribute_reading_status()
if status is True:
print(json.dumps(file_properties.get_dict(),indent=4))
print(f"name:{file_properties.name}")
print(f"extension:{file_properties.extension}")
print(f"modification_date:{file_properties.modification_date}")
else:
print(status)
```
---
# Semantic Versioning
jaanca-utils-os < MAJOR >.< MINOR >.< PATCH >
* **MAJOR**: version when you make incompatible API changes
* **MINOR**: version when you add functionality in a backwards compatible manner
* **PATCH**: version when you make backwards compatible bug fixes
## Definitions for releasing versions
* https://peps.python.org/pep-0440/
- X.YaN (Alpha release): Identify and fix early-stage bugs. Not suitable for production use.
- X.YbN (Beta release): Stabilize and refine features. Address reported bugs. Prepare for official release.
- X.YrcN (Release candidate): Final version before official release. Assumes all major features are complete and stable. Recommended for testing in non-critical environments.
- X.Y (Final release/Stable/Production): Completed, stable version ready for use in production. Full release for public use.
---
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Types of changes
- Added for new features.
- Changed for changes in existing functionality.
- Deprecated for soon-to-be removed features.
- Removed for now removed features.
- Fixed for any bug fixes.
- Security in case of vulnerabilities.
## [0.0.1rcX] - 2024-05-27
### Added
- First tests using pypi.org in develop environment.
## [0.1.1-6] - 2024-05-27
### Added
- Completion of testing and launch into production.
Raw data
{
"_id": null,
"home_page": "https://github.com/jaanca/python-libraries/tree/main/jaanca-utils-os",
"name": "jaanca-utils-os",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "datetime, utc",
"author": "Jaime Andres Cardona Carrillo",
"author_email": "jacardona@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/97/28/6cebdeb3289ce0a42f835efbfe2a364442b5f7b9d1d13067369e78bf2d84/jaanca_utils_os-0.1.6.tar.gz",
"platform": null,
"description": "<p align=\"center\">\r\n <em>jaanca public libraries</em>\r\n</p>\r\n\r\n<p align=\"center\">\r\n<a href=\"https://pypi.org/project/jaanca-utils-os\" target=\"_blank\">\r\n <img src=\"https://img.shields.io/pypi/v/jaanca-utils-os?color=blue&label=PyPI%20Package\" alt=\"Package version\">\r\n</a>\r\n<a href=\"(https://www.python.org\" target=\"_blank\">\r\n <img src=\"https://img.shields.io/badge/Python-%5B%3E%3D3.8%2C%3C%3D3.11%5D-blue\" alt=\"Python\">\r\n</a>\r\n</p>\r\n\r\n\r\n---\r\n\r\n# A tool library created by jaanca\r\n\r\n* **Python library**: A tool library created by jaanca with operating system help functions such as reading environment variables, reading/writing files, file properties, among others.\r\n* **EnvironmentParserLoader**: A class that loads, parses, and manages system environment variables into various data types.\r\n General Functionality\r\n\r\n ## The EnvironmentParserLoader class would be designed to:\r\n - Read the system\u00e2\u20ac\u2122s environment variables.\r\n - Parse (convert) these variables into specific data types (such as int, float, bool, str, list, dict).\r\n - Manage and provide centralized methods to access these environment variables in a typed and secure manner.\r\n - If the environment variable does not exist or has a value of None and a default value is not assigned, a KeyError exception will be returned.\r\n* **FileFolderManagement**: To write files, use the write_to_disk() method\r\n* **FileProperties**: Functionalities to read properties of an operating system file, such as: modification date, creation, size in bytes, among others.\r\n\r\n[Source code](https://github.com/jaanca/python-libraries/tree/main/jaanca-utils-os)\r\n| [Package (PyPI)](https://pypi.org/project/jaanca-utils-os/)\r\n| [Samples](https://github.com/jaanca/python-libraries/tree/main/jaanca-utils-os/samples)\r\n\r\n---\r\n\r\n# library installation\r\n```console \r\npip install python-dotenv --upgrade\r\npip install jaanca_utils_os[dotenv] --upgrade\r\n```\r\n\r\n---\r\n# environment_parser_loader: Example of use\r\n\r\n### Considerations on environmental variables\r\n- An object must be specified with the variables that you want to create.\r\n- The attributes of these objects will be loaded with the environment variables, according to the name assigned to them.\r\n- If the attribute is mandatory, it will only be of type str and will contain the name of the environment variable to read.\r\n- If the environment variable is optional or may not exist, the attribute must be of type tuple or list, where the first element is the environment variable to read and the second the default value to assign.\r\n\r\n- Example:\r\n```Python\r\nclass Environment:\r\n ENV_VAR_NO_EXIT = (\"VARIABLE\",\"Not Exist\")\r\n ENV_VAR_IS_MANDATORY = \"VARIABLE\" \r\n```\r\n\r\n### File with environments vars .env\r\n```console\r\nENGINE_POSTGRES_CONN_HOST=psqlt\r\nENGINE_POSTGRES_CONN_DB=test\r\nENGINE_POSTGRES_CONN_PASSWORD=es3bv3v3\r\nENGINE_POSTGRES_CONN_PORT=5432\r\nENGINE_POSTGRES_CONN_USER=postgres\r\nENGINE_POSTGRES_CONN_SSL=false\r\nFLOAT=3.3\r\nLIST=[1,2,3,\"4\",\"5\"]\r\nDICT='{\"one\": \"one\", \"two\": 2}'\r\nBOOL_TRUE = true\r\nBOOL_TRUE_ONE = 1\r\nBOOL_TRUE_TWO = \"1\"\r\nBOOL_FALSE_ONE = 0\r\nBOOL_FALSE_TWO = \"0\"\r\nBOOL_FALSE_INCORRECT = \"incorrect\"\r\n```\r\n\r\n### Install prettytable for print output\r\n```Python\r\npip install prettytable==3.10.0\r\n```\r\n\r\n### Example\r\n```Python\r\nfrom jaanca_utils_os import EnvironmentParserLoader, FileFolderManagement\r\nfrom prettytable import PrettyTable\r\n\r\nclass Environment:\r\n HOST = \"ENGINE_POSTGRES_CONN_HOST\"\r\n DB_NAME = \"ENGINE_POSTGRES_CONN_DB\"\r\n PASSWORD = \"ENGINE_POSTGRES_CONN_PASSWORD\"\r\n PORT = \"ENGINE_POSTGRES_CONN_PORT\"\r\n USER = \"ENGINE_POSTGRES_CONN_USER\"\r\n SSL = \"ENGINE_POSTGRES_CONN_SSL\"\r\n FLOAT = \"FLOAT\"\r\n LIST = \"LIST\"\r\n DICT = \"DICT\"\r\n BOOL_TRUE = \"BOOL_TRUE\"\r\n BOOL_TRUE_ONE = \"BOOL_TRUE_ONE\"\r\n BOOL_TRUE_TWO = \"BOOL_TRUE_TWO\"\r\n BOOL_FALSE_ONE = \"BOOL_FALSE_ONE\"\r\n BOOL_FALSE_TWO = \"BOOL_FALSE_TWO\"\r\n BOOL_FALSE_INCORRECT = \"BOOL_FALSE_INCORRECT\"\r\n NO_DATA_TUPLE = (\"VARIABLE\",\"Not Exist\")\r\n NO_DATA_LIST = [\"VARIABLE\",\"Not Exist\"]\r\n NO_DATA_BOOL = [\"VARIABLE\",\"1\"]\r\n\r\n############\r\n# select the location of the file to read\r\n############\r\n\r\n############\r\n# Option 1\r\n# Run the script from where the default environment variables .env file is located\r\n# settings:Environment = EnvironmentParserLoader(Environment)\r\n\r\n############\r\n# Other Options\r\n# Load varibles from current folder and subfolders\r\nenv_full_path = FileFolderManagement.build_full_path_from_current_folder(__file__,filename=\".env\",folder_list=[\"folder2\"])\r\n# Load varibles from disk path: c:\\tmp\r\nenv_full_path = FileFolderManagement.build_full_path_to_file(\"c:\",file_name=\".env\",folder_list=[\"tmp\"])\r\n# Load varibles from current folder\r\nenv_full_path = FileFolderManagement.build_full_path_from_current_folder(__file__,filename=\".env\")\r\n\r\nsettings:Environment = EnvironmentParserLoader(Environment,env_full_path=env_full_path)\r\n\r\ndef print_attributes(cls):\r\n columns = [\"Name\", \"Type\", \"Value\"]\r\n myTable = PrettyTable(columns)\r\n for attribute_name, attribute_value in vars(cls).items():\r\n attribute_type = type(attribute_value)\r\n myTable.add_row([attribute_name, attribute_type.__name__, attribute_value])\r\n print(myTable) \r\n\r\nprint_attributes(settings)\r\n\r\n```\r\n\r\n### Output\r\n| Name | Type | Value |\r\n|----------------------|-------|--------------------------|\r\n| HOST | str | psqlt |\r\n| DB_NAME | str | test |\r\n| PASSWORD | str | es3bv3v3 |\r\n| PORT | int | 5432 |\r\n| USER | str | postgres |\r\n| SSL | bool | False |\r\n| FLOAT | float | 3.3 |\r\n| LIST | list | [1, 2, 3, '4', '5'] |\r\n| DICT | dict | {'one': 'one', 'two': 2} |\r\n| BOOL_TRUE | bool | True |\r\n| BOOL_TRUE_ONE | bool | True |\r\n| BOOL_TRUE_TWO | bool | True |\r\n| BOOL_FALSE_ONE | bool | False |\r\n| BOOL_FALSE_TWO | bool | False |\r\n| BOOL_FALSE_INCORRECT | bool | False |\r\n| NO_DATA_TUPLE | str | Not Exist |\r\n| NO_DATA_LIST | str | Not Exist |\r\n| NO_DATA_BOOL | bool | True |\r\n\r\n\r\n---\r\n\r\n# write_to_disk sample\r\n\r\n```Python\r\nfrom jaanca_utils_os import FileFolderManagement\r\n\r\n# Write file to current folder\r\nfile_name=\"hello.txt\"\r\ncurrent_folder=FileFolderManagement.build_full_path_from_current_folder(__file__)\r\nfolders=FileFolderManagement.get_folder_list(current_folder)\r\nfile_name_full_path = FileFolderManagement.build_full_path_to_file(\"c:\",file_name,folders)\r\ntext = \"\"\"Hello world !\r\nHello world !\"\"\"\r\nstatus,error_msg=FileFolderManagement(file_name_full_path).write_to_disk(text)\r\nif(status):\r\n print(\"file created successfully: \"+file_name_full_path)\r\nelse:\r\n print(\"error:\" + error_msg)\r\n\r\n# Write file in root path\r\nfile_name=\"hello.txt\"\r\nfile_name_full_path = FileFolderManagement.build_full_path_to_file(\"c:\",file_name)\r\ntext = \"\"\"Hello world !\r\nHello world !\"\"\"\r\nstatus,error_msg=FileFolderManagement(file_name_full_path).write_to_disk(text)\r\nif(status):\r\n print(\"file created successfully: \"+file_name_full_path)\r\nelse:\r\n print(\"error:\" + error_msg)\r\n```\r\n\r\n---\r\n\r\n# FileProperties sample\r\n\r\n```Python\r\nfrom jaanca_utils_os import FileProperties, FileFolderManagement\r\nimport json\r\n\r\nfile_name=\"hello asa s sas. as as a. as as .txt\"\r\nfilename_full_path_from_current_folder=FileFolderManagement.build_full_path_from_current_folder(__file__,folder_list=[\"file\"])\r\nfile_properties=FileProperties(filename_full_path_from_current_folder)\r\nstatus = file_properties.get_attribute_reading_status()\r\nif status is True:\r\n print(json.dumps(file_properties.get_dict(),indent=4))\r\n print(f\"name:{file_properties.name}\")\r\n print(f\"extension:{file_properties.extension}\")\r\n print(f\"modification_date:{file_properties.modification_date}\")\r\nelse:\r\n print(status)\r\n```\r\n\r\n---\r\n\r\n# Semantic Versioning\r\n\r\njaanca-utils-os < MAJOR >.< MINOR >.< PATCH >\r\n\r\n* **MAJOR**: version when you make incompatible API changes\r\n* **MINOR**: version when you add functionality in a backwards compatible manner\r\n* **PATCH**: version when you make backwards compatible bug fixes\r\n\r\n## Definitions for releasing versions\r\n* https://peps.python.org/pep-0440/\r\n\r\n - X.YaN (Alpha release): Identify and fix early-stage bugs. Not suitable for production use.\r\n - X.YbN (Beta release): Stabilize and refine features. Address reported bugs. Prepare for official release.\r\n - X.YrcN (Release candidate): Final version before official release. Assumes all major features are complete and stable. Recommended for testing in non-critical environments.\r\n - X.Y (Final release/Stable/Production): Completed, stable version ready for use in production. Full release for public use.\r\n---\r\n\r\n# Changelog\r\n\r\nAll notable changes to this project will be documented in this file.\r\n\r\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\r\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\r\n\r\n## Types of changes\r\n\r\n- Added for new features.\r\n- Changed for changes in existing functionality.\r\n- Deprecated for soon-to-be removed features.\r\n- Removed for now removed features.\r\n- Fixed for any bug fixes.\r\n- Security in case of vulnerabilities.\r\n\r\n## [0.0.1rcX] - 2024-05-27\r\n### Added\r\n- First tests using pypi.org in develop environment.\r\n\r\n## [0.1.1-6] - 2024-05-27\r\n### Added\r\n- Completion of testing and launch into production.\r\n\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A tool library created by jaanca with operating system help functions such as reading environment variables, reading/writing files, file properties, among others.",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/jaanca/python-libraries/tree/main/jaanca-utils-os"
},
"split_keywords": [
"datetime",
" utc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0cc5095433d52d7a1b6bd564789cb7855bdeb22e15d2a263e0206e8e2e78853d",
"md5": "658073ff67a477c20c9be6060fa7ebc1",
"sha256": "4a735add4785858a24253a44dcc74cc0be4ab813e969160302714e13564770a7"
},
"downloads": -1,
"filename": "jaanca_utils_os-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "658073ff67a477c20c9be6060fa7ebc1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12666,
"upload_time": "2024-05-28T00:15:14",
"upload_time_iso_8601": "2024-05-28T00:15:14.576787Z",
"url": "https://files.pythonhosted.org/packages/0c/c5/095433d52d7a1b6bd564789cb7855bdeb22e15d2a263e0206e8e2e78853d/jaanca_utils_os-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97286cebdeb3289ce0a42f835efbfe2a364442b5f7b9d1d13067369e78bf2d84",
"md5": "d6a3f51ad7026db97d30d5350c01bf48",
"sha256": "72537e26fab21133adffc11532bf5292381c6923593b08b707d6bbee35aaf15f"
},
"downloads": -1,
"filename": "jaanca_utils_os-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "d6a3f51ad7026db97d30d5350c01bf48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11889,
"upload_time": "2024-05-28T00:15:16",
"upload_time_iso_8601": "2024-05-28T00:15:16.313635Z",
"url": "https://files.pythonhosted.org/packages/97/28/6cebdeb3289ce0a42f835efbfe2a364442b5f7b9d1d13067369e78bf2d84/jaanca_utils_os-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-28 00:15:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jaanca",
"github_project": "python-libraries",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jaanca-utils-os"
}
JSON
