# EssentialKit
## Functional Description
A comprehensive utility package to simplify common tasks in Python programming
## Owner
For any bugs or questions, please reach out to [Dani Gavilán](mailto:danigavipedro96@gmail.com)
## Branching Methodology
This project follows a Git Flow simplified branching methodology
- **Master Branch**: production code
- **Develop Branch**: main integration branch for ongoing development. Features and fixes are merged into this branch before reaching master
- **Feature Branch**: created from develop branch to work on new features
## Prerequisites
This project uses:
- Language: Python 3.10
- Libraries:
- pyhocon
- pytest
- assertpy
## How to use it
Install the library
```bash
pip install essentialkit
```
## Functionalities
### File Operations Module
- **get_all_file_paths_in_directory**: Retrieve a list of all file paths within a specified folder and its subdirectories.
- **read_json**: Read and parse a JSON file into a Python dictionary.
- **write_json**: Serialize a Python dictionary into JSON format and write it to a file.
- **read_hocon**: Read and parse a HOCON file into a Python dictionary.
- **iterate_hocon**: Read nested dictionaries and lists into dot and index generator
- **write_hocon**: Serialize a Python dictionary into HOCON format and write it to a file.
- **update_excel_column_from_list**: Update a specific column in an Excel sheet with values from a list
### String Operations Module
- **find_pattern_in_string**: Find all occurrences of a pattern in a given string using regex.
- **replace_all**: Replace all occurrences of keys in input dict within input string with their corresponding values.
Raw data
{
"_id": null,
"home_page": "https://github.com/DVictorGavilan/EssentialKit",
"name": "essentialkit",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "I/O Files",
"author": "DaniGavilan",
"author_email": "danigavipedro96@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0d/6b/22053108c120e4fad6aff2696076822fd33a2398c2d5eaf75d7e9d340de3/essentialkit-0.4.0.tar.gz",
"platform": null,
"description": "# EssentialKit\n\n## Functional Description\nA comprehensive utility package to simplify common tasks in Python programming\n\n## Owner\nFor any bugs or questions, please reach out to [Dani Gavil\u00e1n](mailto:danigavipedro96@gmail.com)\n\n## Branching Methodology\nThis project follows a Git Flow simplified branching methodology\n- **Master Branch**: production code\n- **Develop Branch**: main integration branch for ongoing development. Features and fixes are merged into this branch before reaching master\n- **Feature Branch**: created from develop branch to work on new features\n\n## Prerequisites\nThis project uses:\n- Language: Python 3.10\n- Libraries: \n - pyhocon\n - pytest\n - assertpy\n\n## How to use it\nInstall the library\n\n```bash\npip install essentialkit\n```\n\n\n## Functionalities\n### File Operations Module\n- **get_all_file_paths_in_directory**: Retrieve a list of all file paths within a specified folder and its subdirectories.\n- **read_json**: Read and parse a JSON file into a Python dictionary.\n- **write_json**: Serialize a Python dictionary into JSON format and write it to a file.\n- **read_hocon**: Read and parse a HOCON file into a Python dictionary.\n- **iterate_hocon**: Read nested dictionaries and lists into dot and index generator\n- **write_hocon**: Serialize a Python dictionary into HOCON format and write it to a file.\n- **update_excel_column_from_list**: Update a specific column in an Excel sheet with values from a list\n### String Operations Module\n- **find_pattern_in_string**: Find all occurrences of a pattern in a given string using regex.\n- **replace_all**: Replace all occurrences of keys in input dict within input string with their corresponding values.\n \n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "A comprehensive utility package to simplify common tasks in Python programming",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/DVictorGavilan/EssentialKit"
},
"split_keywords": [
"i/o",
"files"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "50b2c0845580f8baee21ffcf1b41fd4713a2184ec58ebd05e22d697ee0abab90",
"md5": "50072a73d641d4d4622c2b1894eb91db",
"sha256": "fe411d934a9b3f39db2f1e8a04a7133b43cade1c9106f4dfdbfd6fbcc1c80bdb"
},
"downloads": -1,
"filename": "essentialkit-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "50072a73d641d4d4622c2b1894eb91db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12542,
"upload_time": "2025-07-30T17:59:06",
"upload_time_iso_8601": "2025-07-30T17:59:06.403383Z",
"url": "https://files.pythonhosted.org/packages/50/b2/c0845580f8baee21ffcf1b41fd4713a2184ec58ebd05e22d697ee0abab90/essentialkit-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0d6b22053108c120e4fad6aff2696076822fd33a2398c2d5eaf75d7e9d340de3",
"md5": "cb8e9a1260989ad24480a18a479d37f1",
"sha256": "148f21997f1febb459718a975e85d151b546c1f8b74e11c002883f15684eaddb"
},
"downloads": -1,
"filename": "essentialkit-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "cb8e9a1260989ad24480a18a479d37f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11249,
"upload_time": "2025-07-30T17:59:09",
"upload_time_iso_8601": "2025-07-30T17:59:09.212847Z",
"url": "https://files.pythonhosted.org/packages/0d/6b/22053108c120e4fad6aff2696076822fd33a2398c2d5eaf75d7e9d340de3/essentialkit-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 17:59:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DVictorGavilan",
"github_project": "EssentialKit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pytest",
"specs": [
[
"~=",
"8.3.5"
]
]
},
{
"name": "assertpy",
"specs": [
[
"~=",
"1.1"
]
]
},
{
"name": "pyparsing",
"specs": [
[
"~=",
"3.2.3"
]
]
},
{
"name": "pyhocon",
"specs": [
[
"~=",
"0.3.61"
]
]
},
{
"name": "setuptools",
"specs": [
[
"~=",
"68.2.0"
]
]
},
{
"name": "openpyxl",
"specs": [
[
"~=",
"3.1.5"
]
]
}
],
"lcname": "essentialkit"
}
JSON
