Metadata-Version: 2.1
Name: essentialkit
Version: 0.2.0
Summary: A comprehensive utility package to simplify common tasks in Python programming
Home-page: https://github.com/DVictorGavilan/EssentialKit
Author: DaniGavilan
Author-email: danigavipedro96@gmail.com
License: Apache License 2.0
Keywords: I/O Files
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyhocon>=0.3.60
Requires-Dist: assertpy>=1.1.0
Requires-Dist: pytest>=8.2.2

# 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.
