yhyu13 / essentials

General purpose classes and functions, reusable in any kind of Python application.

Essentials

Core classes and functions, reusable in any kind of Python application.

$ pip install essentials

Features:

• exception classes to express common scenarios
• friendly JSON encoder, handling datetime, date, time, UUID, bytes, built-in enums, and instances of classes implementing a dict() method, like pydantic BaseModel
• utilities to work with folders and paths
• StopWatch implementation
• a base class to handle classes that can be instantiated from configuration dictionaries
• common decorator to support retries
• common decorator to support logging function calls
• common decorator to control raised exceptions
• caching functions

Documentation

Please refer to documentation in the project wiki: https://github.com/Neoteroi/essentials/wiki.

Develop and run tests locally

pip install -r requirements.txt

# run tests using automatic discovery:
pytest

# with code coverage:
make testcov