value-object-sindri 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. value_object_sindri-0.1.0/LICENSE +22 -0
  2. value_object_sindri-0.1.0/PKG-INFO +122 -0
  3. value_object_sindri-0.1.0/README.md +69 -0
  4. value_object_sindri-0.1.0/pyproject.toml +148 -0
  5. value_object_sindri-0.1.0/setup.cfg +4 -0
  6. value_object_sindri-0.1.0/src/__init__.py +0 -0
  7. value_object_sindri-0.1.0/src/value_object/__init__.py +31 -0
  8. value_object_sindri-0.1.0/src/value_object/_compat.py +15 -0
  9. value_object_sindri-0.1.0/src/value_object/aggregate.py +315 -0
  10. value_object_sindri-0.1.0/src/value_object/decorators/__init__.py +0 -0
  11. value_object_sindri-0.1.0/src/value_object/decorators/validation.py +28 -0
  12. value_object_sindri-0.1.0/src/value_object/errors/__init__.py +0 -0
  13. value_object_sindri-0.1.0/src/value_object/errors/incorrect_value_type_error.py +12 -0
  14. value_object_sindri-0.1.0/src/value_object/errors/invalid_id_format_error.py +8 -0
  15. value_object_sindri-0.1.0/src/value_object/errors/required_value_error.py +8 -0
  16. value_object_sindri-0.1.0/src/value_object/errors/sindri_validation_error.py +10 -0
  17. value_object_sindri-0.1.0/src/value_object/identifiers/__init__.py +0 -0
  18. value_object_sindri-0.1.0/src/value_object/identifiers/string_uuid.py +55 -0
  19. value_object_sindri-0.1.0/src/value_object/primitives/__init__.py +0 -0
  20. value_object_sindri-0.1.0/src/value_object/primitives/boolean.py +44 -0
  21. value_object_sindri-0.1.0/src/value_object/primitives/float.py +44 -0
  22. value_object_sindri-0.1.0/src/value_object/primitives/integer.py +44 -0
  23. value_object_sindri-0.1.0/src/value_object/primitives/list.py +307 -0
  24. value_object_sindri-0.1.0/src/value_object/primitives/string.py +43 -0
  25. value_object_sindri-0.1.0/src/value_object/py.typed +0 -0
  26. value_object_sindri-0.1.0/src/value_object/value_object.py +314 -0
  27. value_object_sindri-0.1.0/src/value_object_sindri.egg-info/PKG-INFO +122 -0
  28. value_object_sindri-0.1.0/src/value_object_sindri.egg-info/SOURCES.txt +29 -0
  29. value_object_sindri-0.1.0/src/value_object_sindri.egg-info/dependency_links.txt +1 -0
  30. value_object_sindri-0.1.0/src/value_object_sindri.egg-info/requires.txt +6 -0
  31. value_object_sindri-0.1.0/src/value_object_sindri.egg-info/top_level.txt +2 -0
@@ -0,0 +1,22 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 dimanu-py
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
22
+
@@ -0,0 +1,122 @@
1
+ Metadata-Version: 2.4
2
+ Name: value-object-sindri
3
+ Version: 0.1.0
4
+ Summary: Value Object pattern implementation for Python
5
+ Author-email: dimanu-py <dimanu.py@gmail.com>
6
+ License: MIT License
7
+
8
+ Copyright (c) 2026 dimanu-py
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+
28
+
29
+ Project-URL: documentation, https://dimanu-py.github.io/value-object/home/
30
+ Project-URL: repository, https://github.com/dimanu-py/value-object/
31
+ Project-URL: homepage, https://dimanu-py.github.io/value-object/home/
32
+ Project-URL: issues, https://github.com/dimanu-py/value-object/issues/
33
+ Keywords: value object,value-object,value objects,value-objects,Value Object,domain driven design,ddd,clean architecture,hexagonal architecture,design patterns
34
+ Classifier: Typing :: Typed
35
+ Classifier: Programming Language :: Python
36
+ Classifier: Programming Language :: Python :: 3
37
+ Classifier: Programming Language :: Python :: 3.10
38
+ Classifier: Programming Language :: Python :: 3.11
39
+ Classifier: Programming Language :: Python :: 3.12
40
+ Classifier: Programming Language :: Python :: 3.13
41
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
42
+ Classifier: Topic :: Software Development :: Libraries
43
+ Classifier: Intended Audience :: Developers
44
+ Classifier: Operating System :: OS Independent
45
+ Classifier: Topic :: Software Development
46
+ Requires-Python: >=3.10
47
+ Description-Content-Type: text/markdown
48
+ License-File: LICENSE
49
+ Requires-Dist: typing-extensions>=4.0; python_version < "3.12"
50
+ Provides-Extra: build
51
+ Requires-Dist: uv>=0.11.17; extra == "build"
52
+ Dynamic: license-file
53
+
54
+ # Value Objects Sindri
55
+
56
+ ### Value Object pattern for Python and Domain Driven Design applications
57
+
58
+ Easy use and customizable implementation for the Value Object pattern.
59
+
60
+ <p align="center">
61
+ <a href="https://dimanu-py.github.io/value-object/getting_started/">Getting Started</a>&nbsp;&nbsp;•&nbsp;
62
+ <a href="https://dimanu-py.github.io/value-object/value_objects/">Value Object Pattern</a>
63
+ </p>
64
+
65
+ <div align="center"><table><tr><td>
66
+ Sindri value object replaces ad hoc primitives and fragile validators with a consistent Value Object and Aggregate
67
+ toolkit you can adopt quickly.
68
+ Spin up validated value objects and aggregates with a simple and a small, focused API.
69
+
70
+ <br>
71
+
72
+ <b>Why use it?</b> Building your domain with Sindri lets you:
73
+
74
+ <ul style="list-style-type: none">
75
+ <li>⏱️ Cut domain modeling and validation to seconds</li>
76
+ <li>🛡️ Declare immutable, validated value objects with clear error messages</li>
77
+ <li>🧩 Model aggregates with explicit invariants and composition</li>
78
+ <li>🧰 Start from ready made primitives and identifiers or extend with your own</li>
79
+ <li>🔧 Plug in custom validators, decorators, and typed primitives</li>
80
+ </ul>
81
+
82
+ </td></tr></table></div>
83
+
84
+ <div style="background-color: #1e2d3d; border: 1px solid #00d9ff; border-radius: 8px; padding: 16px; margin: 16px 0; display: flex; align-items: flex-start; gap: 12px;">
85
+ <div style="font-size: 20px; color: #00d9ff; flex-shrink: 0;">💧</div>
86
+ <div>
87
+ <strong style="color: #00d9ff;">Created with Instant Python</strong><br>
88
+ <span style="color: #a0a0a0;">This project was generated using <a href="https://github.com/dimanu-py/instant-python" style="color: #00d9ff; text-decoration: none;">Instant Python</a>, a fast, easy and reliable project generator for Python projects.</span>
89
+ </div>
90
+ </div>
91
+
92
+ ## Fast Kickstart
93
+
94
+ ```bash
95
+ pip install value-object-sindri # zero dependencies
96
+ ```
97
+
98
+ Create a value object and use it in your domain:
99
+
100
+ ```python
101
+ from value_object import Integer, String
102
+
103
+ age = Integer(30)
104
+ name = String("John Doe")
105
+
106
+ print(f"Name: {name.value}, Age: {age.value}")
107
+ ```
108
+
109
+ ## Next Steps
110
+
111
+ - [Installation](https://dimanu-py.github.io/value-object/getting_started/installation/)
112
+ - [First Steps](https://dimanu-py.github.io/value-object/getting_started/first_steps/)
113
+ - [Value Object Pattern](https://dimanu-py.github.io/value-object/value_objects/)
114
+ - [Contributing Guide](https://dimanu-py.github.io/value-object/contributing/contributing_guide/)
115
+
116
+ <div style="background-color: #1e2d3d; border: 1px solid #00d9ff; border-radius: 8px; padding: 16px; margin: 16px 0; display: flex; align-items: flex-start; gap: 12px;">
117
+ <div style="font-size: 20px; color: #00d9ff; flex-shrink: 0;">ℹ️</div>
118
+ <div>
119
+ <strong style="color: #00d9ff;">Learn More</strong><br>
120
+ <span style="color: #a0a0a0;">To learn more about advanced usage of value objects, including validation, custom value objects, complex objects like aggregates, visit the <a href="https://dimanu-py.github.io/sindri/value_objects/" style="color: #00d9ff; text-decoration: none;">Value Object Pattern</a> section of the documentation.</span>
121
+ </div>
122
+ </div>
@@ -0,0 +1,69 @@
1
+ # Value Objects Sindri
2
+
3
+ ### Value Object pattern for Python and Domain Driven Design applications
4
+
5
+ Easy use and customizable implementation for the Value Object pattern.
6
+
7
+ <p align="center">
8
+ <a href="https://dimanu-py.github.io/value-object/getting_started/">Getting Started</a>&nbsp;&nbsp;•&nbsp;
9
+ <a href="https://dimanu-py.github.io/value-object/value_objects/">Value Object Pattern</a>
10
+ </p>
11
+
12
+ <div align="center"><table><tr><td>
13
+ Sindri value object replaces ad hoc primitives and fragile validators with a consistent Value Object and Aggregate
14
+ toolkit you can adopt quickly.
15
+ Spin up validated value objects and aggregates with a simple and a small, focused API.
16
+
17
+ <br>
18
+
19
+ <b>Why use it?</b> Building your domain with Sindri lets you:
20
+
21
+ <ul style="list-style-type: none">
22
+ <li>⏱️ Cut domain modeling and validation to seconds</li>
23
+ <li>🛡️ Declare immutable, validated value objects with clear error messages</li>
24
+ <li>🧩 Model aggregates with explicit invariants and composition</li>
25
+ <li>🧰 Start from ready made primitives and identifiers or extend with your own</li>
26
+ <li>🔧 Plug in custom validators, decorators, and typed primitives</li>
27
+ </ul>
28
+
29
+ </td></tr></table></div>
30
+
31
+ <div style="background-color: #1e2d3d; border: 1px solid #00d9ff; border-radius: 8px; padding: 16px; margin: 16px 0; display: flex; align-items: flex-start; gap: 12px;">
32
+ <div style="font-size: 20px; color: #00d9ff; flex-shrink: 0;">💧</div>
33
+ <div>
34
+ <strong style="color: #00d9ff;">Created with Instant Python</strong><br>
35
+ <span style="color: #a0a0a0;">This project was generated using <a href="https://github.com/dimanu-py/instant-python" style="color: #00d9ff; text-decoration: none;">Instant Python</a>, a fast, easy and reliable project generator for Python projects.</span>
36
+ </div>
37
+ </div>
38
+
39
+ ## Fast Kickstart
40
+
41
+ ```bash
42
+ pip install value-object-sindri # zero dependencies
43
+ ```
44
+
45
+ Create a value object and use it in your domain:
46
+
47
+ ```python
48
+ from value_object import Integer, String
49
+
50
+ age = Integer(30)
51
+ name = String("John Doe")
52
+
53
+ print(f"Name: {name.value}, Age: {age.value}")
54
+ ```
55
+
56
+ ## Next Steps
57
+
58
+ - [Installation](https://dimanu-py.github.io/value-object/getting_started/installation/)
59
+ - [First Steps](https://dimanu-py.github.io/value-object/getting_started/first_steps/)
60
+ - [Value Object Pattern](https://dimanu-py.github.io/value-object/value_objects/)
61
+ - [Contributing Guide](https://dimanu-py.github.io/value-object/contributing/contributing_guide/)
62
+
63
+ <div style="background-color: #1e2d3d; border: 1px solid #00d9ff; border-radius: 8px; padding: 16px; margin: 16px 0; display: flex; align-items: flex-start; gap: 12px;">
64
+ <div style="font-size: 20px; color: #00d9ff; flex-shrink: 0;">ℹ️</div>
65
+ <div>
66
+ <strong style="color: #00d9ff;">Learn More</strong><br>
67
+ <span style="color: #a0a0a0;">To learn more about advanced usage of value objects, including validation, custom value objects, complex objects like aggregates, visit the <a href="https://dimanu-py.github.io/sindri/value_objects/" style="color: #00d9ff; text-decoration: none;">Value Object Pattern</a> section of the documentation.</span>
68
+ </div>
69
+ </div>
@@ -0,0 +1,148 @@
1
+ [project]
2
+ name = "value-object-sindri"
3
+ version = "0.1.0"
4
+ description = "Value Object pattern implementation for Python"
5
+ authors = [{name = "dimanu-py", email = "dimanu.py@gmail.com"}]
6
+ dependencies = ["typing-extensions>=4.0; python_version < \"3.12\""]
7
+ requires-python = ">=3.10"
8
+ readme = "README.md"
9
+ license = { file = "LICENSE" }
10
+ keywords = [
11
+ "value object",
12
+ "value-object",
13
+ "value objects",
14
+ "value-objects",
15
+ "Value Object",
16
+ "domain driven design",
17
+ "ddd",
18
+ "clean architecture",
19
+ "hexagonal architecture",
20
+ "design patterns",
21
+ ]
22
+ classifiers = [
23
+ "Typing :: Typed",
24
+ "Programming Language :: Python",
25
+ "Programming Language :: Python :: 3",
26
+ "Programming Language :: Python :: 3.10",
27
+ "Programming Language :: Python :: 3.11",
28
+ "Programming Language :: Python :: 3.12",
29
+ "Programming Language :: Python :: 3.13",
30
+ "Topic :: Software Development :: Libraries :: Python Modules",
31
+ "Topic :: Software Development :: Libraries",
32
+ "Intended Audience :: Developers",
33
+ "Operating System :: OS Independent",
34
+ "Topic :: Software Development",
35
+ ]
36
+
37
+ [project.urls]
38
+ documentation = "https://dimanu-py.github.io/value-object/home/"
39
+ repository = "https://github.com/dimanu-py/value-object/"
40
+ homepage = "https://dimanu-py.github.io/value-object/home/"
41
+ issues = "https://github.com/dimanu-py/value-object/issues/"
42
+
43
+ [project.optional-dependencies]
44
+ build = ["uv>=0.11.17"]
45
+
46
+
47
+ [dependency-groups]
48
+ dev = [
49
+ {include-group = "lint"},
50
+ {include-group = "test"},
51
+ {include-group = "release"},
52
+ {include-group = "doc"},
53
+ ]
54
+ release = [
55
+ "python-semantic-release",
56
+ ]
57
+ lint = [
58
+ "mypy",
59
+ "ruff",
60
+ "pip-audit",
61
+ "pre-commit",
62
+ ]
63
+ test = [
64
+ "expects>=0.9.0",
65
+ "pytest",
66
+ "pytest-sugar>=1.1.1",
67
+ "object-mother-sindri==0.1.0"
68
+ ]
69
+ doc = [
70
+ "mkdocs>=1.6.1",
71
+ "mkdocs-literate-nav>=0.6.2",
72
+ "mkdocs-macros-plugin>=1.3.7",
73
+ "mkdocs-material>=9.6.8",
74
+ "mkdocs-section-index>=0.3.10",
75
+ ]
76
+
77
+ [tool.pytest.ini_options]
78
+ markers = [
79
+ "unit: mark a test as a unit test",
80
+ "acceptance: mark a test as an acceptance test",
81
+ "integration: mark a test as an integration test",
82
+ ]
83
+ testpaths = ["test"]
84
+ pythonpath = ["src"]
85
+
86
+
87
+ [tool.ruff]
88
+ line-length = 120
89
+
90
+ [tool.ruff.lint]
91
+ select = ["E", "F", "W", "B", "C4", "UP", "I"]
92
+ ignore = ["B008"]
93
+
94
+ [tool.ruff.lint.isort]
95
+ known-first-party = ["src", "test"]
96
+
97
+ [tool.ruff.format]
98
+ quote-style = "double"
99
+ indent-style = "space"
100
+ skip-magic-trailing-comma = false
101
+
102
+
103
+ [tool.hatch.build.targets.wheel]
104
+ packages = ["src/value_object"]
105
+
106
+ [tool.hatch.build.targets.sdist]
107
+ include = [
108
+ "src/value_object",
109
+ "LICENSE",
110
+ "README.md",
111
+ "CHANGELOG.md",
112
+ "CITATION.cff",
113
+ ]
114
+
115
+
116
+ [tool.semantic_release]
117
+ version_toml = ["pyproject.toml:project.version"]
118
+ version_variables = ["src/value_object/__init__.py:__version__"]
119
+ commit_message = "bump: new version {version} created"
120
+ commit_parser = "conventional"
121
+ major_on_zero = false
122
+ allow_zero_version = true
123
+ no_git_verify = false
124
+ tag_format = "{version}"
125
+ build_command = """
126
+ pip install -e '.[build]'
127
+ uv lock --upgrade-package "$PACKAGE_NAME"
128
+ git add uv.lock
129
+ uv build
130
+ """
131
+
132
+ [tool.semantic_release.commit_parser_options]
133
+ minor_tags = ["feat"]
134
+ patch_tags = ["fix", "perf", "refactor", "test", "build"]
135
+ allowed_tags = ["feat", "fix", "refactor", "perf", "build"]
136
+ default_bump_level = 0
137
+ parse_squash_commits = false
138
+ ignore_merge_commits = true
139
+
140
+ [tool.semantic_release.changelog]
141
+ exclude_commit_patterns = ['''^Merge pull request #''', '''^Merge branch ''']
142
+ mode = "update"
143
+ #template_dir = "docs/changelog"
144
+
145
+ [tool.semantic_release.changelog.default_templates]
146
+ changelog_file = "CHANGELOG.md"
147
+ output_format = "md"
148
+ mask_initial_release = false
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
File without changes
@@ -0,0 +1,31 @@
1
+ """Public facade for value object implementations.
2
+
3
+ This module re-exports the most common value objects so they can be
4
+ imported directly from :mod:`value_objects`.
5
+ """
6
+
7
+ __version__ = "0.1.0"
8
+
9
+ from value_object.aggregate import Aggregate
10
+ from value_object.decorators.validation import validate
11
+ from value_object.errors.sindri_validation_error import SindriValidationError
12
+ from value_object.identifiers.string_uuid import StringUuid
13
+ from value_object.primitives.boolean import Boolean
14
+ from value_object.primitives.float import Float
15
+ from value_object.primitives.integer import Integer
16
+ from value_object.primitives.list import List
17
+ from value_object.primitives.string import String
18
+ from value_object.value_object import ValueObject
19
+
20
+ __all__ = [
21
+ "Aggregate",
22
+ "validate",
23
+ "StringUuid",
24
+ "Boolean",
25
+ "Float",
26
+ "Integer",
27
+ "List",
28
+ "String",
29
+ "ValueObject",
30
+ "SindriValidationError",
31
+ ]
@@ -0,0 +1,15 @@
1
+ """Compatibility helpers for typing features across Python versions."""
2
+
3
+ from __future__ import annotations
4
+
5
+ try:
6
+ from typing import Self
7
+ except ImportError:
8
+ from typing_extensions import Self
9
+
10
+ try:
11
+ from typing import override
12
+ except ImportError:
13
+ from typing_extensions import override
14
+
15
+ __all__ = ["Self", "override"]