essentialkit 0.6.0

A lightweight utility package to simplify common Python development tasks

EssentialKit

Functional Description

EssentialKit is a lightweight Python utility package designed to simplify common development tasks such as file handling, string manipulation, browser automation, and logging configuration.

The goal of this package is to provide reusable helper functions that speed up the development of Python projects while keeping the codebase clean, simple, and easy to maintain.

Owner

For any bugs or questions, please reach out to Dani Gavilán

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

How to use it

Install the library

pip install essentialkit

import essentialkit

from pathlib import Path


directory: Path = Path("/home/user/Documents/test")
files: list[Path] = essentialkit.files.list_files(path=directory)

text: str = "Hello, name. Welcome to project."
result: str = essentialkit.strings.replace_all(
  input_string=text,
  replace_values={
    "name": "Dani",
    "project": "EssentialKit"
  }
)

Functionalities

File Module

• list_files: 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: Update a specific column in an Excel sheet with values from a list.

String Module

• findall_matches: 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.
• get_substring_between: Extract all substrings between open_mark and close_mark from input string.

Scraping Module

• launch_chrome: Launches a Chrome browser instance with custom settings.

Log Module

• configure: Configure Python logging from a JSON configuration file compatible with logging.config.dictConfig.