Coverage for src / gitversioned / utils / __init__.py: 100%

1""" 

2Utility components and helpers for the gitversioned package. 

3 

4Provides foundational utilities such as Git repository abstractions, environment 

5metadata gathering, and Pydantic type coercions. Designed for consistent, typed, 

6and testable interfaces across the core application logic. 

7 

8Example: 

9 .. code-block:: python 

10 

11 from gitversioned.utils import BuildEnvironment, GitRepository 

12 

13 repo = GitRepository(".") 

14 env = BuildEnvironment() 

15""" 

16 

17from __future__ import annotations 

18 

19from .environment import BuildEnvironment, get_ci_info, get_user 

20from .git import GitReference, GitRepository, NotAGitRepositoryError 

21from .pydantic import ( 

22 EnsureBool, 

23 EnsureList, 

24 EnsurePath, 

25 coerce_bool, 

26 coerce_list, 

27 coerce_path, 

28) 

29 

30__all__ = [ 

31 "BuildEnvironment", 

32 "EnsureBool", 

33 "EnsureList", 

34 "EnsurePath", 

35 "GitReference", 

36 "GitRepository", 

37 "NotAGitRepositoryError", 

38 "coerce_bool", 

39 "coerce_list", 

40 "coerce_path", 

41 "get_ci_info", 

42 "get_user", 

43]