Development Status :: 3 - Alpha
Copyright (c) 2023 MinWoo Park

util-function

The Python package utilfunction wraps and distributes useful functions in an easy-to-use way. We have collected functions that are simpler in function than many distributed Python packages or whose category is ambiguous.

For personal purposes, I am curating repetitive functions and planning to categorize and distribute them along with documentation in the future. I recommend not using them until major version 1.

Installation

pip install utilfunction

$ pip install git+https://github.com/dsdanielpark/util-function.git

Features

path_finder.py - function: find_all
Find the path of a file or folder.

from utilfunction import find_all

nii_file_list = find_all('./home', 'file', 'mask.nii.gz')

astyper.py - function: col_converter
Restores a column whose array is stored as a string type back to an array type.

from utilfunction import col_convert

df_has_converted_col = col_convert(df, "embedding_arrays")

beep.py - function: beep
Make beep

from utilfunction import beep

beep()

sec=10
feq=800
beep(sec, feq)

bib2md.py - function: bib2md
Convert bib file to markdown file

from utilfunction import bib2md

bib_path = './sample_data/attention_based.bib'
save_path = './sample_data/attention_based.md'
title_key = 'title'

bib2md(bib_path, title_key, save_path)

pq.py - function: df_to_pq
pd.DataFrame object to parquet object

from utilfunction import df_to_pq

example_df = pd.DataFrame({'A': [1, 2, 3], 'B': [4, 5, 6]})
output_folder = 'output'
output_file_name = 'example.parquet'
df_to_pq(example_df, output_folder, output_file_name)

pq.py - function: gen_hex
Generating random hex

from utilfunction import gen_hex

gen_hex(8)

How to Contribute

Please create a pull request for any function that is useful and simple to reuse. Create a function, and write a tutorial with the same name as the function in the doc folder. Any snippet that you are comfortable with and use often will do. However, some contents may be revised and adjusted later for convenience.

1. Create a Python file containing functions in utilfunction folder. You must include formatting and doc strings in your function.
2. Write brief explanations and examples in the doc folder
3. Write a one-line code example in README.md
4. Make a Pull Request

Please refer to the find_all function in path_finder.py.

• Styled with black black .
• Lnted with pylint pylint --rcfile=setup.cfg util-function/
• Type-checked with mypy mypy util-function/
• Pass the pytest unit tests pytest

Notice

• This repo goes through a simple QA process, there are no major refactoring plans, and it's not a planned project, so it's in alpha.
• If there is a reference, please list it at the top of each Python file.
• Coverage of Python versions is subject to change. However, the code formatting is changed to black during the QA process.