# 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
- **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.
- **write_hocon**: Serialize a Python dictionary into HOCON format and write it to a file.
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/c0/56/4830ea29a23c8c32993f5fe7de80a1730e22f8f0d36605173474cf949966/essentialkit-0.1.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- **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- **write_hocon**: Serialize a Python dictionary into HOCON format and write it to a file.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "A comprehensive utility package to simplify common tasks in Python programming",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/DVictorGavilan/EssentialKit"
},
"split_keywords": [
"i/o",
"files"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "66d139698521267c5d942a7110244d57899e1fa2ecc750f2286e572dee2813ea",
"md5": "8132064e1b6b47404292311ee5a135b0",
"sha256": "dbdb36cb3218d149252069d06a430da12511bacc8a6933cafc9be3688f2a11b5"
},
"downloads": -1,
"filename": "essentialkit-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8132064e1b6b47404292311ee5a135b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9068,
"upload_time": "2024-07-13T18:24:58",
"upload_time_iso_8601": "2024-07-13T18:24:58.710127Z",
"url": "https://files.pythonhosted.org/packages/66/d1/39698521267c5d942a7110244d57899e1fa2ecc750f2286e572dee2813ea/essentialkit-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c0564830ea29a23c8c32993f5fe7de80a1730e22f8f0d36605173474cf949966",
"md5": "e04375607a0f173bb45e8abf12cce5aa",
"sha256": "6bcb41b24780a647220961fc364156708c29dfaba4f191b3c1862df38d913eff"
},
"downloads": -1,
"filename": "essentialkit-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e04375607a0f173bb45e8abf12cce5aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8096,
"upload_time": "2024-07-13T18:25:01",
"upload_time_iso_8601": "2024-07-13T18:25:01.427614Z",
"url": "https://files.pythonhosted.org/packages/c0/56/4830ea29a23c8c32993f5fe7de80a1730e22f8f0d36605173474cf949966/essentialkit-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-13 18:25:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DVictorGavilan",
"github_project": "EssentialKit",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "essentialkit"
}
JSON
